Package de.elo.ix.client.webapp

Interface AppConnManager

All Known Implementing Classes:

AppConnManagerImpl

public interface AppConnManager

This interface helps to create Indexserver connections.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AppConnManager.UniqueConnectionInitialized	This interface defines a callback function that is called from the AppConnManager, if the function initUniqueConnection has established a connection.

Method Summary

Modifier and Type	Method	Description
IXConnection	createConnection(String runAs)	Creates a connection to the Indexserver.
IXConnection	createConnection(String computerName, String runAs)	Creates a connection to the Indexserver.
IXConnection	createConnection(String ixUrl, String userName, String userPwd, String computerName, String runAs)	Creates a connection to the Indexserver.
Application	getApplication()	Back pointer to the Application object that contains this ConnManager.
IXConnFactory	getConnFactory()	Returns an IXConnFactory object initialized with the Indexserver URL found in the configuration properties.
IXConnFactory	getConnFactory(String ixUrl)	Returns an IXConnFactory object initialized with the supplied connection parameters.
List<AppEvent>	getEvents()	Get the list of events.
IXConnection	getUniqueConnection()	Gets the unique internally stored Indexserver connection.
void	initUniqueConnection()	Initialize the unique internally stored Indexserver connection.
void	shutdown()

Method Details

getApplication

Application getApplication()

Back pointer to the Application object that contains this ConnManager.

Returns:

Object

getConnFactory

IXConnFactory getConnFactory(String ixUrl)
                      throws byps.RemoteException

Returns an IXConnFactory object initialized with the supplied connection parameters.

Parameters:

ixUrl - Indexserver URL

Returns:

IXConnFactory object.

Throws:

byps.RemoteException

See Also:

• getConnFactory()

getConnFactory

IXConnFactory getConnFactory()
                      throws byps.RemoteException

Returns an IXConnFactory object initialized with the Indexserver URL found in the configuration properties. The function assumes, that the Indexserver URL can be found under the key getApplication().getAppPropertyNames().getIxUrl().

Returns:

IXConnFactory object

Throws:

byps.RemoteException

See Also:

• getConnFactory(String)
• AppConfig.getAppPropertyNames()

createConnection

IXConnection createConnection(String ixUrl,
 String userName,
 String userPwd,
 String computerName,
 String runAs)
                       throws byps.RemoteException

Creates a connection to the Indexserver.

Parameters:

ixUrl - Indexserver URL

userName - User name

userPwd - User password

computerName - Computer name (internally prefixed by the program name)

runAs - Run-As user

Returns:

IXConnection

Throws:

byps.RemoteException

createConnection

IXConnection createConnection(String computerName,
 String runAs)
                       throws byps.RemoteException

Creates a connection to the Indexserver. The Indexserver URL, the user name and password are taken from the configuration properties.

Parameters:

computerName - Computer name (internally prefixed by the program name)

runAs - Run-As user

Returns:

IXConnection

Throws:

byps.RemoteException

See Also:

• AppConfig.getAppPropertyNames()

createConnection

IXConnection createConnection(String runAs)
                       throws byps.RemoteException

Creates a connection to the Indexserver. The Indexserver URL, the user name and password are taken from the configuration properties. The computer name is queried by java runtime functions.

Parameters:

runAs - Run-As user

Returns:

IXConnection

Throws:

byps.RemoteException

getUniqueConnection

IXConnection getUniqueConnection()
                          throws byps.RemoteException,
InterruptedException

Gets the unique internally stored Indexserver connection. Call this function, if the application does only need one connection to the Indexserver. (The IXConnection class is thread-save). This method should not be invoked in a Servlet.init method.

Returns:

IXConnection object

Throws:

byps.RemoteException - thrown on timeout

InterruptedException

See Also:

• initUniqueConnection()

initUniqueConnection

void initUniqueConnection()

Initialize the unique internally stored Indexserver connection. Call this function, if the application does only need one connection to the Indexserver. (The IXConnection class is thread-save). The Indexserver URL, the user name and password are taken from the configuration properties. This method should be invoked in a Servlet.init method. It initializes the connection in a background thread and returns immediately.

See Also:

• AppConnManager.UniqueConnectionInitialized.process(Object[] args)
• getEvents()

getEvents

List<AppEvent> getEvents()

Get the list of events. In order to listen for events, add an object that implements the event interfaces.

Returns:

List

shutdown

void shutdown()