Package oracle.security.am.asdk

Class AuthenticationScheme

java.lang.Object
oracle.security.am.asdk.AuthenticationScheme
All Implemented Interfaces:
Cloneable
public final class AuthenticationScheme extends Object implements Cloneable
Represents an Authentication Scheme and provides functionality to access related information.

An authentication scheme specifies how a user is to be challenged for a set of credentials, name-value string pairs (for example userid and password) that are used to authenticate a user.

An authentication scheme has:

  • a display name,
  • a mask indicating the authentication challenge to be used:
    • Basic: userid and password,
    • Certificate: assumes that the SSL client authentication has been done,
    • Form: with customer-defined credential fields,
    • None: produces no credentials, and
    • whether the scheme requires a secure transport,
  • a numeric level indicating the strength of the authentication,
  • a redirection URL indicating where HTTP authentication is to be performed (may be empty),
  • a set of challenge parameters each of the form parameter:value which supply additional scheme-dependent information

  • Constructor Details

    • AuthenticationScheme

      public AuthenticationScheme<wbr>(String schemeId) throws AccessException
      Constructs AuthenticationScheme object for the specified scheme id.
      Parameters:
      schemeId - authentication scheme id, a string, for which the authentication scheme object is being constructed
      Throws:
      AccessException - In case of failure to create the object or if resource object is null

    • AuthenticationScheme

      public AuthenticationScheme<wbr>(AccessClient aClient, String schemeId) throws AccessException
      Constructs AuthenticationScheme object for the specified scheme id using specified AccessClient object.
      Parameters:
      aClient - AccessClient object to be used for perfoming operations.
      schemeId - authentication scheme id, a string, for which the authentication scheme object is being constructed
      Throws:
      AccessException - in case of failure to create the object or if resource object is null

    • AuthenticationScheme

      public AuthenticationScheme<wbr>(ResourceRequest resReq) throws AccessException
      Constructs AuthenticationScheme object for the specified ResourceRequest.
      Parameters:
      resReq - resource object for which the authentication scheme object is being constructed
      Throws:
      AccessException - In case of failure to create the object or if resource object is null

    • AuthenticationScheme

      public AuthenticationScheme<wbr>(AccessClient aClient, ResourceRequest resReq) throws AccessException
      Constructs AuthenticationScheme object for the specified ResourceRequest using specified AccessClient object.
      Parameters:
      aClient - AccessClient object to be used for perfoming operations.
      resReq - resource object for which the authentication scheme object is being constructed
      Throws:
      AccessException - In case of failure to create the object or if resource object is null

  • Method Details

    • getMask

      public long getMask() throws AccessException
      Returns integer value of authentication challenge method used for protecting the resource. Values returned are as follows:
      • 0 for Anonymous authentication scheme
      • 1 for Basic authentication scheme
      • 4 for Form based authentication scheme
      • 128 for X509 based authentication scheme
      Returns:
      Authentication challenge method used for protecting the resource
      Throws:
      AccessException - In case if it fails to return the authentication challenge method.

    • requiresSecureTransport

      public boolean requiresSecureTransport() throws AccessException
      Checks whether secure transport is required
      Returns:
      Boolean true if secure transport is required
      Throws:
      AccessException - In case if it fails to return the boolean value for transport security reqirement.

    • isBasic

      public boolean isBasic() throws AccessException
      Checks if authentication scheme is of type Basic
      Returns:
      Boolean true if authentication scheme is Basic
      Throws:
      AccessException - In case if it fails to return the boolean value for authentication scheme type is Basic or not.

    • isCertificate

      public boolean isCertificate() throws AccessException
      Checks if authentication scheme is of type X509Cert
      Returns:
      Boolean true if authentication scheme is X509Cert
      Throws:
      AccessException - In case if it fails to return the boolean value for scheme requires digitial certificates or not.

    • isForm

      public boolean isForm() throws AccessException
      Checks if authentication scheme is of type Form
      Returns:
      Boolean true if authentication scheme is Form
      Throws:
      AccessException - In case if it fails to return the boolean value for authentication scheme type is Form or not.

    • isNone

      public boolean isNone() throws AccessException
      Checks if authentication scheme type is None i.e.Anonymous
      Returns:
      Boolean true if authentication scheme is None
      Throws:
      AccessException - In case if it fails to return the boolean value for authentication required or not.

    • getSchemeId

      public String getSchemeId()
      Returns the scheme id
      Returns:
      String representing scheme id

    • getName

      public String getName() throws AccessException
      Returns the authentication scheme name
      Returns:
      String representing authentication scheme name
      Throws:
      AccessException - In case if it fails to return the authentication scheme name or if it returns null String.

    • getLevel

      public int getLevel() throws AccessException
      Returns the numeric authentication level as specified during authentication scheme configuration
      Returns:
      A numeric representation of the security level
      Throws:
      AccessException - In case if it fails to return the authentication level

    • getRedirectUrl

      public String getRedirectUrl() throws AccessException
      Returns the URL specified during configuration, to be used for redirecting the clients for authentication
      Returns:
      URL string to be used for redirection. It returns empty string if redirection url not specified.
      Throws:
      AccessException - If error occurs during this operation.

    • getNumberOfChallengeParameters

      public int getNumberOfChallengeParameters() throws AccessException
      Returns number of challenge parameters in authentication scheme
      Returns:
      Number of challenge parameters
      Throws:
      AccessException - In case if it fails to return the number of challenge parameters

    • getChallengeParameter

      public String getChallengeParameter<wbr>(String paramName) throws AccessException
      Returns challenge parameter value specified in authentication scheme
      Parameters:
      paramName - name of challenge parameter
      Returns:
      Challenge parameter value for given paramName
      Throws:
      AccessException - In case if it fails to return the challenge parameter value for the given parameterName

    • getAllChallengeParameters

      public Hashtable getAllChallengeParameters() throws AccessException
      Returns all the challenge parameters specified during configuration for a given authentication scheme for example userid, password.
      Returns:
      Hashtable containing all challenge parameters in the name/value pair of String type.
      Throws:
      AccessException - In case if it fails to return all the challenge parameters

    • clone

      public Object clone() throws CloneNotSupportedException
      Used to clone AuthenticationScheme Objects. When using this function it is recommended you use finalize() to clean up any unused old references
      Throws:
      CloneNotSupportedException