Package org.forgerock.selfservice.stages.user

Class UserQueryConfig

java.lang.Object
org.forgerock.selfservice.stages.user.UserQueryConfig
All Implemented Interfaces:
StageConfig
public final class UserQueryConfig extends Object implements StageConfig
Configuration for the user query stage.
Since:
0.5.0

  • Field Details

  • Constructor Details

    • UserQueryConfig

      public UserQueryConfig()

  • Method Details

    • getResourceVersion

      public Version getResourceVersion()
      Gets the resource version fields to be used when looking up the user.
      Returns:
      resource version fields

    • setResourceVersion

      public UserQueryConfig setResourceVersion(Version resourceVersion)
      Sets the resource version fields to be used when looking up the user.
      Parameters:
      resourceVersion - resource version fields
      Returns:
      this config instance

    • getValidQueryFields

      public Set<String> getValidQueryFields()
      Gets the set of query fields to be used when looking up the user.
      Returns:
      query fields

    • setValidQueryFields

      public UserQueryConfig setValidQueryFields(Set<String> validQueryFields)
      Sets the set of query fields to be used when looking up the user.
      Parameters:
      validQueryFields - query fields
      Returns:
      this config instance

    • getIdentityServiceUrl

      public String getIdentityServiceUrl()
      Gets the URL for the identity service.
      Returns:
      the identity service URL

    • setIdentityServiceUrl

      public UserQueryConfig setIdentityServiceUrl(String identityServiceUrl)
      Sets the URL for the identity service.
      Parameters:
      identityServiceUrl - the identity service URL
      Returns:
      this config instance

    • getIdentityIdField

      public String getIdentityIdField()
      Gets the field name for the identity id.
      Returns:
      the identity id field name

    • setIdentityIdField

      public UserQueryConfig setIdentityIdField(String identityIdField)
      Sets the field name for the identity id.
      Parameters:
      identityIdField - the identity id field name
      Returns:
      this config instance

    • getIdentityEmailField

      public String getIdentityEmailField()
      Gets the field name for the identity email address.
      Returns:
      the identity email address field name

    • setIdentityEmailField

      public UserQueryConfig setIdentityEmailField(String identityEmailField)
      Sets the field name for the identity email address.
      Parameters:
      identityEmailField - the identity email address field name
      Returns:
      this config instance

    • getIdentityUsernameField

      public String getIdentityUsernameField()
      Gets the field name for the identity username.
      Returns:
      the identity username field name

    • setIdentityUsernameField

      public UserQueryConfig setIdentityUsernameField(String identityUsernameField)
      Sets the field name for the identity username.
      Parameters:
      identityUsernameField - the identity username field name
      Returns:
      this config instance

    • getIdentityAccountStatusField

      public String getIdentityAccountStatusField()
      Gets the field name for the account status.
      Returns:
      the account status

    • setIdentityAccountStatusField

      public UserQueryConfig setIdentityAccountStatusField(String identityAccountStatusField)
      Sets the field name for the identity account status.
      Parameters:
      identityAccountStatusField - the identity account status
      Returns:
      this config instance

    • getName

      public String getName()
      Description copied from interface: StageConfig
      Gets the name of the stage configuration.
      Specified by:
      getName in interface StageConfig
      Returns:
      the config name

    • getProgressStageClassName

      public String getProgressStageClassName()
      Description copied from interface: StageConfig
      Gets the class name of the consuming progress stage.
      Specified by:
      getProgressStageClassName in interface StageConfig
      Returns:
      the progress stage class name

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object