Index

A B C D E F G H I J L M N O P Q R S U V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

actionCollection(Context, ActionRequest) - Method in class org.forgerock.selfservice.core.UserUpdateService
 
actionInstance(Context, String, ActionRequest) - Method in class org.forgerock.selfservice.core.UserUpdateService
 
add(String, JsonValue) - Method in interface org.forgerock.selfservice.core.ProcessStore
Adds the state into the store against the key.
addCustomField(String, JsonValue) - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Add a custom Json snippet.
addDefinition(String, RequirementsBuilder) - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Add a definition to the main object.
addProperty(String, String) - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Add a property; default type is string.
addProperty(String, String, String) - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Add a property.
addProperty(String, RequirementsBuilder) - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Add a property of type object.
addRequireProperty(String, String) - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Add a required property; default type is string.
addRequireProperty(String, String, String) - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Add a required property.
addRequireProperty(String, RequirementsBuilder) - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Add a required property of type object.
advance(ProcessContext, C) - Method in interface org.forgerock.selfservice.core.ProgressStage
Advance the progress stage.
AnonymousProcessService - Class in org.forgerock.selfservice.core
Anonymous process service progresses a chain of ProgressStage configurations, handling any required client interactions.
AnonymousProcessService(ProcessInstanceConfig, ProgressStageProvider, SnapshotTokenHandlerFactory, ProcessStore, ClassLoader) - Constructor for class org.forgerock.selfservice.core.AnonymousProcessService
Initialises the anonymous process service with the passed config.
Answers - Class in org.forgerock.selfservice.core.util
Utility methods for hashing and normalising answers to KBA questions.

B

bind(ProgressStage<C>, C) - Static method in class org.forgerock.selfservice.core.ProgressStageBinding
Create a new binder instance.
build() - Method in class org.forgerock.selfservice.core.StageResponse.Builder
Builds a stage response instance.
build() - Method in interface org.forgerock.selfservice.core.StageResponse.RequirementsBuilder
Builds a stage response instance.
build() - Method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Builds a new json object representing the defined requirements.

C

containsState(String) - Method in interface org.forgerock.selfservice.core.ProcessContext
Determines whether state defined by the json pointer exists.
createInstance(Context, CreateRequest) - Method in class org.forgerock.selfservice.core.UserUpdateService
 
CryptoService - Class in org.forgerock.selfservice.core.crypto
Cryptography Service for the user self service project.
CryptoService() - Constructor for class org.forgerock.selfservice.core.crypto.CryptoService
 

D

deleteInstance(Context, String, DeleteRequest) - Method in class org.forgerock.selfservice.core.UserUpdateService
 

E

emptyJson() - Static method in class org.forgerock.selfservice.core.ServiceUtils
Relieves an empty json object.
equals(Object) - Method in class org.forgerock.selfservice.core.config.ProcessInstanceConfig
 

F

fieldMatches(String, String) - Method in interface org.forgerock.selfservice.core.crypto.FieldStorageScheme
Returns true if the supplied plain text field matches the supplied stored field after being encoded and compared, false otherwise.
FieldStorageScheme - Interface in org.forgerock.selfservice.core.crypto
This interface defines a field storage scheme.

G

gatherInitialRequirements(ProcessContext, C) - Method in interface org.forgerock.selfservice.core.ProgressStage
Response for defining any initial requirements the stage may have.
get(Class<? extends ProgressStage<StageConfig>>) - Method in interface org.forgerock.selfservice.core.ProgressStageProvider
Given the progress stage class retrieves a corresponding instance of the class.
get(SnapshotTokenConfig) - Method in interface org.forgerock.selfservice.core.snapshot.SnapshotTokenHandlerFactory
Given the token type, provide a token handler instance.
getCallback() - Method in class org.forgerock.selfservice.core.StageResponse
Returns the callback instance.
getInput() - Method in interface org.forgerock.selfservice.core.ProcessContext
Gets the input provided by the client.
getName() - Method in interface org.forgerock.selfservice.core.config.StageConfig
Gets the name of the stage configuration.
getProgressStageClassName() - Method in interface org.forgerock.selfservice.core.config.StageConfig
Gets the class name of the consuming progress stage.
getRequest() - Method in interface org.forgerock.selfservice.core.ProcessContext
Gets the original request.
getRequestContext() - Method in interface org.forgerock.selfservice.core.ProcessContext
Gets the request context.
getRequirements() - Method in class org.forgerock.selfservice.core.StageResponse
Returns the requirements.
getSnapshotTokenConfig() - Method in class org.forgerock.selfservice.core.config.ProcessInstanceConfig
Gets the snapshot token type to use.
getStageConfigs() - Method in class org.forgerock.selfservice.core.config.ProcessInstanceConfig
Gets the list of stage configs.
getStageTag() - Method in interface org.forgerock.selfservice.core.ProcessContext
Gets the current stage tag defined by the previously invoked stage.
getStageTag() - Method in class org.forgerock.selfservice.core.StageResponse
Returns the stage tag.
getState(String) - Method in interface org.forgerock.selfservice.core.ProcessContext
Allows retrieval of state persisted throughout the flow.
getStorageType() - Method in class org.forgerock.selfservice.core.config.ProcessInstanceConfig
Gets the storage type to use.
getType() - Method in interface org.forgerock.selfservice.core.snapshot.SnapshotTokenConfig
Gets the type of the snapshot token represented by this configuration.

