ch.specchio.client

Interface SPECCHIOServerDescriptor

All Known Implementing Classes:

SPECCHIODatabaseDescriptor, SPECCHIOWebAppDescriptor

public interface SPECCHIOServerDescriptor

This interface must be implemented by all server descriptors.

Method Summary

Methods

Modifier and Type	Method and Description
SPECCHIOClient	createClient() Create a client object suitable for connecting to the server described by this descriptor.
java.lang.String	getDataSourceName() Get a name of the datasource (JNDI).
java.lang.String	getDisplayName(boolean showUser, boolean show_datasource_name) Get the display name of this server.
java.lang.String	getDisplayUser() Get a description of the user account under which we are to log in.
void	setUser(User user) Set the user information associated with this account.

Method Detail

createClient

SPECCHIOClient createClient()
                            throws SPECCHIOClientException

Create a client object suitable for connecting to the server described by this descriptor.

Returns:

a new SPECCHIOClient object

Throws:

SPECCHIOClientException - could not create the client

getDisplayName

java.lang.String getDisplayName(boolean showUser,
                              boolean show_datasource_name)

Get the display name of this server.

Parameters:

showUser - include the user account details in the display?

show_datasource_name - include the JNDI details in the display?

Returns:

a string describing the server, suitable for display to the user

getDisplayUser

java.lang.String getDisplayUser()

Get a description of the user account under which we are to log in.

Returns:

a string describing the user account under which this client is to log in

getDataSourceName

java.lang.String getDataSourceName()

Get a name of the datasource (JNDI).

Returns:

a string holding the name of the datasource (JNDI)

setUser

void setUser(User user)

Set the user information associated with this account.

Parameters:

user - the user information