VistaLinkManagedConnection (gov.va.med.vistalink

Object
- VistaLinkManagedConnection

All Implemented Interfaces:

ManagedConnection
```
public class VistaLinkManagedConnection
extends Object
implements ManagedConnection
```
This class represents a managed connection to M

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`VistaLinkManagedConnection(VistaLinkManagedConnectionFactory mcf, long distinguishedIdentifier)` Constructs this instance of the managed connection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConnectionEventListener(ConnectionEventListener listener)` Adds a connection event listener to the event notifier for this managed connection
`void`	`associateConnection(Object connection)` Used by the container to change the association of an application-level connection handle with a ManagedConnection instance.
`void`	`cleanup()` Application server calls this method to force any cleanup on the ManagedConnection instance.
`void`	`closeHandle(VistaLinkConnection con)` Closes the associated connection handle.
`void`	`destroy()` Destroys the physical socket connection to M.
`void`	`disassociateConnection(VistaLinkConnectionImpl con)` Disassociates this instance of VistaLinkManagedConnection from the VistaLinkConnection handle
`boolean`	`equals(Object obj)` This implementation has changed for app server see hashCode->toString
`VistaLinkResponseVO`	`executeInteraction(VistaLinkRequestVO requestVO, VistaLinkResponseFactory responseFactory)` Executes an interaction with M and returns a response constructed by the specified response factory
`RpcResponse`	`executeRPC(RpcRequest request)` Executes an interaction with the RpcResponseFactory
`protected VistaLinkSystemInfoResponse`	`executeSystemInfoInteraction()`
`VistaLinkResponseVO`	`executeSystemInteraction(VistaLinkRequestVO requestVO)` Executes an interaction and returns a response from the default response factory.
`String`	`getAccessCode()`
`protected EMAdapterEnvironment`	`getAdapterEnvironment()`
`Object`	`getConnection(Subject subject, ConnectionRequestInfo connReqInfo)` Creates a new connection handle for this ManagedConnection instance.
`ConnectionMetaData`	`getConnectionMetaData()` Delegated from VistaLinkConnection class to return connection oriented metadata
`VistaLinkConnectionRequestInfo`	`getConnReqInfo()`
`String`	`getConnReqInfoString()`
`protected long`	`getHeartBeatRate()`
`InetAddress`	`getHostAddr()` Returns the hostAddr.
`int`	`getHostPort()` Returns the hostPort.
`long`	`getLastInteractionTimeMillis()`
`protected long`	`getLastTimeRpcExecutedMillis()`
`LocalTransaction`	`getLocalTransaction()` This method is not supported and will throw a NotSupportedException
`PrintWriter`	`getLogWriter()`
`protected VistaLinkManagedConnectionFactory`	`getManagedConnectionFactory()`
`int`	`getMaxConnectionHandles()` Returns the maxConnectionHandles.
`ManagedConnectionMetaData`	`getMetaData()` Returns information about this managed connection
`protected String`	`getMJob()`
`protected long`	`getReAuthSessionTimeout()`
`protected EMReAuthState`	`getReAuthState()`
`protected VistaSocketConnection`	`getSocketConnection()` Returns the socketCon for this managed connection
`protected long`	`getSocketTimeOut()`
`String`	`getVerifyCode()`
`XAResource`	`getXAResource()` Returns distributed transaction resource, not supported
`int`	`hashCode()` return cached hashcode
`protected boolean`	`isConnectionHandleAvailable()` Returns true if number of Connection Handles of this instance of the VistaLinkManagedCoonection is less than the Max number allotted
`boolean`	`isValid()`
`void`	`notifyErrorOccurred(Exception e)` Notifies event listeners(Application server) that an error has occurred on this managed connection instance.
`void`	`removeConnectionEventListener(ConnectionEventListener listener)` Removes a connection event listener from the event notifier for this managed connection
`void`	`setLastInteractionTimeMillis(long lastinteractiontimemillis)` Sets the last interaction time in milliseconds.
`void`	`setLogWriter(PrintWriter wr)`
`protected void`	`setMJob(String mJob)`
`protected void`	`setReAuthSessionTimeout(long reAuthSessionTimeout)`
`protected void`	`setReAuthState(EMReAuthState reAuthState)`
`void`	`setSocketTimeOut(long socketTimeOut)` Sets the socket timeout to the value of parameter.
`void`	`setValid(boolean valid)` Sets the indicator on whether this managed connectioin is a valid connection to an M server.
`String`	`toString()`

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VistaLinkManagedConnection
```
protected VistaLinkManagedConnection(VistaLinkManagedConnectionFactory mcf,
                                     long distinguishedIdentifier)
                              throws VistaLinkResourceException
```
    Constructs this instance of the managed connection. Creates a new raw socket connection with timeout. Adds this managed connection to the Heart beat timer. Sets the socketTimeout property.
    
    Parameters:
    
    mcf - - the managed connection factory that created this managed connection
    
    Throws:
    
    VistaLinkResourceException
- Method Detail
  - addConnectionEventListener
```
public void addConnectionEventListener(ConnectionEventListener listener)
```
    Adds a connection event listener to the event notifier for this managed connection
    
    Specified by:
    
    addConnectionEventListener in interface ManagedConnection
    
    Parameters:
    
    listener - - the ConnectionEventListener to add
    
    See Also:
    
    ManagedConnection.addConnectionEventListener(javax.resource.spi.ConnectionEventListener)
  - removeConnectionEventListener
```
public void removeConnectionEventListener(ConnectionEventListener listener)
```
    Removes a connection event listener from the event notifier for this managed connection
    
    Specified by:
    
    removeConnectionEventListener in interface ManagedConnection
    
    Parameters:
    
    listener - - the ConnectionEventListener to remove
    
    See Also:
    
    ManagedConnection.removeConnectionEventListener(javax.resource.spi.ConnectionEventListener)
  - isConnectionHandleAvailable
```
protected boolean isConnectionHandleAvailable()
```
    Returns true if number of Connection Handles of this instance of the VistaLinkManagedCoonection is less than the Max number allotted
    
    Returns:
    
    boolean
  - associateConnection
```
public void associateConnection(Object connection)
                         throws ResourceException
```
    Used by the container to change the association of an application-level connection handle with a ManagedConnection instance. The container should find the right ManagedConnection instance and call the associateConnection method.
    
    Specified by:
    
    associateConnection in interface ManagedConnection
    
    Parameters:
    
    connection - Application-level connection handle
    
    Throws:
    
    ResourceException
    
    See Also:
    
    ManagedConnection.associateConnection(java.lang.Object)
  - disassociateConnection
```
public void disassociateConnection(VistaLinkConnectionImpl con)
```
    Disassociates this instance of VistaLinkManagedConnection from the VistaLinkConnection handle
    
    Parameters:
    
    con -
  - cleanup
```
public void cleanup()
             throws ResourceException
```
    Application server calls this method to force any cleanup on the ManagedConnection instance. This method is usually called by the container after CONNECTION_CLOSED event is fired.
    ManagedConnection should be cleaned-up to the initial state that is was before getConnection() was called on this object and be ready to be returned to the connection pool.
    
    Specified by:
    
    cleanup in interface ManagedConnection
    
    Throws:
    
    ResourceException
    
    See Also:
    
    ManagedConnection.cleanup()
  - destroy
```
public final void destroy()
                   throws ResourceException
```
    Destroys the physical socket connection to M. Application server calls this method either in case of shrinking the pool size or if exception occurs that is reported to the application server by firing an exception event.
    
    Specified by:
    
    destroy in interface ManagedConnection
    
    Throws:
    
    VistaLinkResourceException
    
    ResourceException
    
    See Also:
    
    ManagedConnection.destroy()
  - closeHandle
```
public void closeHandle(VistaLinkConnection con)
                 throws ResourceException
```
    Closes the associated connection handle. Should not perform any cleanup on the managedConnection system resources.
    
    Parameters:
    
    con -
    
    Throws:
    
    ResourceException
  - getConnection
```
public Object getConnection(Subject subject,
                            ConnectionRequestInfo connReqInfo)
                     throws ConnectionHandlesExceededException,
                            ResourceException
```
    Creates a new connection handle for this ManagedConnection instance.
    
    Specified by:
    
    getConnection in interface ManagedConnection
    
    Parameters:
    
    subject - security context as JAAS subject
    
    connReqInfo - ConnectionRequestInfo instance
    
    Returns:
    
    VistaLinkConnection Object instance representing the connection handle
    
    Throws:
    
    VistaLinkResourceException
    
    ConnectionHandlesExceededException - thrown if there are no more allowable connection handles
    
    ResourceException
    
    See Also:
    
    ManagedConnection.getConnection(javax.security.auth.Subject, javax.resource.spi.ConnectionRequestInfo)
  - getLocalTransaction
```
public LocalTransaction getLocalTransaction()
                                     throws ResourceException
```
    This method is not supported and will throw a NotSupportedException
    
    Specified by:
    
    getLocalTransaction in interface ManagedConnection
    
    Throws:
    
    ResourceException
    
    See Also:
    
    ManagedConnection.getLocalTransaction()
  - getMetaData
```
public ManagedConnectionMetaData getMetaData()
                                      throws ResourceException
```
    Returns information about this managed connection
    
    Specified by:
    
    getMetaData in interface ManagedConnection
    
    Throws:
    
    ResourceException
    
    See Also:
    
    ManagedConnection.getMetaData()
  - getConnectionMetaData
```
public ConnectionMetaData getConnectionMetaData()
                                         throws ResourceException
```
    Delegated from VistaLinkConnection class to return connection oriented metadata
    
    Returns:
    
    ConnectionMetaData
    
    Throws:
    
    ResourceException
  - getXAResource
```
public XAResource getXAResource()
                         throws ResourceException
```
    Returns distributed transaction resource, not supported
    
    Specified by:
    
    getXAResource in interface ManagedConnection
    
    Throws:
    
    ResourceException
    
    See Also:
    
    ManagedConnection.getXAResource()
  - getManagedConnectionFactory
```
protected final VistaLinkManagedConnectionFactory getManagedConnectionFactory()
```
    Returns:
    
    VistaLinkManagedConnectionFactory
  - setLogWriter
```
public void setLogWriter(PrintWriter wr)
                  throws ResourceException
```
    Specified by:
    
    setLogWriter in interface ManagedConnection
    
    Throws:
    
    ResourceException
    
    See Also:
    
    ManagedConnection.setLogWriter(java.io.PrintWriter)
  - getLogWriter
```
public PrintWriter getLogWriter()
                         throws ResourceException
```
    Specified by:
    
    getLogWriter in interface ManagedConnection
    
    Throws:
    
    ResourceException
    
    See Also:
    
    ManagedConnection.getLogWriter()
  - getMaxConnectionHandles
```
public final int getMaxConnectionHandles()
```
    Returns the maxConnectionHandles.
    
    Returns:
    
    int
  - getHostAddr
```
public final InetAddress getHostAddr()
```
    Returns the hostAddr.
    
    Returns:
    
    InetAddress
  - getHostPort
```
public final int getHostPort()
```
    Returns the hostPort.
    
    Returns:
    
    int
  - executeRPC
```
public RpcResponse executeRPC(RpcRequest request)
                       throws VistaLinkFaultException,
                              FoundationsException
```
    Executes an interaction with the RpcResponseFactory
    
    Parameters:
    
    request -
    
    Returns:
    
    RpcResponse
    
    Throws:
    
    VistaLinkFaultException
    
    FoundationsException
  - executeInteraction
```
public final VistaLinkResponseVO executeInteraction(VistaLinkRequestVO requestVO,
                                                    VistaLinkResponseFactory responseFactory)
                                             throws VistaLinkFaultException,
                                                    FoundationsException
```
    Executes an interaction with M and returns a response constructed by the specified response factory
    
    Parameters:
    
    requestVO -
    
    responseFactory -
    
    Returns:
    
    VistaLinkResponseVO
    
    Throws:
    
    VistaLinkFaultException
    
    FoundationsException
  - executeSystemInteraction
```
public VistaLinkResponseVO executeSystemInteraction(VistaLinkRequestVO requestVO)
                                             throws VistaLinkFaultException,
                                                    FoundationsException
```
    Executes an interaction and returns a response from the default response factory.
    
    Parameters:
    
    requestVO -
    
    Returns:
    
    VistaLinkResponseVO
    
    Throws:
    
    VistaLinkFaultException
    
    FoundationsException
  - executeSystemInfoInteraction
```
protected VistaLinkSystemInfoResponse executeSystemInfoInteraction()
                                                            throws FoundationsException
```
    Throws:
    
    FoundationsException
  - notifyErrorOccurred
```
public final void notifyErrorOccurred(Exception e)
```
    Notifies event listeners(Application server) that an error has occurred on this managed connection instance.
  - getSocketConnection
```
protected VistaSocketConnection getSocketConnection()
```
    Returns the socketCon for this managed connection
    
    Returns:
    
    reference tot the current VistaSocketConnection for this managed connection
  - getSocketTimeOut
```
protected long getSocketTimeOut()
```
    Returns:
    
    the current socket timeout for this managed connection
  - setSocketTimeOut
```
public final void setSocketTimeOut(long socketTimeOut)
```
    Sets the socket timeout to the value of parameter.
    
    Parameters:
    
    socketTimeOut - value of to set timeout in milliseconds
    
    Throws:
    
    VistaSocketException
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - getAdapterEnvironment
```
protected final EMAdapterEnvironment getAdapterEnvironment()
```
    Returns:
    
    the operational environment for this managed connection (J2EE or J2SE)
  - getLastInteractionTimeMillis
```
public long getLastInteractionTimeMillis()
```
    Returns:
    
    long the last interaction time in milliseconds.
  - setLastInteractionTimeMillis
```
public final void setLastInteractionTimeMillis(long lastinteractiontimemillis)
```
    Sets the last interaction time in milliseconds.
    
    Parameters:
    
    lastinteractiontimemillis -
  - getLastTimeRpcExecutedMillis
```
protected long getLastTimeRpcExecutedMillis()
```
    Returns:
    
    Returns the lastTimeRpcExecutedMillis.
  - getHeartBeatRate
```
protected final long getHeartBeatRate()
```
    Returns:
    
    retrieves the heartbeat rate (in milliseconds) for this managed connection
  - getMJob
```
protected final String getMJob()
```
    Returns:
    
    Returns the M $JOB for connection
  - setMJob
```
protected final void setMJob(String mJob)
```
    Parameters:
    
    mJob - The M $JOB for the connection.
  - getReAuthSessionTimeout
```
protected long getReAuthSessionTimeout()
```
    Returns:
    
    Returns the reAuthSessionTimeout.
  - setReAuthSessionTimeout
```
protected final void setReAuthSessionTimeout(long reAuthSessionTimeout)
```
    Parameters:
    
    reAuthSessionTimeout - The reAuthSessionTimeout to set.
  - isValid
```
public final boolean isValid()
```
    Returns:
    
    boolean indicates whether this managed connection is a valid connection to an M server.
  - setValid
```
public final void setValid(boolean valid)
```
    Sets the indicator on whether this managed connectioin is a valid connection to an M server.
    
    Parameters:
    
    valid -
  - equals
```
public boolean equals(Object obj)
```
    This implementation has changed for app server see hashCode->toString
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    return cached hashcode
    
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - getAccessCode
```
public final String getAccessCode()
```
    Returns:
    
    access code
  - getVerifyCode
```
public final String getVerifyCode()
```
    Returns:
    
    verify code
  - getConnReqInfo
```
public VistaLinkConnectionRequestInfo getConnReqInfo()
```
    Returns:
    
    request info object
  - getConnReqInfoString
```
public String getConnReqInfoString()
```
  - getReAuthState
```
protected EMReAuthState getReAuthState()
```
    Returns:
    
    Returns the reAuthState.
  - setReAuthState
```
protected final void setReAuthState(EMReAuthState reAuthState)
```
    Parameters:
    
    reAuthState - The reAuthState to set.

Class VistaLinkManagedConnection

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

VistaLinkManagedConnection

Method Detail

addConnectionEventListener

removeConnectionEventListener

isConnectionHandleAvailable

associateConnection

disassociateConnection

cleanup

destroy

closeHandle

getConnection

getLocalTransaction

getMetaData

getConnectionMetaData

getXAResource

getManagedConnectionFactory

setLogWriter

getLogWriter

getMaxConnectionHandles

getHostAddr

getHostPort

executeRPC

executeInteraction

executeSystemInteraction

executeSystemInfoInteraction

notifyErrorOccurred

getSocketConnection

getSocketTimeOut

setSocketTimeOut

toString

getAdapterEnvironment

getLastInteractionTimeMillis

setLastInteractionTimeMillis

getLastTimeRpcExecutedMillis

getHeartBeatRate

getMJob

setMJob

getReAuthSessionTimeout

setReAuthSessionTimeout

isValid

setValid

equals

hashCode

getAccessCode

getVerifyCode

getConnReqInfo

getConnReqInfoString

getReAuthState

setReAuthState