Package de.elo.ix.client

Class IXConnLoginBYPS

java.lang.Object

de.elo.ix.client.IXConnLogin

de.elo.ix.client.IXConnLoginBYPS

public class IXConnLoginBYPS
extends IXConnLogin

Field Summary

Fields inherited from class de.elo.ix.client.IXConnLogin

callId, DEFAULT_LOOP_MAX, encrPasswords, ix, loginCallbacks, loginCount, lr, RELOGIN_ERRORS, sessOpts, ticketBestBefore

Constructor Summary

Constructors

Constructor	Description
IXConnLoginBYPS(IXConnFactory connFact, IXConnection conn, Properties sessOpts, Properties encrPasswords)

Method Summary

Modifier and Type	Method	Description
void	addLoginListener(IXConnLoginCallback cb)	Add login listener.
ClientInfo	ci()	Return the current ClientInfo object.
String	encryptPassword(String pwd)	Encrypts the given password.
Properties	getEncrPasswords()	Get encryption passwords.
int	getLoginCount()	Number of re-logins are counted by this value.
IXProperties	getSessionOptions()	Get session options.
long	getTicketBestBefore()	Ticket is valid until this time.
boolean	isReloginError(Throwable e)	Returns true, if the specified error is a session timeout error.
IXServicePortIF	ix()	Get Indexserver interface.
void	login()	Performs the login.
LoginResult	lr()	Return the current LoginResult object.
protected SessionOptions	makeSessOptsObj()	Make Indexserver API object from java.util.Properties
int	reloginOrThrow(int prevLoginCount, int loopCount, byps.RemoteException e)	Checks wether the given error is a session timeout.

Methods inherited from class java.lang.Object

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

Constructor Details

IXConnLoginBYPS

public IXConnLoginBYPS(IXConnFactory connFact,
 IXConnection conn,
 Properties sessOpts,
 Properties encrPasswords)

Method Details

ci

public ClientInfo ci()

Description copied from class: IXConnLogin

Return the current ClientInfo object.

Overrides:

ci in class IXConnLogin

Returns:

ClientInfo object

lr

public LoginResult lr()

Description copied from class: IXConnLogin

Return the current LoginResult object.

Overrides:

lr in class IXConnLogin

Returns:

LoginResult object

ix

public IXServicePortIF ix()

Description copied from class: IXConnLogin

Get Indexserver interface.

Overrides:

ix in class IXConnLogin

Returns:

Indexserver object

getLoginCount

public int getLoginCount()

Description copied from class: IXConnLogin

Number of re-logins are counted by this value.

Overrides:

getLoginCount in class IXConnLogin

Returns:

Number of re-logins

getSessionOptions

public IXProperties getSessionOptions()

Description copied from class: IXConnLogin

Get session options.

Overrides:

getSessionOptions in class IXConnLogin

Returns:

Session options

getEncrPasswords

public Properties getEncrPasswords()

Description copied from class: IXConnLogin

Get encryption passwords.

Overrides:

getEncrPasswords in class IXConnLogin

Returns:

Encryption passwords

isReloginError

public boolean isReloginError(Throwable e)

Description copied from class: IXConnLogin

Returns true, if the specified error is a session timeout error.

Overrides:

isReloginError in class IXConnLogin

Parameters:

e - Exception

Returns:

true, if function should be retried after a re-login.

reloginOrThrow

public int reloginOrThrow(int prevLoginCount,
 int loopCount,
 byps.RemoteException e)
                   throws byps.RemoteException

Description copied from class: IXConnLogin

Checks wether the given error is a session timeout. In this case the login function is called. Otherwise the exeption is thrown.

Overrides:

reloginOrThrow in class IXConnLogin

Parameters:

prevLoginCount - Number of login retries passed to the previous call

loopCount - Number of retries

e - Exception or null. If not null, the Exception is immediately fired.

Returns:

Current number of re-logins.

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

makeSessOptsObj

protected SessionOptions makeSessOptsObj()

Description copied from class: IXConnLogin

Make Indexserver API object from java.util.Properties

Overrides:

makeSessOptsObj in class IXConnLogin

Returns:

Session options

getTicketBestBefore

public long getTicketBestBefore()

Description copied from class: IXConnLogin

Ticket is valid until this time.

Overrides:

getTicketBestBefore in class IXConnLogin

Returns:

System milliseconds when the ticket expires

addLoginListener

public void addLoginListener(IXConnLoginCallback cb)

Description copied from class: IXConnLogin

Add login listener. The interface is called, after login was successful and session options were sent. If the session expires and a re-login is performed, the interface is called again.

Overrides:

addLoginListener in class IXConnLogin

Parameters:

cb - Callback object

login

public void login()
           throws byps.RemoteException

Description copied from class: IXConnLogin

Performs the login. To be implemented by subclass.

Specified by:

login in class IXConnLogin

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text".

encryptPassword

public String encryptPassword(String pwd)
                       throws byps.RemoteException

Description copied from class: IXConnLogin

Encrypts the given password.

Specified by:

encryptPassword in class IXConnLogin

Parameters:

pwd - Plain text password.

Returns:

Encrypted password.

Throws:

byps.RemoteException - Exception with message text of format "[ELOIX:number] text".