Package org.forgerock.secrets.propertyresolver

Class OrderedStableIdResolver

java.lang.Object

org.forgerock.secrets.propertyresolver.OrderedStableIdResolver

All Implemented Interfaces:

StableIdResolver

public class OrderedStableIdResolver
extends Object
implements StableIdResolver

A StableIdResolver that uses a version suffix and a subsequent number to determine the stableId of a Secret. For example, using a version suffix of '.v' with a purpose of 'purpose' the stableIds in order would be: purpose, purpose.v1, purpose.v2, purpose.v3 etc. with the id with the largest number being the active secret. Cases where there are leading zeroes like purpose.v01 would have .v01 be later than .v1 and before .v2. For example the order with leading zeroes would be: purpose, purpose.v1, purpose.v01, purpose.v001 purpose.v2.

Constructor Summary

Constructors

Constructor	Description
OrderedStableIdResolver(String versionSuffix)	Constructor for OrderedVersionStableIdResolver.

Method Summary

Modifier and Type	Method	Description
Stream<SecretResource>	candidatesForPurpose(Stream<SecretResource> candidates, String purpose)	Creates candidate stream in order from latest to oldest, latest being the active secret for the purpose label.
String	getPurposeLabelFromStableId(String stableId)	Pulls the purpose label from the stableId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrderedStableIdResolver

public OrderedStableIdResolver(String versionSuffix)

Constructor for OrderedVersionStableIdResolver.

Parameters:

versionSuffix - the version suffix prepended to each version

Method Detail

getPurposeLabelFromStableId

public String getPurposeLabelFromStableId(String stableId)

Description copied from interface: StableIdResolver

Pulls the purpose label from the stableId.

Specified by:

getPurposeLabelFromStableId in interface StableIdResolver

Parameters:

stableId - The stableId of a secret

Returns:

The purpose label of the given stableId

candidatesForPurpose

public Stream<SecretResource> candidatesForPurpose(Stream<SecretResource> candidates,
                                                   String purpose)

Description copied from interface: StableIdResolver

Creates candidate stream in order from latest to oldest, latest being the active secret for the purpose label.

Specified by:

candidatesForPurpose in interface StableIdResolver

Parameters:

candidates - stream of candidate secret resources for the secret

purpose - purpose label for the secret to match candidates to

Returns:

stream of SecretResource