oracle.lite.resource

Class OidAuthenticator

java.lang.Object

oracle.lite.resource.OidAuthenticator

All Implemented Interfaces:

Authenticator, GenericProvider

public final class OidAuthenticator
extends java.lang.Object
implements Authenticator

Oracle Internet Directory Authenticator implementation.

Constructor Summary

Constructors

Constructor and Description
OidAuthenticator()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	authenticate(java.lang.String uid, java.lang.String pwd) Authenticate the user and return a sesison Id.
void	changePassword(java.lang.Object sid, java.lang.String pwd) Change User's password.
void	destroy() Mobile Server will call this method when the system shutsdown.
java.lang.String	getFullName(java.lang.Object sid) Return the Full Name of the User.
java.lang.StringBuffer	getInitializationScripts(java.lang.Object sid) If the User has not been instantiated in the Mobile Server repository, Mobile Server will call this method after authenticating the User to retrieve the initialization scripts for the User.
java.lang.String	getUserGUID(java.lang.Object sid) Return the GUID (Globally Unique Id) of the User if there is one.
void	initialize(java.lang.String metaData) Initialize Oracle Internet Directory based Authenticator.
void	logOff(java.lang.Object sid) Log off the User from the back-end system.

Methods inherited from class java.lang.Object

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

Constructor Detail

OidAuthenticator

public OidAuthenticator()

Method Detail

authenticate

public java.lang.Object authenticate(java.lang.String uid,
                            java.lang.String pwd)
                              throws java.lang.SecurityException

Authenticate the user and return a sesison Id. The session Id is a String array of GUID and UID.

Specified by:

authenticate in interface Authenticator

Parameters:

uid - User Id (or User Name)

pwd - User's password string

Returns:

Session handle, null otherwise

Throws:

java.lang.SecurityException

changePassword

public void changePassword(java.lang.Object sid,
                  java.lang.String pwd)
                    throws java.lang.SecurityException

Change User's password.

Specified by:

changePassword in interface Authenticator

Parameters:

sid - Session handle returned by 'authenticate' method.

pwd - User's new password

Throws:

java.lang.SecurityException

java.lang.SecurityException

destroy

public void destroy()
             throws java.lang.Exception

Description copied from interface: GenericProvider

Mobile Server will call this method when the system shutsdown. Provider implementation should implement all the cleanup code in this method.

Specified by:

destroy in interface GenericProvider

Throws:

java.lang.Exception

getFullName

public java.lang.String getFullName(java.lang.Object sid)

Description copied from interface: Authenticator

Return the Full Name of the User.

Specified by:

getFullName in interface Authenticator

Parameters:

sid - Session handle returned by 'authenticate' method.

Returns:

User's full name

getInitializationScripts

public java.lang.StringBuffer getInitializationScripts(java.lang.Object sid)

Description copied from interface: Authenticator

If the User has not been instantiated in the Mobile Server repository, Mobile Server will call this method after authenticating the User to retrieve the initialization scripts for the User. Mobile Server will use the initialization scripts to instantiate the User in the Mobile Server and assign access rights to applications and data. Please refer to Mobile Server's repository script documentation for the format of the script file.

Specified by:

getInitializationScripts in interface Authenticator

Parameters:

sid - Session handle returned by 'authenticate' method.

Returns:

StringBuffer containing User's initialization scripts.

getUserGUID

public java.lang.String getUserGUID(java.lang.Object sid)

Description copied from interface: Authenticator

Return the GUID (Globally Unique Id) of the User if there is one. Usually, LDAP based User Management systems maintain a GUID for each user. In case your authentication mechanism does not support GUID, return null

Specified by:

getUserGUID in interface Authenticator

Parameters:

sid - Session handle returned by 'authenticate' method.

Returns:

GUID string

initialize

public void initialize(java.lang.String metaData)
                throws java.lang.Exception

Initialize Oracle Internet Directory based Authenticator.

Specified by:

initialize in interface GenericProvider

Parameters:

metaData - Provider meta data string

Throws:

java.lang.Exception

java.lang.Exception

logOff

public void logOff(java.lang.Object sid)
            throws java.lang.SecurityException

Description copied from interface: Authenticator

Log off the User from the back-end system. Please note that this method may not be called for each successful User authentication.

Specified by:

logOff in interface Authenticator

Parameters:

sid - Session handle returned by 'authenticate' method.

Throws:

java.lang.SecurityException