Package org.forgerock.am.trees.model

Class TreeStateBuilderImpl

java.lang.Object

org.forgerock.am.trees.model.TreeStateBuilderImpl

All Implemented Interfaces:

TreeStateBuilder

public final class TreeStateBuilderImpl
extends Object
implements TreeStateBuilder

A builder for TreeState objects.

Method Summary

Modifier and Type	Method	Description
TreeState	build()	Builds the TreeState object with the provided properties.
TreeStateBuilder	withCurrentNodeId(UUID currentNodeId)	Sets the current node ID.
TreeStateBuilder	withIdentifiedIdentity(IdentifiedIdentity identifiedIdentity)	Sets the identified identity.
TreeStateBuilder	withIdentifiedIdentityFrom(TreeState previousState, Action action)	Sets the identified identity from the provided action if present, or the previous tree state otherwise.
TreeStateBuilder	withLogoutHooks(List<org.forgerock.openam.auth.logouthook.LogoutHookData> logoutHooks)	Sets the logout hooks.
TreeStateBuilder	withLogoutHooksFrom(TreeState previousState, Action action)	Sets the logout hooks from the previous state, followed by those from the provided action.
TreeStateBuilder	withMaxTreeDuration(Duration maxTreeDuration)	Sets the maximum duration of the tree.
TreeStateBuilder	withMaxTreeDurationFrom(TreeState previousState, Action action)	Sets the maximum duration of the tree from the provided action if present, or the previous tree state otherwise.
TreeStateBuilder	withSecureState(JsonValue secureState)	Sets the secure state.
TreeStateBuilder	withSessionHooks(List<JsonValue> sessionHooks)	Sets the session hooks.
TreeStateBuilder	withSessionHooksFrom(TreeState previousState, Action action)	Sets the session hooks from the previous state, followed by those from the provided action.
TreeStateBuilder	withSessionProperties(SessionProperties sessionProperties)	Sets the session properties.
TreeStateBuilder	withSessionPropertiesFrom(TreeState previousState, Action action)	Sets the combined session properties from the provided action and previous state.
TreeStateBuilder	withSharedState(JsonValue sharedState)	Sets the shared state.
TreeStateBuilder	withSharedStateFrom(TreeState previousState, Action action)	Sets the shared state from the provided action if present, or the previous tree state otherwise.
TreeStateBuilder	withTransientState(JsonValue transientState)	Sets the transient state.
TreeStateBuilder	withTransientStateFrom(TreeState previousState, Action action)	Sets the transient state from the provided action if present, or the previous tree state otherwise.
TreeStateBuilder	withUnencryptedSecureState(JsonValue unencryptedSecureState)	Sets the unencrypted secure state.
TreeStateBuilder	withUniversalId(String universalId)	Sets the universal ID.
TreeStateBuilder	withUniversalIdFrom(TreeState previousState, Action action)	Sets the universal ID from the provided action if present, or the previous tree state otherwise.
TreeStateBuilder	withWebhooks(List<String> webhooks)	Sets the webhooks.
TreeStateBuilder	withWebhooksFrom(TreeState previousState, Action action)	Sets the webhooks from the previous state, followed by those from the provided action.

Methods inherited from class java.lang.Object

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

Method Details

withSharedState

public TreeStateBuilder withSharedState(JsonValue sharedState)

Description copied from interface: TreeStateBuilder

Sets the shared state.

Specified by:

withSharedState in interface TreeStateBuilder

Parameters:

sharedState - the shared state

Returns:

this builder

withSharedStateFrom

public TreeStateBuilder withSharedStateFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the shared state from the provided action if present, or the previous tree state otherwise. Also sets the error message and lockout message if present.

Specified by:

withSharedStateFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

withTransientState

public TreeStateBuilder withTransientState(JsonValue transientState)

Description copied from interface: TreeStateBuilder

Sets the transient state.

Specified by:

withTransientState in interface TreeStateBuilder

Parameters:

transientState - the transient state

Returns:

this builder

withTransientStateFrom

public TreeStateBuilder withTransientStateFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the transient state from the provided action if present, or the previous tree state otherwise.

Specified by:

withTransientStateFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

withSecureState

public TreeStateBuilder withSecureState(JsonValue secureState)

Description copied from interface: TreeStateBuilder

Sets the secure state.

Specified by:

withSecureState in interface TreeStateBuilder

Parameters:

secureState - the secure state

Returns:

this builder

withUnencryptedSecureState

public TreeStateBuilder withUnencryptedSecureState(JsonValue unencryptedSecureState)

Description copied from interface: TreeStateBuilder

