com.sssw.fw.directory.api
Interface EbiDirectoryConnection

public interface EbiDirectoryConnection

Represents a connection to the directory service.

Since:

v.5.0

Method Summary

void	activate() Activates the connection.
void	authenticate(String directory, String userName, String password, boolean useSsl) Authenticates the user given the username and password.
void	connect() Establishes the connection.
void	disconnect() Terminates the connection.
DirContext	getDirectoryContext() Gets the directory context.
long	getTimeout() Gets the connection timeout value.
String	getUserName() Gets the username set into the connection.
void	idle() Allows the connection to go idle.
boolean	isAuthenticated() Tells whether the user has been authenticated.
boolean	isDisconnected() Tells whether the connection has been terminated.
boolean	isIdle() Tells whether the connection is in the idle state.
void	setTimeout(long timeout) Sets the timeout value.
void	unauthenticate() Un-authenticates the user.

Method Detail

activate

public void activate()

Activates the connection.

authenticate

public void authenticate(String directory,
                         String userName,
                         String password,
                         boolean useSsl)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Authenticates the user given the username and password.

Parameters:

directory - directory provider name

userName - the username

password - the password

useSsl - if true, SSL is used

Throws:

EboUnrecoverableSystemException -

EboSecurityException -

connect

public void connect()
             throws EboUnrecoverableSystemException,
                    EboSecurityException

Establishes the connection.

Throws:

EboUnrecoverableSystemException -

EboSecurityException -

disconnect

public void disconnect()
                throws EboUnrecoverableSystemException

Terminates the connection.

Throws:

EboUnrecoverableSystemException -

getDirectoryContext

public DirContext getDirectoryContext()
                               throws EboUnrecoverableSystemException

Gets the directory context.

Returns:

the directory context

Throws:

EboUnrecoverableSystemException -

getTimeout

public long getTimeout()

Gets the connection timeout value.

Returns:

the connection timeout value, in milliseconds

getUserName

public String getUserName()

Gets the username set into the connection.

Returns:

the username

idle

public void idle()
          throws EboUnrecoverableSystemException

Allows the connection to go idle.

Throws:

EboUnrecoverableSystemException -

isAuthenticated

public boolean isAuthenticated()

Tells whether the user has been authenticated.

Returns:

true if the user has been authenticated, false otherwise

isDisconnected

public boolean isDisconnected()

Tells whether the connection has been terminated.

Returns:

true if the connection has been terminated, false otherwise

isIdle

public boolean isIdle()

Tells whether the connection is in the idle state.

Returns:

true if the connection is in the idle state, false otherwise

setTimeout

public void setTimeout(long timeout)

Sets the timeout value.

Parameters:

timeout - the timeout value, in milliseconds

unauthenticate

public void unauthenticate()
                    throws EboUnrecoverableSystemException

Un-authenticates the user.