oracle.lite.resource

Class OracleAuthenticator

java.lang.Object

oracle.lite.resource.OracleAuthenticator

All Implemented Interfaces:

Authenticator, GenericProvider

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

Oracle Mobile Server's default Authenticator implementation. An instance of this class handles all the authentication requests to be validated against the Mobile Server repository.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	authenticate(java.lang.String uid, java.lang.String pwd) Authenticate a User and return a session handle.
void	changePassword(java.lang.Object sid, java.lang.String pwd) Change User's password.
CredAuthResult	changePasswordWrapper(CredAuthResult car, java.lang.String pwd)
void	destroy() Cleanup allocated objects.
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.
static OracleAuthenticator	getInstance() Retrieve the lone instance of the OracleAuthenticator object.
java.lang.String	getName() Return the name of the authenticator.
User	getUser(java.lang.String uid) Retrieve User object from repository.
java.lang.String	getUserGUID(java.lang.Object sid) Return the GUID (Globally Unique Id) of the User if there is one.
java.util.ArrayList	getUsers(java.lang.String filter) Retrieve all User objects from the repository after applying a filter.
boolean	hasAuthenticator() Check to see if Mobile Server uses a valid external authenticator.
void	initialize(java.lang.String metaData) Initialize repository authenticator.
void	initialize(java.lang.String metaData, long exp) Initialize repository 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

Method Detail

authenticate

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

Authenticate a User and return a session handle. The returned session handle will be passed to 'logOff' method when User logs off from the system. Please note that 'logOff' may not be called for each successful 'authenticate' method call. Some of the Mobile Server clients may use 'authenticate' method to verify the User credential and will not log on to the system.

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

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

changePasswordWrapper

public CredAuthResult changePasswordWrapper(CredAuthResult car,
                                   java.lang.String pwd)
                                     throws java.lang.SecurityException

Throws:

java.lang.SecurityException

destroy

public void destroy()
             throws java.lang.Exception

Cleanup allocated objects.

Specified by:

destroy in interface GenericProvider

Throws:

java.lang.Exception

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.

getInstance

public static OracleAuthenticator getInstance()

Retrieve the lone instance of the OracleAuthenticator object.

Returns:

Instance of OracleAuthenticator

getName

public java.lang.String getName()

Return the name of the authenticator.

getUser

public User getUser(java.lang.String uid)

Retrieve User object from repository. This method does not throw oracle.lite.resource.ResourceException

Parameters:

uid - User's Id

Returns:

oracle.lite.resource.User object or null.

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

getUsers

public java.util.ArrayList getUsers(java.lang.String filter)
                             throws ResourceException

Retrieve all User objects from the repository after applying a filter.

Parameters:

filter - Search string

Returns:

java.util.ArrayList object containing User objects

Throws:

oracle.lite.resource.ResourceException

ResourceException

hasAuthenticator

public boolean hasAuthenticator()

Check to see if Mobile Server uses a valid external authenticator.

Returns:

true if there is a valid authenticator.

initialize

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

Initialize repository authenticator.

Specified by:

initialize in interface GenericProvider

Parameters:

metaData - Provider meta data string

Throws:

java.lang.Exception

java.lang.Exception

initialize

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

Initialize repository authenticator.

Parameters:

metaData - Provider meta data string

exp - User expiration time

Throws:

java.lang.Exception

java.lang.Exception

logOff

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

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

java.lang.SecurityException