com.aspc.remote.soap

Class Client

java.lang.Object

com.aspc.remote.soap.Client

All Implemented Interfaces:

Executor

Direct Known Subclasses:

SwitchableClient

public class Client
extends java.lang.Object
implements Executor

Remote client allows remote data access to the server.
THREAD MODE: SINGLE-THREADED a client may only be accessed by one thread at a time.

Since:

29 November 2003

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BY_PASS_LOGIN Static field for login bypass value
static java.lang.String	BY_PASS_TRAFFIC Static field for traffic bypass value
static java.lang.String	VERSION The current version of the soap client

Constructor Summary

Constructors

Constructor and Description
Client(SoapTransport transport) Create a new SOAP client
Client(java.lang.String host) Create a new SOAP client

Method Summary

Modifier and Type	Method and Description
void	addDiscoverTransport(java.lang.String transportUrl, java.lang.String userId, java.lang.String password) Add an additional transport.
void	addMoveToUrlTransport(java.util.List transportUrl, java.lang.String userId, java.lang.String password) Add move to URL transport.
protected void	addSessionHeader(org.w3c.dom.Document envelope) Add the session header.
void	addTransport(SoapTransport transport) add an additional transport
java.lang.String	checkInFile(java.lang.String fileName, java.io.File file) Checks in a file
java.lang.String	checkInFile(java.lang.String fileName, java.io.File file, java.lang.String location) Checks in a file
java.io.File	checkOutFile(java.lang.String fileName) gets and locks a file from the server.
java.io.File	checkOutFile(java.lang.String fileName, java.lang.String location) Gets and locks a file from the server
org.w3c.dom.Document	createEnvelope() <?xml version="1.0" encoding="UTF-8"?< <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"< <soapenv:Header< <SessionInfo soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns=""< <SESSION_SIGNATURE xmlns=""<self_test</SESSION_SIGNATURE< <SESSION_TZ xmlns=""<Australia/Sydney</SESSION_TZ< </SessionInfo< </soapenv:Header< <soapenv:Body< <execute xmlns=""< <sql<DISCOVER SSO</sql< </execute< <messageID xmlns=""<1</messageID< </soapenv:Body< </soapenv:Envelope<
SoapTransport	currentTransport() Which transport are we using ?
org.w3c.dom.Document	execute(java.lang.String sql) Execute a SQL statement.
org.w3c.dom.Document	farm(java.lang.String sql) execute the commands on a
SoapResultSet	fetch(java.lang.String sql) fetch a SQL statement as a record set.
java.lang.String	getCacheDiretcory() The cache directory is used by the file fetch operations.
java.lang.String	getHost() The current host.
java.lang.String	getLayer() The database layer to connect to.
protected org.w3c.dom.Document	getResult(org.w3c.dom.Document doc, java.lang.String tag) Convert a XML document into a record set.
java.lang.String	getSessionID() Returns session ID.
java.util.TimeZone	getTimeZone() The timezone of this executor
int	getTransportCount() The number of transports avaliable.
java.lang.String	getUserName() The login to connect with
protected void	handleFault(java.lang.String code, java.lang.String reason) Handle a fault.
boolean	isStateless() Is the client currently stateless ?
boolean	isUrlByPassEnabled() Returns the flag if the URL by-pass is set or not.
void	login() Login using the defaults
void	login(java.lang.String login, java.lang.String password, java.lang.String layer) Login using the values passed.
void	login(java.lang.String login, java.lang.String password, java.lang.String layer, LoginContext loginContext) Login using the defaults.
void	logout() Logout.
SoapTransport	nextTransport() Move to the next transport
java.io.File	readFile(java.lang.String fileName) gets a file from the server for READ access.
java.io.File	readFile(java.lang.String fileName, java.lang.String location) Gets a file from the server for READ access, using the specified location
org.w3c.dom.Document	sendEnvelope(org.w3c.dom.Document envelope, java.lang.String relativePath) send the envelope.
void	setByPassDiscover(boolean flag) by pass the discover phase
void	setCacheDirectory(java.lang.String path) Sets the cache directory to be used during fetch operations.
void	setLayer(java.lang.String layer) set the layer
void	setTimeZone(java.util.TimeZone tz) set the time zone
java.lang.String	toString() Return details of this client
void	updateFile(java.lang.String fileKey, java.io.File newVersion) Updates a file with a new version
void	updateFile(java.lang.String fileKey, java.io.File newVersion, java.lang.String location) Updates a file with a new version

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

The current version of the soap client

See Also:

Constant Field Values

BY_PASS_TRAFFIC

public static final java.lang.String BY_PASS_TRAFFIC

Static field for traffic bypass value

See Also:

Constant Field Values

BY_PASS_LOGIN

public static final java.lang.String BY_PASS_LOGIN

Static field for login bypass value

See Also:

Constant Field Values

Constructor Detail

Client

public Client(java.lang.String host)

Create a new SOAP client

Parameters:

host - The URL or list of URLs

Client

