com.oblix.access

Class ObAuthenticationScheme

java.lang.Object

com.oblix.access.ObAuthenticationScheme

All Implemented Interfaces:

ObAuthenticationSchemeInterface, java.lang.Cloneable

Deprecated.

ObAuthenticationScheme objects represent authentication schemes defined through the Access System Configuration console and used in the authentication rules for policy domains and policies.

public class ObAuthenticationScheme
extends java.lang.Object
implements ObAuthenticationSchemeInterface, java.lang.Cloneable

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

In Oracle package, methods getName(), isBasic(), isCertificate() etc. from class AuthenticationScheme throws AccessException in case if Access Server API not initialized or if scheme id is null. And this is affecting on methods from Oblix package. So to retain backward compatibility the calling methods from this class such as getName(), isBasic(), isCertificate() etc. catches the checked exception and throws ObAccessRuntimeException.

Constructor Summary

Constructors

Constructor and Description
ObAuthenticationScheme(ObResourceRequest res) Deprecated. Constructs ObAuthenticationScheme object for the specified ObResourceRequest.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Deprecated. Used to clone ObAuthenticationScheme Objects.
void	finalize() Deprecated. Cleans up native ObAuthenticationScheme objects.
java.util.Hashtable	getAllChallengeParameters() Deprecated. Returns all the challenge parameters specified during configuration for a given authentication scheme
java.lang.String	getChallengeParameter(java.lang.String paramName) Deprecated. Returns a value of a given challenge parameters by name, as specified during configuration
int	getLevel() Deprecated. Returns the numeric authentication level as specified during authentication scheme configuration
java.lang.String	getName() Deprecated. Returns the display name of the authentication scheme
int	getNumberOfChallengeParameters() Deprecated. Returns the current number of challenge parameters in authentication scheme
java.lang.String	getRedirectUrl() Deprecated. Returns the URL specified during configuration, to be used for redirecting the clients for authentication
boolean	isBasic() Deprecated. Returns true if authentication scheme is Basic
boolean	isCertificate() Deprecated. Returns true if scheme requires digitial certificates,else returns false
boolean	isForm() Deprecated. Returns true if scheme requires FORM based authentication
boolean	isNone() Deprecated. Returns true if authentication is not required, else returns false
boolean	requiresSecureTransport() Deprecated. Returns true if scheme requires SSL client connection, else returns false

Methods inherited from class java.lang.Object

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

Constructor Detail

ObAuthenticationScheme

public ObAuthenticationScheme(ObResourceRequest res)
                       throws ObAccessException

Deprecated.

Constructs ObAuthenticationScheme object for the specified ObResourceRequest.

Parameters:

res - Resource object for which the authentication scheme object is being constructed

Throws:

ObAccessException - In case of failure to create the object or if resource object is null

Method Detail

finalize

public void finalize()

Deprecated.

Description copied from interface: ObAuthenticationSchemeInterface

Cleans up native ObAuthenticationScheme objects. It is recommended that applications using Access Server API use finalize() methods for the resources that are no longer in use, instead of relying on Java Garbage Collection.

Specified by:

finalize in interface ObAuthenticationSchemeInterface

Overrides:

finalize in class java.lang.Object

getName

public java.lang.String getName()

Deprecated.

Returns the display name of the authentication scheme

Specified by:

getName in interface ObAuthenticationSchemeInterface

Returns:

Display name of the authentication scheme

Throws:

ObAccessRuntimeException - In case if it fails to return the authentication scheme name or if it returns null String.

requiresSecureTransport

public boolean requiresSecureTransport()

Deprecated.

Returns true if scheme requires SSL client connection, else returns false

Specified by:

requiresSecureTransport in interface ObAuthenticationSchemeInterface

Returns:

Returns true if scheme requires SSL client connection

Throws:

ObAccessRuntimeException - In case if it fails to return the boolean value for transport security.

isBasic

public boolean isBasic()

Deprecated.

Returns true if authentication scheme is Basic

Specified by:

isBasic in interface ObAuthenticationSchemeInterface

Returns:

Boolean true if authentication scheme type is Basic

Throws:

ObAccessRuntimeException - In case if it fails to return the boolean value for authentication scheme type is Basic or not.

isCertificate

public boolean isCertificate()

Deprecated.

Returns true if scheme requires digitial certificates,else returns false

Specified by:

isCertificate in interface ObAuthenticationSchemeInterface

Returns:

Boolean true if scheme requires digitial certificates

Throws:

ObAccessRuntimeException - In case if it fails to return the boolean value for scheme requires digitial certificates or not.

isForm

public boolean isForm()

Deprecated.

Returns true if scheme requires FORM based authentication

Specified by:

isForm in interface ObAuthenticationSchemeInterface

Returns:

Boolean true if authentication scheme type is Form

Throws:

ObAccessRuntimeException - In case if it fails to return the boolean value for authentication scheme type is Form or not.

isNone

public boolean isNone()

Deprecated.

Returns true if authentication is not required, else returns false

Specified by:

isNone in interface ObAuthenticationSchemeInterface

Returns:

Boolean true if authentication is not required

Throws:

ObAccessRuntimeException - In case if it fails to return the boolean value for authentication required or not.

getLevel

public int getLevel()

Deprecated.

Returns the numeric authentication level as specified during authentication scheme configuration

Specified by:

getLevel in interface ObAuthenticationSchemeInterface

Returns:

A numeric representation of the security level

Throws:

ObAccessRuntimeException - In case if it fails to return the authentication level

getRedirectUrl

public java.lang.String getRedirectUrl()

Deprecated.

Returns the URL specified during configuration, to be used for redirecting the clients for authentication

Specified by:

getRedirectUrl in interface ObAuthenticationSchemeInterface

Returns:

URL string to be used for redirection

Throws:

ObAccessRuntimeException - In case if it fails to return the URL string for redirection or if it returns null string

getNumberOfChallengeParameters

public int getNumberOfChallengeParameters()

Deprecated.

Returns the current number of challenge parameters in authentication scheme

Specified by:

getNumberOfChallengeParameters in interface ObAuthenticationSchemeInterface

Returns:

Number of challenge parameters

Throws:

ObAccessRuntimeException - In case if it fails to return the number of challenge parameters

getChallengeParameter

public java.lang.String getChallengeParameter(java.lang.String paramName)

Deprecated.

Returns a value of a given challenge parameters by name, as specified during configuration

Specified by:

getChallengeParameter in interface ObAuthenticationSchemeInterface

Parameters:

paramName - name of the challenge parameter

Returns:

Challenge parameter value for the given parameterName

Throws:

ObAccessRuntimeException - In case if it fails to return the challenge parameter value for the given parameterName

getAllChallengeParameters

public java.util.Hashtable getAllChallengeParameters()

Deprecated.

Returns all the challenge parameters specified during configuration for a given authentication scheme

Specified by:

getAllChallengeParameters in interface ObAuthenticationSchemeInterface

Returns:

Hashtable containing all chanllenge parameters as name/value pairs of String type

Throws:

ObAccessRuntimeException - In case if it fails to return all the challenge parameters

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Deprecated.

Used to clone ObAuthenticationScheme Objects. When using this function it is recommended you use finalize() to clean up any unused old references

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException