oracle.lite.provider

Interface Authenticator

All Superinterfaces:

GenericProvider

All Known Implementing Classes:

OidAuthenticator, OracleAuthenticator

public interface Authenticator
extends GenericProvider

External 'Authenticator' must implement this interface and and register it with Mobile Server. Mobile Server ships with a default 'Auth' provider implementation, you must replace it with your own implementation. Modify mobile.ora file to register your provider with Mobile Server. [EXTERNAL_AUTHENTICATION] CLASS=SampleAuthenticator

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.
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	logOff(java.lang.Object sid) Log off the User from the back-end system.

Methods inherited from interface oracle.lite.provider.GenericProvider

destroy, initialize

Method Detail

authenticate

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.

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

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

Change User's password.

Parameters:

sid - Session handle returned by 'authenticate' method.

pwd - User's new password

Throws:

java.lang.SecurityException

java.lang.SecurityException

getFullName

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

Return the Full Name of the User.

Parameters:

sid - Session handle returned by 'authenticate' method.

Returns:

User's full name

getInitializationScripts

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. 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.

Parameters:

sid - Session handle returned by 'authenticate' method.

Returns:

StringBuffer containing User's initialization scripts.

Throws:

java.lang.SecurityException

getUserGUID

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

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

Parameters:

sid - Session handle returned by 'authenticate' method.

Returns:

GUID string

logOff

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.

Parameters:

sid - Session handle returned by 'authenticate' method.

Throws:

java.lang.SecurityException

java.lang.SecurityException