public Client(SoapTransport transport)

Create a new SOAP client

Parameters:

transport - The internal transport

Method Detail

setByPassDiscover

public void setByPassDiscover(boolean flag)

by pass the discover phase

Parameters:

flag - true if we should not call DISCOVER

addTransport

public final void addTransport(SoapTransport transport)

add an additional transport

Parameters:

transport - The additional transport

currentTransport

public SoapTransport currentTransport()

Which transport are we using ?

Returns:

The current transport.

nextTransport

public SoapTransport nextTransport()

Move to the next transport

Returns:

The next transport

getTransportCount

public int getTransportCount()

The number of transports avaliable.

Returns:

The total number of transports.

getHost

public java.lang.String getHost()

The current host.

Returns:

The host URI

getLayer

public java.lang.String getLayer()

The database layer to connect to.

Returns:

The database layer

getTimeZone

public java.util.TimeZone getTimeZone()

The timezone of this executor

Specified by:

getTimeZone in interface Executor

Returns:

the timezone.

getUserName

public java.lang.String getUserName()

The login to connect with

Specified by:

getUserName in interface Executor

Returns:

The database layer

login

public void login()
           throws java.lang.Exception

Login using the defaults

Throws:

java.lang.Exception - Failed to login.

login

public void login(java.lang.String login,
                  java.lang.String password,
                  java.lang.String layer,
                  LoginContext loginContext)
           throws java.lang.Exception

Login using the defaults.

Parameters:

login - The user id

password - The password.

layer - The layer to login to.

loginContext - The context.

Throws:

java.lang.Exception - Failed to login.

login

public void login(java.lang.String login,
                  java.lang.String password,
                  java.lang.String layer)
           throws java.lang.Exception

Login using the values passed.

Parameters:

login - The user id

password - The password.

layer - The layer to login to.

Throws:

java.lang.Exception - Failed to login.

logout

public void logout()
            throws java.lang.Exception

Logout.

Throws:

java.lang.Exception - A serious problem

isStateless

public boolean isStateless()

Is the client currently stateless ?

Specified by:

isStateless in interface Executor

Returns:

true if stateless.

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Return details of this client

Overrides:

toString in class java.lang.Object

Returns:

the client details

updateFile

public void updateFile(java.lang.String fileKey,
                       java.io.File newVersion)
                throws java.lang.Exception

Updates a file with a new version

Parameters:

fileKey - the global key of the file

newVersion - the new version of the file

Throws:

java.lang.Exception - update failure

updateFile

public void updateFile(java.lang.String fileKey,
                       java.io.File newVersion,
                       java.lang.String location)
                throws java.lang.Exception

Updates a file with a new version

Parameters:

fileKey - the global key of the file

newVersion - the new version of the file

location - the location to update

Throws:

java.lang.Exception - update failure

checkInFile

public java.lang.String checkInFile(java.lang.String fileName,
                                    java.io.File file)
                             throws java.lang.Exception

Checks in a file

Parameters:

fileName - the name of the file

file - the file to check in

Returns:

String the file key

Throws:

java.lang.Exception - check in failure

checkInFile

public java.lang.String checkInFile(java.lang.String fileName,
                                    java.io.File file,
                                    java.lang.String location)
                             throws java.lang.Exception

Checks in a file

Parameters:

fileName - the name of the file

file - the file to check in

location - the location to create the file on

Returns:

String the file key

Throws:

java.lang.Exception - check in failure

checkOutFile

public java.io.File checkOutFile(java.lang.String fileName)
                          throws java.lang.Exception

gets and locks a file from the server.

Parameters:

fileName - The actual file to check out.

Returns:

The file.

Throws:

java.lang.Exception - A serious problem

checkOutFile

public java.io.File checkOutFile(java.lang.String fileName,
                                 java.lang.String location)
                          throws java.lang.Exception

Gets and locks a file from the server

Parameters:

fileName - the name of the file to checkout

location - the location to get the file from

Returns:

File the file

Throws:

java.lang.Exception - failure to get file or lock

readFile

public java.io.File readFile(java.lang.String fileName)
                      throws java.lang.Exception

gets a file from the server for READ access.

Parameters:

fileName - The actual file name

Returns:

The raw file.

Throws:

java.lang.Exception - A serious problem

readFile

public java.io.File readFile(java.lang.String fileName,
                             java.lang.String location)
                      throws java.lang.Exception

Gets a file from the server for READ access, using the specified location

Parameters:

fileName - the name of the file to get

location - the location to get the file from

Returns:

File the file

Throws:

java.lang.Exception - a failure to get the file

fetch

public SoapResultSet fetch(java.lang.String sql)
                    throws java.lang.Exception

fetch a SQL statement as a record set.

Specified by:

fetch in interface Executor

Parameters:

sql - The SQL to execute

Returns:

The record set

Throws:

java.lang.Exception - A serious problem

farm

public org.w3c.dom.Document farm(java.lang.String sql)
                          throws java.lang.Exception