H

handleAction(Context, ActionRequest) - Method in class org.forgerock.selfservice.core.AnonymousProcessService
 
handleRead(Context, ReadRequest) - Method in class org.forgerock.selfservice.core.AnonymousProcessService
 
hasCallback() - Method in class org.forgerock.selfservice.core.StageResponse
Returns true if the response contains a snapshot token callback instance.
hash(String, String) - Method in class org.forgerock.selfservice.core.crypto.CryptoService
Hashes a string value.
hashAnswer(CryptoService, JsonValue) - Static method in class org.forgerock.selfservice.core.util.Answers
Hashes the given answer.
hashCode() - Method in class org.forgerock.selfservice.core.config.ProcessInstanceConfig
 
hashField(String) - Method in interface org.forgerock.selfservice.core.crypto.FieldStorageScheme
Returns a hashed, salted, and encoded version of the supplied plain text field.
hasRequirements() - Method in class org.forgerock.selfservice.core.StageResponse
Returns true if the response has any requirements.

I

IllegalStageTagException - Exception in org.forgerock.selfservice.core
Exception that represents an unknown stage tag.
IllegalStageTagException(String) - Constructor for exception org.forgerock.selfservice.core.IllegalStageTagException
Creates a new exception instance.
INITIAL_TAG - Static variable in class org.forgerock.selfservice.core.ServiceUtils
Represents an empty stage tag.
isHashed(JsonValue) - Method in class org.forgerock.selfservice.core.crypto.CryptoService
Detects if a String is hashed.

J

JsonCryptoException - Exception in org.forgerock.selfservice.core.crypto
An exception that is thrown during JSON cryptographic operations.
JsonCryptoException(String) - Constructor for exception org.forgerock.selfservice.core.crypto.JsonCryptoException
Constructs a new exception with the specified detail message.
JsonCryptoException(String, Exception) - Constructor for exception org.forgerock.selfservice.core.crypto.JsonCryptoException
Constructs a new exception with the specified detail message and cause.

L

LOCAL - Enum constant in enum org.forgerock.selfservice.core.StorageType
State should be preserved locally.

M

matches(String, JsonValue) - Method in class org.forgerock.selfservice.core.crypto.CryptoService
Returns true if the supplied plain text value of a field matches the supplied hashed value.

N

newArray(int, RequirementsBuilder) - Static method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Creates a new builder instance for array type creation.
newArray(RequirementsBuilder) - Static method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Creates a new builder instance for array type creation.
newBuilder() - Static method in class org.forgerock.selfservice.core.StageResponse
New builder to help construct a stage response.
newEmptyObject() - Static method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Creates a new builder instance for empty object creation.
newEmptyRequirements() - Static method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Creates an empty requirements json object.
newInstance(String) - Static method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Creates a new builder instance for the json schema.
newObject(String) - Static method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Creates a new builder instance for object type creation.
normaliseAnswer(String) - Static method in class org.forgerock.selfservice.core.util.Answers
Normalises the given answer.

O

oneOf(JsonValue...) - Static method in class org.forgerock.selfservice.core.util.RequirementsBuilder
Creates a new builder instance for oneOf keyword.
org.forgerock.selfservice.core - package org.forgerock.selfservice.core
This package contains the core implementation for the anonymous process service.
org.forgerock.selfservice.core.annotations - package org.forgerock.selfservice.core.annotations
This package contains annotations that allow product detection of Self-Service components.
org.forgerock.selfservice.core.config - package org.forgerock.selfservice.core.config
This package contains the service configuration.
org.forgerock.selfservice.core.crypto - package org.forgerock.selfservice.core.crypto
This package contains crypto related implementations for self-service.
org.forgerock.selfservice.core.snapshot - package org.forgerock.selfservice.core.snapshot
This package contains the implementation for creating and management of snapshots.
org.forgerock.selfservice.core.util - package org.forgerock.selfservice.core.util
This package contains core utility methods and classes.

P

patchInstance(Context, String, PatchRequest) - Method in class org.forgerock.selfservice.core.UserUpdateService
 
ProcessContext - Interface in org.forgerock.selfservice.core
Process context represents the current state of the workflow.
ProcessInstanceConfig - Class in org.forgerock.selfservice.core.config
Represents the configuration for an instance of the anonymous process service.
ProcessInstanceConfig() - Constructor for class org.forgerock.selfservice.core.config.ProcessInstanceConfig
 
