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

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.
int	getList_index() index at which this descriptor is found in the list of known connections
java.lang.String	getPreferenceNodeName() Get the node name in preferences or line number in legacy file
java.lang.Boolean	isEncrypted() Defines if this connection is encrypted
void	setList_index(int list_index) set index at which this descriptor is found in the list of known connections
void	setUser(User user) Set the user information associated with this account.
java.lang.Boolean	usesDefaultTrustStore() Defines if this connection relies on the default JVM trust store

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

getPreferenceNodeName

java.lang.String getPreferenceNodeName()

Get the node name in preferences or line number in legacy file

Returns:

a string with the name or line number

usesDefaultTrustStore

java.lang.Boolean usesDefaultTrustStore()

Defines if this connection relies on the default JVM trust store

Returns:

true is default trust store is used

isEncrypted

java.lang.Boolean isEncrypted()

Defines if this connection is encrypted

Returns:

true if this is a HTTPS connection

getList_index

int getList_index()

index at which this descriptor is found in the list of known connections

Returns:

index if known, otherwise -1

setList_index

void setList_index(int list_index)

set index at which this descriptor is found in the list of known connections