execute the commands on a

Parameters:

sql - the commands

Returns:

the result document.

Throws:

java.lang.Exception - a serious problem

execute

public org.w3c.dom.Document execute(java.lang.String sql)
                             throws java.lang.Exception

Execute a SQL statement.
if an error occurs and we have multiple connections check that the current server is OK by sending a very simple command. If that fails then we will declare the server dead and move onto the next server. If we aren't currently in state and the simplest of commands have failed then we will retry the command without notifying the user

This is a SINGLE THREADED class but... as people are accidently calling it from multiple threads we should protect ourselves by adding a synchronized.

Specified by:

execute in interface Executor

Parameters:

sql - The SQL/XML statement

Returns:

The XML result document

Throws:

java.lang.Exception - A serious problem

createEnvelope

public org.w3c.dom.Document createEnvelope()
                                    throws java.lang.Exception

<?xml version="1.0" encoding="UTF-8"?< <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"< <soapenv:Header< <SessionInfo soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns=""< <SESSION_SIGNATURE xmlns=""<self_test</SESSION_SIGNATURE< <SESSION_TZ xmlns=""<Australia/Sydney</SESSION_TZ< </SessionInfo< </soapenv:Header< <soapenv:Body< <execute xmlns=""< <sql<DISCOVER SSO</sql< </execute< <messageID xmlns=""<1</messageID< </soapenv:Body< </soapenv:Envelope<

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

addSessionHeader

protected final void addSessionHeader(org.w3c.dom.Document envelope)
                               throws java.lang.Exception

Add the session header. <?xml version="1.0" encoding="UTF-8"?< <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"< <soapenv:Header< <SessionInfo soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns=""< <SESSION_SIGNATURE xmlns=""<self_test</SESSION_SIGNATURE< <SESSION_TZ xmlns=""<Australia/Sydney</SESSION_TZ< </SessionInfo< </soapenv:Header< <soapenv:Body< <execute xmlns=""< <sql<DISCOVER SSO</sql< </execute< <messageID xmlns=""<1</messageID< </soapenv:Body< </soapenv:Envelope<

Parameters:

envelope - The envelope to add the session header to.

Throws:

java.lang.Exception - A serious problem

getResult

protected org.w3c.dom.Document getResult(org.w3c.dom.Document doc,
                                         java.lang.String tag)
                                  throws java.lang.Exception

Convert a XML document into a record set.

Parameters:

doc - The XML document

tag - The tag to fetch

Returns:

The result set

Throws:

java.lang.Exception - A serious problem

handleFault

protected void handleFault(java.lang.String code,
                           java.lang.String reason)
                    throws java.lang.Exception

Handle a fault.

Parameters:

code - The code

reason - The reason

Throws:

java.lang.Exception - A serious problem

sendEnvelope

public final org.w3c.dom.Document sendEnvelope(org.w3c.dom.Document envelope,
                                               java.lang.String relativePath)
                                        throws java.lang.Exception

send the envelope. <?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Header> <SessionInfo soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns=""> <SESSION_SIGNATURE xmlns="">self_test</SESSION_SIGNATURE> <SESSION_TZ xmlns="">Australia/Sydney</SESSION_TZ> </SessionInfo> </soapenv:Header> <soapenv:Body> <execute xmlns=""> <sql>DISCOVER SSO</sql> </execute> <messageID xmlns="">1</messageID> </soapenv:Body> </soapenv:Envelope>

Parameters:

envelope - The envelope

relativePath - The path to send it to

Returns:

The XML document.

Throws:

java.lang.Exception - A serious problem

getSessionID

public java.lang.String getSessionID()

Returns session ID.

Returns:

session ID

getCacheDiretcory

public java.lang.String getCacheDiretcory()

The cache directory is used by the file fetch operations. If this is not set the client will use the default cache directory.

Returns:

String the cache directory, null if not set

setCacheDirectory

public void setCacheDirectory(java.lang.String path)

Sets the cache directory to be used during fetch operations. Setting the cache directory to null will cause the client to use the default system cache directory.

Parameters:

path - the path of the cache directory, can be null

addDiscoverTransport

public final void addDiscoverTransport(java.lang.String transportUrl,
                                       java.lang.String userId,
                                       java.lang.String password)

Add an additional transport. This is an extension for SSL project.

Parameters:

transportUrl - The additional transport

userId - user id

password - password

addMoveToUrlTransport

public final void addMoveToUrlTransport(java.util.List transportUrl,
                                        java.lang.String userId,
                                        java.lang.String password)

Add move to URL transport.

Parameters:

transportUrl - URL

userId - user id

password - password

setLayer

public void setLayer(java.lang.String layer)

set the layer

Parameters:

layer - the signature

setTimeZone

public void setTimeZone(java.util.TimeZone tz)

set the time zone

Parameters:

tz - the time zone

isUrlByPassEnabled

public boolean isUrlByPassEnabled()

Returns the flag if the URL by-pass is set or not.

Returns:

True if enabled.