com.attachmate.vhi.resource.client
Class ConnectionSpecImpl

java.lang.Object
  extended by com.attachmate.vhi.resource.client.ConnectionSpecImpl
All Implemented Interfaces:
java.io.Serializable, javax.resource.cci.ConnectionSpec

public class ConnectionSpecImpl
extends java.lang.Object
implements javax.resource.cci.ConnectionSpec, java.io.Serializable

Specifies a component-managed connection to VHI Session Server.

Values for username, password and resourceName properties override deployed or configured values for the RA if they are not null and not zero-length strings (the default). Similarly, model variable map entries override configured settings only if present in this model variable map. In this way, clients need only set the properties that they are interested in changing for a component-managed connection.

Author:
KarlUp
See Also:
Serialized Form

Constructor Summary
ConnectionSpecImpl()
          Creates a new instance of ConnectionSpecImpl with default settings.
 
Method Summary
 java.lang.String getConnectionToken()
          Key for resuming a passivated session - defaults to empty string.
 java.lang.String getExpectedEntity()
          Name of the expected entity for activating a session - defaults to empty string.
 java.util.Map getModelVariables()
          Model variables property - defaults to empty map.
 java.lang.String getPassword()
          Password property - defaults to empty string.
 java.lang.String getUserName()
          User name property - defaults to empty string.
 void setConnectionToken(java.lang.String connectionToken)
          Key for resuming a passivated session - defaults to empty string.
 void setExpectedEntity(java.lang.String expectedEntity)
          Name of the expected entity for activating a session - defaults to empty string.
 void setModelVariables(java.util.Map modelVariables)
          Model variables property - defaults to empty map.
 void setPassword(java.lang.String password)
          Password property - defaults to empty string.
 void setUserName(java.lang.String userName)
          User name property - defaults to empty string.
 java.lang.String toString()
          Returns a representation of the object as a string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConnectionSpecImpl

public ConnectionSpecImpl()
Creates a new instance of ConnectionSpecImpl with default settings.

Method Detail

setUserName

public void setUserName(java.lang.String userName)
User name property - defaults to empty string.

Parameters:
userName - for custom login.

getUserName

public java.lang.String getUserName()
User name property - defaults to empty string.

Returns:
user name for custom login.

setPassword

public void setPassword(java.lang.String password)
Password property - defaults to empty string.

Parameters:
password - for custom login.

getPassword

public java.lang.String getPassword()
Password property - defaults to empty string.

Returns:
password for custom login.

setConnectionToken

public void setConnectionToken(java.lang.String connectionToken)
Key for resuming a passivated session - defaults to empty string. Returned by system procedure vhi.sp_passivate for stateful EJB support.

Parameters:
connectionToken - key for resuming a passivated session.

getConnectionToken

public java.lang.String getConnectionToken()
Key for resuming a passivated session - defaults to empty string. Returned by system procedure vhi.sp_passivate for stateful EJB support.

Returns:
key for resuming a passivated session.

setExpectedEntity

public void setExpectedEntity(java.lang.String expectedEntity)
Name of the expected entity for activating a session - defaults to empty string. Returned by system procedure vhi.sp_passivate for stateful EJB support.

Parameters:
expectedEntity - the name of the screen a passivated connection should be on when activated.

getExpectedEntity

public java.lang.String getExpectedEntity()
Name of the expected entity for activating a session - defaults to empty string. Returned by system procedure vhi.sp_passivate for stateful EJB support.

Returns:
the name of the screen a passivated connection should be on when activated.

setModelVariables

public void setModelVariables(java.util.Map modelVariables)
Model variables property - defaults to empty map.

Parameters:
modelVariables - for custom login.

getModelVariables

public java.util.Map getModelVariables()
Model variables property - defaults to empty map.

Returns:
model variables for custom login.

toString

public java.lang.String toString()
Returns a representation of the object as a string.

Overrides:
toString in class java.lang.Object
Returns:
a representation of the object as a string.


Copyright © 2008 Attachmate Corporation. All Rights Reserved.