Skip navigation links

com.oblix.access
Interface ObAuthenticationSchemeInterface

All Known Implementing Classes:

ObAuthenticationScheme

Deprecated. Provides an Interface for the class that represents an Authentication Scheme.

public interface ObAuthenticationSchemeInterface

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:

1. a display name
2. a mask indicating the type of the challenge:
   • Basic (userid and password)
   • X.509 certificate (assumes that the SSL client authentication)
   • HTML form
   • None
   • whether a secure transport (e.g. https) is required
3. a numeric level indicating the strength of the authentication
4. a redirection URL indicating where HTTP authentication is to be performed (may be empty),
5. a map of challenge parameters which supply additional scheme-dependent information,

   Challenge parameters defined by NetPoint Access System:

   • realm: (basic) the authentication domain For example: an LDAP directory
   • form: (form) the URL of the login form to be presented to the user
   • creds: (form) a space-separated list of login form fields to be used as credentials
   • action: (form) the URL to which the login form posts its data
6. a sequence of plugins that specify how the credentials are to be processed. Plugins are not visible through the Access Server API.

Authentication schemes are tied by NetPoint authentication policies to resources. Certain aspects of authentication (audit policy, actions) are only defined for resources. Consequently ObAuthenticationScheme constructors require an ObResourceRequest object to specify the authentication scheme.

Method Summary

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, for example userid,password
java.lang.String	getChallengeParameter(java.lang.String parameterName) Deprecated. Returns a value of a given challenge parameter 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 authentication scheme name
int	getNumberOfChallengeParameters() Deprecated. Returns 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. Checks if authentication scheme is of type Basic
boolean	isCertificate() Deprecated. Checks if authentication scheme is of type X509Cert
boolean	isForm() Deprecated. Checks if authentication scheme is of type Form
boolean	isNone() Deprecated. Checks if authentication scheme type is None i.e.Anonymous
boolean	requiresSecureTransport() Deprecated. Checks whether secure transport is required

Method Detail

getName

java.lang.String getName()

Deprecated.

Returns the authentication scheme name

Returns:

Authentication scheme name

requiresSecureTransport

boolean requiresSecureTransport()

Deprecated.

Checks whether secure transport is required

Returns:

Boolean true if secure transport is required

isBasic

boolean isBasic()

Deprecated.

Checks if authentication scheme is of type Basic

Returns:

Boolean true if authentication scheme is Basic

isCertificate

boolean isCertificate()

Deprecated.

Checks if authentication scheme is of type X509Cert

Returns:

Boolean true if authentication scheme is X509Cert

isForm

boolean isForm()

Deprecated.

Checks if authentication scheme is of type Form

Returns:

Boolean true if authentication scheme is Form

isNone

boolean isNone()

Deprecated.

Checks if authentication scheme type is None i.e.Anonymous

Returns:

Boolean true if authentication scheme is None

getLevel

int getLevel()

Deprecated.

Returns the numeric authentication level as specified during authentication scheme configuration

Returns:

A numeric representation of the security level

getRedirectUrl

java.lang.String getRedirectUrl()

Deprecated.

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.

getNumberOfChallengeParameters

int getNumberOfChallengeParameters()

Deprecated.

Returns number of challenge parameters in authentication scheme.

Returns:

Number of challenge parameters

getAllChallengeParameters

java.util.Hashtable getAllChallengeParameters()

Deprecated.

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(String) -value(String) pair.

Throws:

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

getChallengeParameter

java.lang.String getChallengeParameter(java.lang.String parameterName)

Deprecated.

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

Parameters:

parameterName - name of the challenge parameter

Returns:

Challenge parameter value for the given parameterName

finalize

void finalize()

Deprecated.

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.

Skip navigation links