com.sabratec.applinx.baseobject

Class GXCreateSessionRequest

java.lang.Object

com.sabratec.applinx.baseobject.GXAbstractRequest

com.sabratec.applinx.baseobject.GXAbstractSessionConnectionRequest

com.sabratec.applinx.baseobject.GXCreateSessionRequest

All Implemented Interfaces:

Externalizable, Serializable, Cloneable

Direct Known Subclasses:

GXActivatePrinterRequest

public class GXCreateSessionRequest
extends GXAbstractSessionConnectionRequest

This class holds all the parameters needed for the getBaseObject() method of GXClientBaseObjectFactory.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GXCreateSessionRequest()
GXCreateSessionRequest(GXIApplicationServerContext serverContext, String applicationName) Constructor for local connection to ApplinX Server.
GXCreateSessionRequest(String serverURL, String applicationName, String sessionID, String password, String sessionDescription, String hostService) Constructor for all parameters.
GXCreateSessionRequest(String serverURL, String applicationName, String sessionID, String password, String sessionDescription, String hostSessionId, String hostSessionPassword) Constructor for all parameters besides host service.

Method Summary

Modifier and Type	Method and Description
String	getConnectionPool()
String	getHostNewPassword()
String	getHostPassword()
String	getHostService() Deprecated. @see getConnectionPool()
String	getHostUserName()
String	getSessionDescription()
boolean	isFailOnWarning()
void	readExternal(ObjectInput in)
void	setConnectionPool(String pool) /** Set the session to use a predefined connection pool.
void	setFailOnWarning(boolean failOnWarning) Set whether to throw an exception as for error on connection warnings.
void	setHostNewPassword(String pwd) Sets a password that will be used to replace the current host password.
void	setHostPassword(String pwd) Sets a password that will be used to connect to the host.
void	setHostUserName(String id) Sets a user ID that will be used to connect to the host.
void	setSessionDescription(String description) Set the session description.
void	setUseHostService(String serviceName) Deprecated. @see setConnectionPool(String)
void	writeExternal(ObjectOutput out)

Methods inherited from class com.sabratec.applinx.baseobject.GXAbstractSessionConnectionRequest

getApplicationName, getClientId, getServerContext, getServerURL, getSessionID, getSessionPassword, setApplicationName, setClientId, setServerContext, setServerURL, setSessionID, setSessionPassword

Methods inherited from class com.sabratec.applinx.baseobject.GXAbstractRequest

addVariable, addVariable, addVariableArray, clone, equals, getVariables, hashCode, setVariables

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GXCreateSessionRequest

public GXCreateSessionRequest()

GXCreateSessionRequest

public GXCreateSessionRequest(GXIApplicationServerContext serverContext,
                              String applicationName)

Constructor for local connection to ApplinX Server.

Parameters:

serverContext - context of ApplinX server.

applicationName - name of a valid application in ApplinX server (at the given URL).

GXCreateSessionRequest

public GXCreateSessionRequest(String serverURL,
                              String applicationName,
                              String sessionID,
                              String password,
                              String sessionDescription,
                              String hostSessionId,
                              String hostSessionPassword)

Constructor for all parameters besides host service.

Parameters:

serverURL - URL of ApplinX server.

applicationName - name of a valid application in ApplinX server (at the given URL).

sessionID - ID for the session that will be created on ApplinX server.

password - password for the connection between the base object and ApplinX server.

sessionDescription - description string for the session. It will appear in the sessions list in the Administrator.

hostSessionId - host connection username. Relevant for SSH or Natural UNIX hosts.

hostSessionPassword - host connection password. Relevant for SSH or Natural UNIX hosts.

GXCreateSessionRequest

public GXCreateSessionRequest(String serverURL,
                              String applicationName,
                              String sessionID,
                              String password,
                              String sessionDescription,
                              String hostService)

Constructor for all parameters.

Parameters:

serverURL - URL of ApplinX server.

applicationName - name of a valid application in ApplinX server (at the given URL).

sessionID - ID for the session that will be created on ApplinX server.

password - password for the connection between the base object and ApplinX server.

sessionDescription - description string for the session. It will appear in the sessions list in the Administrator.

hostService - connect to a connection from a pool of a host service.

Method Detail

setSessionDescription

public void setSessionDescription(String description)

Set the session description.

Parameters:

description - the desciption of this session

getSessionDescription

public String getSessionDescription()

Returns:

The session description.

setUseHostService

public void setUseHostService(String serviceName)

Deprecated. @see setConnectionPool(String)

Set the session to use a predefined host service.

Parameters:

serviceName - the host service to use

setConnectionPool

public void setConnectionPool(String pool)

/** Set the session to use a predefined connection pool.

Parameters:

pool - the connection pool to use

getHostService

public String getHostService()

Deprecated. @see getConnectionPool()

Returns:

the configured host service of this session. null if no service was defined.

getConnectionPool

public String getConnectionPool()

Returns:

the configured host service of this session. null if no service was defined.

getHostUserName

public String getHostUserName()

Returns:

The user ID configured for the connection to the host that will be created by this request.

See Also:

setHostUserName(String)

getHostPassword

public String getHostPassword()

Returns:

The password configured for the connection to the host that will be created by this request.

See Also:

setHostUserName(String)

getHostNewPassword

public String getHostNewPassword()

Returns:

The password configured for the to replace the current host password.

See Also:

setHostNewPassword(String)

setHostUserName

public void setHostUserName(String id)

Sets a user ID that will be used to connect to the host. Setting host user ID and host user password is relevant only for hosts with SSH or host of type Natural UNIX.

Parameters:

id - The user ID for the connection.

setHostPassword

public void setHostPassword(String pwd)

Sets a password that will be used to connect to the host.

Parameters:

pwd - The password for the connection

See Also:

setHostUserName(String)

setHostNewPassword

public void setHostNewPassword(String pwd)

Sets a password that will be used to replace the current host password.

Parameters:

pwd - The new password

See Also:

setHostUserName(String)

isFailOnWarning

public boolean isFailOnWarning()

Returns:

Whether to throw an exception in case of warnings, as in errors.

setFailOnWarning

public void setFailOnWarning(boolean failOnWarning)

Set whether to throw an exception as for error on connection warnings. For example: if the password is about to expire in a few days.
By default false.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class GXAbstractSessionConnectionRequest

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class GXAbstractSessionConnectionRequest

Throws:

IOException