ch.specchio.client

Class SPECCHIOWebAppDescriptor

java.lang.Object

ch.specchio.client.SPECCHIOWebAppDescriptor

All Implemented Interfaces:

SPECCHIOServerDescriptor

public class SPECCHIOWebAppDescriptor
extends java.lang.Object
implements SPECCHIOServerDescriptor

This class encapsulates all of the information necessary to connect to a SPECCHIO web application server.

Constructor Summary

Constructors

Constructor and Description
SPECCHIOWebAppDescriptor(java.lang.String[] tokens) Constructor for SPECCHIOClientFactory.process_line().
SPECCHIOWebAppDescriptor(java.lang.String protocol, java.lang.String server, int port, java.lang.String path, java.lang.String dataSourceName, java.lang.Boolean default_trust_store) Construct an anonymous descriptor.
SPECCHIOWebAppDescriptor(java.lang.String protocol, java.lang.String server, int port, java.lang.String path, java.lang.String user, java.lang.String password, java.lang.String dataSourceName, boolean uses_default_trust_store, java.lang.String preferenceNodeName) Constructor.

Method Summary

Modifier and Type	Method and Description
SPECCHIOClient	createClient() Create a web client that can connect to the server represented by this descriptor.
java.lang.String	getAccountConfigurationString() Get the string describing the account configuration for db_config.txt
java.lang.String	getDataSourceName() Get the current data source name.
java.lang.String	getDisplayName(boolean showUser, boolean show_datasource_name) Get the display name of this server.
java.lang.String	getDisplayUser() Get the user name.
int	getList_index() index at which this descriptor is found in the list of known connections
java.lang.String	getPassword() Get the password.
java.lang.String	getPath() Get the application path.
int	getPort() Get the port number.
java.lang.String	getPreferenceNodeName() Get the node name in preferences or line number in legacy file
java.lang.String	getProtocol() Get the protocol used to connect to the server.
java.lang.String	getServer() Get the web application server name.
java.net.URL	getUrl() Get the URL of the application server.
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	setPreferenceNodeName(java.lang.String preferenceNodeName)
void	setUser(User user) Set the user information associated with this account.
java.lang.String	toString() Get a string representation of the server.
java.lang.Boolean	usesDefaultTrustStore() Defines if this connection relies on the default JVM trust store

Methods inherited from class java.lang.Object

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

Constructor Detail

SPECCHIOWebAppDescriptor

public SPECCHIOWebAppDescriptor(java.lang.String protocol,
                                java.lang.String server,
                                int port,
                                java.lang.String path,
                                java.lang.String user,
                                java.lang.String password,
                                java.lang.String dataSourceName,
                                boolean uses_default_trust_store,
                                java.lang.String preferenceNodeName)

Constructor.

Parameters:

protocol - "http" or "https"

server - the server host name

path - the path to the web application

port - the port number

user - the username

password - the password

default_trust_store -

SPECCHIOWebAppDescriptor

public SPECCHIOWebAppDescriptor(java.lang.String protocol,
                                java.lang.String server,
                                int port,
                                java.lang.String path,
                                java.lang.String dataSourceName,
                                java.lang.Boolean default_trust_store)

Construct an anonymous descriptor.

Parameters:

protocol - "http" or "https"

server - the server host name

path - the path to the web application

port - the port number

boolean -

SPECCHIOWebAppDescriptor

public SPECCHIOWebAppDescriptor(java.lang.String[] tokens)
                         throws SPECCHIOWebClientException

Constructor for SPECCHIOClientFactory.process_line().

Parameters:

tokens - the array of strings read from the input file

Throws:

SPECCHIOWebClientException - the tokens are not correctly formatted

Method Detail

createClient

public SPECCHIOClient createClient()
                            throws SPECCHIOClientException

Create a web client that can connect to the server represented by this descriptor.

Specified by:

createClient in interface SPECCHIOServerDescriptor

Returns:

a new SPECCHIOWebClient object

Throws:

SPECCHIOClientException - could not create the client

getAccountConfigurationString

public java.lang.String getAccountConfigurationString()

Get the string describing the account configuration for db_config.txt

getDataSourceName

public java.lang.String getDataSourceName()

Get the current data source name.

Specified by:

getDataSourceName in interface SPECCHIOServerDescriptor

Returns:

a string holding the name of the datasource (JNDI)

getDisplayName

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

Get the display name of this server.

Specified by:

getDisplayName in interface SPECCHIOServerDescriptor

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

getPassword

public java.lang.String getPassword()

Get the password.

Returns:

the password

getPath

public java.lang.String getPath()

Get the application path.

Returns:

the application path

getPort

public int getPort()

Get the port number.

Returns:

the port number

getProtocol

public java.lang.String getProtocol()

Get the protocol used to connect to the server.

Returns:

"http" or "https"

getServer

public java.lang.String getServer()

Get the web application server name.

Returns:

the web application server name

getUrl

public java.net.URL getUrl()

Get the URL of the application server.

getDisplayUser

public java.lang.String getDisplayUser()

Get the user name.

Specified by:

getDisplayUser in interface SPECCHIOServerDescriptor

Returns:

the user name

setUser

public void setUser(User user)

Set the user information associated with this account.

Specified by:

setUser in interface SPECCHIOServerDescriptor

Parameters:

user - the user information

toString

public java.lang.String toString()

Get a string representation of the server.

Overrides:

toString in class java.lang.Object

getPreferenceNodeName

public java.lang.String getPreferenceNodeName()

Description copied from interface: SPECCHIOServerDescriptor

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

Specified by:

getPreferenceNodeName in interface SPECCHIOServerDescriptor

Returns:

a string with the name or line number

setPreferenceNodeName

public void setPreferenceNodeName(java.lang.String preferenceNodeName)

usesDefaultTrustStore

public java.lang.Boolean usesDefaultTrustStore()

Description copied from interface: SPECCHIOServerDescriptor

Defines if this connection relies on the default JVM trust store

Specified by:

usesDefaultTrustStore in interface SPECCHIOServerDescriptor

Returns:

true is default trust store is used

isEncrypted

public java.lang.Boolean isEncrypted()

Description copied from interface: SPECCHIOServerDescriptor

Defines if this connection is encrypted

Specified by:

isEncrypted in interface SPECCHIOServerDescriptor

Returns:

true if this is a HTTPS connection

getList_index

public int getList_index()

Description copied from interface: SPECCHIOServerDescriptor

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

Specified by:

getList_index in interface SPECCHIOServerDescriptor

Returns:

index if known, otherwise -1

setList_index

public void setList_index(int list_index)

Description copied from interface: SPECCHIOServerDescriptor

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

Specified by:

setList_index in interface SPECCHIOServerDescriptor