Sets the unencrypted secure state.

Specified by:

withUnencryptedSecureState in interface TreeStateBuilder

Parameters:

unencryptedSecureState - the unencrypted secure state

Returns:

this builder

withCurrentNodeId

public TreeStateBuilder withCurrentNodeId(UUID currentNodeId)

Description copied from interface: TreeStateBuilder

Sets the current node ID.

Specified by:

withCurrentNodeId in interface TreeStateBuilder

Parameters:

currentNodeId - the current node ID

Returns:

this builder

withSessionProperties

public TreeStateBuilder withSessionProperties(SessionProperties sessionProperties)

Description copied from interface: TreeStateBuilder

Sets the session properties.

Specified by:

withSessionProperties in interface TreeStateBuilder

Parameters:

sessionProperties - the session properties

Returns:

this builder

withSessionPropertiesFrom

public TreeStateBuilder withSessionPropertiesFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the combined session properties from the provided action and previous state. Sets the max session time and max idle time from the action if present, or the previous tree state otherwise.

Specified by:

withSessionPropertiesFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

withSessionHooks

public TreeStateBuilder withSessionHooks(List<JsonValue> sessionHooks)

Description copied from interface: TreeStateBuilder

Sets the session hooks.

Specified by:

withSessionHooks in interface TreeStateBuilder

Parameters:

sessionHooks - the session hooks

Returns:

this builder

withSessionHooksFrom

public TreeStateBuilder withSessionHooksFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the session hooks from the previous state, followed by those from the provided action.

Specified by:

withSessionHooksFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

withWebhooks

public TreeStateBuilder withWebhooks(List<String> webhooks)

Description copied from interface: TreeStateBuilder

Sets the webhooks.

Specified by:

withWebhooks in interface TreeStateBuilder

Parameters:

webhooks - the webhooks

Returns:

this builder

withWebhooksFrom

public TreeStateBuilder withWebhooksFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the webhooks from the previous state, followed by those from the provided action.

Specified by:

withWebhooksFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

withLogoutHooks

public TreeStateBuilder withLogoutHooks(List<org.forgerock.openam.auth.logouthook.LogoutHookData> logoutHooks)

Description copied from interface: TreeStateBuilder

Sets the logout hooks.

Specified by:

withLogoutHooks in interface TreeStateBuilder

Parameters:

logoutHooks - the logout hooks

Returns:

this builder

withLogoutHooksFrom

public TreeStateBuilder withLogoutHooksFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the logout hooks from the previous state, followed by those from the provided action.

Specified by:

withLogoutHooksFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

withUniversalId

public TreeStateBuilder withUniversalId(String universalId)

Description copied from interface: TreeStateBuilder

Sets the universal ID.

Specified by:

withUniversalId in interface TreeStateBuilder

Parameters:

universalId - the universal ID

Returns:

this builder

withUniversalIdFrom

public TreeStateBuilder withUniversalIdFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the universal ID from the provided action if present, or the previous tree state otherwise.

Specified by:

withUniversalIdFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

withIdentifiedIdentity

public TreeStateBuilder withIdentifiedIdentity(IdentifiedIdentity identifiedIdentity)

Description copied from interface: TreeStateBuilder

Sets the identified identity.

Specified by:

withIdentifiedIdentity in interface TreeStateBuilder

Parameters:

identifiedIdentity - the identified identity

Returns:

this builder

withIdentifiedIdentityFrom

public TreeStateBuilder withIdentifiedIdentityFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the identified identity from the provided action if present, or the previous tree state otherwise. Logs a warning if both are present and different.

Specified by:

withIdentifiedIdentityFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

withMaxTreeDuration

public TreeStateBuilder withMaxTreeDuration(Duration maxTreeDuration)

Description copied from interface: TreeStateBuilder

Sets the maximum duration of the tree.

Specified by:

withMaxTreeDuration in interface TreeStateBuilder

Parameters:

maxTreeDuration - the maximum duration of the tree

Returns:

this builder

withMaxTreeDurationFrom

public TreeStateBuilder withMaxTreeDurationFrom(TreeState previousState,
 Action action)

Description copied from interface: TreeStateBuilder

Sets the maximum duration of the tree from the provided action if present, or the previous tree state otherwise.

Specified by:

withMaxTreeDurationFrom in interface TreeStateBuilder

Parameters:

previousState - the previous tree state

action - the last action

Returns:

this builder

build

public TreeState build()

Description copied from interface: TreeStateBuilder

Builds the TreeState object with the provided properties.

Specified by:

build in interface TreeStateBuilder

Returns:

the TreeState object