Package de.elo.ix.client

Class IXAuthenticationNormalized

java.lang.Object

de.elo.ix.client.IXAuthenticationWrapper

de.elo.ix.client.IXAuthenticationNormalized

All Implemented Interfaces:

byps.BAuthentication, IXAuthenticationIF

public class IXAuthenticationNormalized
extends IXAuthenticationWrapper

A IXAuthenticationIF implementation for normalized IXConnection.

Field Summary

Fields inherited from interface de.elo.ix.client.IXAuthenticationIF

LOGIN_FOR_PUBLIC_ENCR_KEY

Constructor Summary

Constructors

Constructor	Description
IXAuthenticationNormalized(IXConnection baseConnection, IXAuthenticationIF baseAuthentication, ClientInfo clientInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	authenticate(byps.BClient bclientN, byps.BAsyncResult<Boolean> asyncResult)	Authenticate the current user.
EAuthenticationType	getAuthenticationType()	Type of this authentication object.
ClientInfo	getClientInfo()	This object is implicitly passed to each Indexserver request and contains the authentication ticket.
protected IXAuthenticationIF	getInnerAuthentication()	Return the encapsulated authentication object.
String	getInstanceName()	Return IXID defined in Indexserver options.
LoginResult	getLoginResult()	LoginResult received from Indexserver as the result of authentication.
Date	getServerTime()	Server time.
void	getSession(byps.BClient client, int typeId, byps.BAsyncResult<Object> asyncResult)	Return the object representing the current session.
String	getVersion()	Return IX version.
protected ClientInfo	normalize(ClientInfo clientInfo)	Copy the given object and the locale information to en_US and timezone UTC.

Methods inherited from class de.elo.ix.client.IXAuthenticationWrapper

addListener, encryptPassword, fromSessOptsObj, getDatabaseEngine, getEncryptionPasswords, getSessionOptions, isExpired, isReloginException, makeSessOptsObj, needAlive, removeListener, setLoginResult

Methods inherited from class java.lang.Object

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

Constructor Details

IXAuthenticationNormalized

public IXAuthenticationNormalized(IXConnection baseConnection,
 IXAuthenticationIF baseAuthentication,
 ClientInfo clientInfo)

Constructor.

Parameters:

baseConnection - Base connection on which the normalized connection is build.

baseAuthentication - Authentication object of baseConnection.

clientInfo - Language, country and timezone are taken from this object to compose the result of getClientInfo().

Method Details

getInnerAuthentication

protected IXAuthenticationIF getInnerAuthentication()

Return the encapsulated authentication object.

Specified by:

getInnerAuthentication in class IXAuthenticationWrapper

Returns:

Authentication object

authenticate

public void authenticate(byps.BClient bclientN,
 byps.BAsyncResult<Boolean> asyncResult)

Authenticate the current user.

Specified by:

authenticate in interface byps.BAuthentication

Overrides:

authenticate in class IXAuthenticationWrapper

Parameters:

bclientN - BClient object

asyncResult - Result object, only the exception is evaluated.

getSession

public void getSession(byps.BClient client,
 int typeId,
 byps.BAsyncResult<Object> asyncResult)

Return the object representing the current session. This object will be passed to every request class (e.g. BRequest_functionname) for remote interfaces tagged with @BSessionParamType. If the function throws an exception, the isReloginException and maybe the authentication functions are called before the current method request is sent.

Specified by:

getSession in interface byps.BAuthentication

Overrides:

getSession in class IXAuthenticationWrapper

Parameters:

client - BClient object

typeId - Type ID (serialVersionUID) of the last request class, see BAuthentication.isReloginException(BClient, Throwable, int).

asyncResult - This object receives the session object or an exception.

See Also:

• BMethodRequest.setSession(Object)

getClientInfo

public ClientInfo getClientInfo()

This object is implicitly passed to each Indexserver request and contains the authentication ticket.

Returns:

ClientInfo

getLoginResult

public LoginResult getLoginResult()

LoginResult received from Indexserver as the result of authentication.

Specified by:

getLoginResult in interface IXAuthenticationIF

Overrides:

getLoginResult in class IXAuthenticationWrapper

Returns:

LoginResult

getAuthenticationType

public EAuthenticationType getAuthenticationType()

Type of this authentication object.

Specified by:

getAuthenticationType in interface IXAuthenticationIF

Overrides:

getAuthenticationType in class IXAuthenticationWrapper

Returns:

Authentication type

getVersion

public String getVersion()

Description copied from interface: IXAuthenticationIF

Return IX version.

Returns:

IX version. EIX-2519

getServerTime

public Date getServerTime()

Description copied from interface: IXAuthenticationIF

Server time. EIX-2519

Returns:

Server time

normalize

protected ClientInfo normalize(ClientInfo clientInfo)

Copy the given object and the locale information to en_US and timezone UTC.

Parameters:

clientInfo - ClientInfo object

Returns:

ClientInfo object with the same ClientInfo.ticket and normalized locale and timezone.

getInstanceName

public String getInstanceName()

Description copied from interface: IXAuthenticationIF

Return IXID defined in Indexserver options.

Returns:

Instance name