ProcessStore - Interface in org.forgerock.selfservice.core
Process store is used to persist state throughout a given flow cycle.
ProgressStage<C extends StageConfig> - Interface in org.forgerock.selfservice.core
Progress stage represents a single stage within the overall advance flow.
ProgressStageBinding<C extends StageConfig> - Class in org.forgerock.selfservice.core
Binds together the progress stage with its config.
ProgressStageProvider - Interface in org.forgerock.selfservice.core
Progress stage provider.
putState(String, Object) - Method in interface org.forgerock.selfservice.core.ProcessContext
Puts a value into the state referenced by the json pointer.
putSuccessAddition(String, Object) - Method in interface org.forgerock.selfservice.core.ProcessContext
Puts a value into the additions referenced by the json pointer.

Q

queryCollection(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.selfservice.core.UserUpdateService
 

R

readInstance(Context, String, ReadRequest) - Method in class org.forgerock.selfservice.core.UserUpdateService
 
remove(String) - Method in interface org.forgerock.selfservice.core.ProcessStore
Removes the state out of the store.
RequirementsBuilder - Class in org.forgerock.selfservice.core.util
Helper class to assist with the building of requirements.

S

SelfService - Annotation Type in org.forgerock.selfservice.core.annotations
Denotes self service dependencies.
SelfServiceContext - Class in org.forgerock.selfservice.core
A Context that indicates the request came from Self-Service.
SelfServiceContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.selfservice.core.SelfServiceContext
Constructs a new SelfServiceContext.
SelfServiceContext(Context) - Constructor for class org.forgerock.selfservice.core.SelfServiceContext
Constructs a new SelfServiceContext.
ServiceUtils - Class in org.forgerock.selfservice.core
General utility class.
setCallback(SnapshotTokenCallback) - Method in interface org.forgerock.selfservice.core.StageResponse.RequirementsBuilder
Sets the snapshot token callback.
setRequirements(JsonValue) - Method in class org.forgerock.selfservice.core.StageResponse.Builder
Sets the json requirements.
setSnapshotTokenConfig(SnapshotTokenConfig) - Method in class org.forgerock.selfservice.core.config.ProcessInstanceConfig
Sets the snapshot token type to use.
setStageConfigs(List<StageConfig>) - Method in class org.forgerock.selfservice.core.config.ProcessInstanceConfig
Sets the list of stage configs.
setStageTag(String) - Method in class org.forgerock.selfservice.core.StageResponse.Builder
Sets the stage tag.
setStorageType(StorageType) - Method in class org.forgerock.selfservice.core.config.ProcessInstanceConfig
Sets the storage type to use.
SnapshotTokenCallback - Interface in org.forgerock.selfservice.core.snapshot
Callback is invoked when a new snapshot token is created just before requirements are returned to the client.
SnapshotTokenConfig - Interface in org.forgerock.selfservice.core.snapshot
Represents the configuration for an TokenHandler.
SnapshotTokenHandlerFactory - Interface in org.forgerock.selfservice.core.snapshot
Factory for delivering snapshot token handlers.
snapshotTokenPreview(ProcessContext, String) - Method in interface org.forgerock.selfservice.core.snapshot.SnapshotTokenCallback
Preview of the snapshot token just prior to requirements being sent to the client.
StageConfig - Interface in org.forgerock.selfservice.core.config
Represents the configuration for a given progress stage.
StageConfigException - Exception in org.forgerock.selfservice.core.config
Represents some framework error around the use of progress stages and configs.
StageConfigException(String) - Constructor for exception org.forgerock.selfservice.core.config.StageConfigException
Creates an exception instance.
StageConfigException(String, Throwable) - Constructor for exception org.forgerock.selfservice.core.config.StageConfigException
Creates an exception instance.
StageResponse - Class in org.forgerock.selfservice.core
Stage response represents a response from having invoked a progress stage.
StageResponse.Builder - Class in org.forgerock.selfservice.core
Builder assists with the creation of StageResponse instances.
StageResponse.RequirementsBuilder - Interface in org.forgerock.selfservice.core
Requirements builder allows for the definition of a snapshot token callback, which gets invoked with just prior to requirements being sent to the client.
STATELESS - Enum constant in enum org.forgerock.selfservice.core.StorageType
State is serialised into request/response to avoid server-side state management.
StorageType - Enum in org.forgerock.selfservice.core
Indicates whether the service should operate in stateless or stateful mode.

U

updateInstance(Context, String, UpdateRequest) - Method in class org.forgerock.selfservice.core.UserUpdateService
 
UserUpdateService - Class in org.forgerock.selfservice.core
A RequestHandler that proxies user requests to update the user's KBA answers.
UserUpdateService(ConnectionFactory, ResourcePath, JsonPointer) - Constructor for class org.forgerock.selfservice.core.UserUpdateService
Construct a service to update the user's KBA info.

V

valueOf(String) - Static method in enum org.forgerock.selfservice.core.StorageType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.forgerock.selfservice.core.StorageType
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I J L M N O P Q R S U V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form