|
Oracle Fusion Middleware Access SDK Java API Reference for Oracle Access Management Access Manager 11g Release 2 Patch Set 1(11.1.2.1.0) E27136-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.security.am.asdk.AuthenticationScheme
public final class AuthenticationScheme
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:
Constructor Summary | |
---|---|
AuthenticationScheme(AccessClient aClient, ResourceRequest resReq) Constructs AuthenticationScheme object for the specified ResourceRequest using specified AccessClient object. |
|
AuthenticationScheme(AccessClient aClient, java.lang.String schemeId) Constructs AuthenticationScheme object for the specified scheme id using specified AccessClient object. |
|
AuthenticationScheme(ResourceRequest resReq) Constructs AuthenticationScheme object for the specified ResourceRequest. |
|
AuthenticationScheme(java.lang.String schemeId) Constructs AuthenticationScheme object for the specified scheme id. |
Method Summary | |
---|---|
java.lang.Object |
clone() Used to clone AuthenticationScheme Objects. |
java.util.Hashtable |
getAllChallengeParameters() Returns all the challenge parameters specified during configuration for a given authentication scheme for example userid, password. |
java.lang.String |
getChallengeParameter(java.lang.String paramName) Returns challenge parameter value specified in authentication scheme |
int |
getLevel() Returns the numeric authentication level as specified during authentication scheme configuration |
long |
getMask() Returns integer value of authentication challenge method used for protecting the resource. |
java.lang.String |
getName() Returns the authentication scheme name |
int |
getNumberOfChallengeParameters() Returns number of challenge parameters in authentication scheme |
java.lang.String |
getRedirectUrl() Returns the URL specified during configuration, to be used for redirecting the clients for authentication |
java.lang.String |
getSchemeId() Returns the scheme id |
boolean |
isBasic() Checks if authentication scheme is of type Basic |
boolean |
isCertificate() Checks if authentication scheme is of type X509Cert |
boolean |
isForm() Checks if authentication scheme is of type Form |
boolean |
isNone() Checks if authentication scheme type is None i.e.Anonymous |
boolean |
requiresSecureTransport() Checks whether secure transport is required |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AuthenticationScheme(java.lang.String schemeId) throws AccessException
schemeId
- authentication scheme id, a string, for which the authentication scheme object is being constructedAccessException
- In case of failure to create the object or if resource object is nullpublic AuthenticationScheme(AccessClient aClient, java.lang.String schemeId) throws AccessException
aClient
- AccessClient object to be used for perfoming operations.schemeId
- authentication scheme id, a string, for which the authentication scheme object is being constructedAccessException
- in case of failure to create the object or if resource object is nullpublic AuthenticationScheme(ResourceRequest resReq) throws AccessException
resReq
- resource object for which the authentication scheme object is being constructedAccessException
- In case of failure to create the object or if resource object is nullpublic AuthenticationScheme(AccessClient aClient, ResourceRequest resReq) throws AccessException
aClient
- AccessClient object to be used for perfoming operations.resReq
- resource object for which the authentication scheme object is being constructedAccessException
- In case of failure to create the object or if resource object is nullMethod Detail |
---|
public long getMask() throws AccessException
AccessException
- In case if it fails to return the authentication challenge method.public boolean requiresSecureTransport() throws AccessException
AccessException
- In case if it fails to return the boolean value for transport security reqirement.public boolean isBasic() throws AccessException
AccessException
- In case if it fails to return the boolean value for authentication scheme type is Basic or not.public boolean isCertificate() throws AccessException
AccessException
- In case if it fails to return the boolean value for scheme requires digitial certificates or not.public boolean isForm() throws AccessException
AccessException
- In case if it fails to return the boolean value for authentication scheme type is Form or not.public boolean isNone() throws AccessException
AccessException
- In case if it fails to return the boolean value for authentication required or not.public java.lang.String getSchemeId()
public java.lang.String getName() throws AccessException
AccessException
- In case if it fails to return the authentication scheme name or if it returns null String.public int getLevel() throws AccessException
AccessException
- In case if it fails to return the authentication levelpublic java.lang.String getRedirectUrl() throws AccessException
AccessException
- If error occurs during this operation.public int getNumberOfChallengeParameters() throws AccessException
AccessException
- In case if it fails to return the number of challenge parameterspublic java.lang.String getChallengeParameter(java.lang.String paramName) throws AccessException
paramName
- name of challenge parameterAccessException
- In case if it fails to return the challenge parameter value for the given parameterNamepublic java.util.Hashtable getAllChallengeParameters() throws AccessException
AccessException
- In case if it fails to return all the challenge parameterspublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
finalize()
to clean up any unused old referencesclone
in class java.lang.Object
java.lang.CloneNotSupportedException
|
Oracle Fusion Middleware Access SDK Java API Reference for Oracle Access Management Access Manager 11g Release 2 Patch Set 1(11.1.2.1.0) E27136-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |