| GENERAL DESCRIPTION |
This ICR describes the supported VistALink J2M (v1.5) Java APIs for
the vljConnector-x.x.x.xxx.jar file.
It is strongly recommended that you consult the javadoc for the
VistALink J2M software for more detail on all supported VistALink
J2M Java APIs.
Jar:
vljConnector-x.x.x.xxx.jar
Connector Packages:
gov.va.med.vistalink.adapter.cci
gov.va.med.vistalink.adapter.heartbeat
gov.va.med.vistalink.adapter.record
gov.va.med.vistalink.adapter.spi
RPC Package:
gov.va.med.vistalink.rpc
Institution Mapping Utilities Package:
gov.va.med.vistalink.institution
Package gov.va.med.vistalink.adapter.cci
========================================
Implements the Common Client Interface (CCI) portion of the Java
Connector Architecture (JCA) for VistaLink.
Interface Summary
=================
VistaLinkConnection
This interface represents an application level connection
handle that is used by a component to access an EIS instance.
VistaLinkConnectionSpec
This interface defined the common properties needed by any
connection spec implementation.
Class Summary
=============
VistaLinkAppProxyConnectionSpec
This is the connection spec class for Application Proxy
re-authentication.
VistaLinkConnectionFactory
This implementation class provides an interface for getting
connection to an EIS instance.
VistaLinkConnectionMetaData
Provides information about an EIS instance connected through a
Connection instance.
VistaLinkConnectionSpecImpl
This is the base implementation class for
VistaLinkConnectionSpec.
VistaLinkDuzConnectionSpec
This is the connection spec class for Duz re-authentication.
VistaLinkResourceAdapterMetaData
Implementation class provides info about the capabilities of a
resource adapter.
VistaLinkVpidConnectionSpec
This is the connection spec class for VPID re-authentication.
Exception Summary
=================
VistaLinkResourceException
Represents a ResourceException thrown by the VistaLink
adapter.
Package gov.va.med.vistalink.adapter.heartbeat
==============================================
Implements the heartbeat keepalive timer process for VistaLink.
Exception Summary
=================
HeartBeatFailedException
This exception class is used to notify the managed connection
and its event listeners that a scheduled heart beat has
failed.
HeartBeatInitializationFailedException
This exception class is thrown when the heart beat fails to
make its first interaction to retrieve the heartbeat rate from
M.
Package gov.va.med.vistalink.adapter.record
===========================================
Implements basic request- and response-related classes for
VistaLink.
Interface Summary
=================
VistaLinkRequestRetryStrategy
Base strategy interface for determining if request should be
re-executed.
VistaLinkRequestVO
Base request interface.
Class Summary
=============
VistaLinkRequestRetryStrategyAllow
Simple 'Allow' strategy implementation that indicates request
should be re-executed.
VistaLinkRequestRetryStrategyDeny
Simple 'Deny' strategy implementation that indicates request
should not be re-executed.
VistaLinkRequestVOImpl
Base request implementation.
Exception Summary
=================
LoginsDisabledFaultException
This exception represents the case where the M side has logins
disabled; this is when the site sets the parameter to not
allow any logins.
NoJobSlotsAvailableFaultException
This exception represents the case where on the M side there
are no license slots available to start another process.
VistaLinkFaultException
Exception encapsulates Fault information coming from M side.
Package gov.va.med.vistalink.adapter.spi
========================================
Implements the Service Provider Interface (spi) portion of the Java
Connector Architecture (JCA) for VistaLink.
Class Summary
=============
VistaLinkServerInfo
Represents M VistA connection information, like address and
port.
Exception Summary
=================
ConnectionHandlesExceededException
This exception class is thrown when a
VistaLinkManagedConnection object has exceeded its maximum
allowable connection handles.
VistaLinkSocketAlreadyClosedException
Represents a situation where, when attempting to close a
socket, the socket is already closed.
VistaLinkSocketClosedException
This exception class is thrown when an attempt is made to
access the VistaLinkManagedConnection's underlying
VistaSocketConnection after it has been closed or invalidated.
Package gov.va.med.vistalink.rpc
================================
Implements RPC requests and responses over VistaLink.
Class Summary
=============
RpcReferenceType
Represents a reference type object for an RPC parameter.
RpcRequest
Represents a RPC request to an M VistA server.
RpcRequestFactory
Factory class to creates instances of RpcRequest.
J2SE Example: //request and response objects
RpcRequest vReq = null;
RpcResponse vResp = null; //The Rpc Context
String rpcContext = "XOBV VISTALINK TESTER"; //The Rpc to call
String rpcName = "XOBV TEST PING"; //Construct the request
object
vReq = RpcRequestFactory.getRpcRequest(rpcContext, rpcName);
//Execute the Rpc and get the response
vResp = myConnection.executeRPC(vReq); //Work with the
response...
RpcRequestParams
Represents the collection of parameters associated with an
RPC.
RpcResponse
Represents a data structure which holds the response value(s).
Exception Summary
=================
NoRpcContextFaultException
This exception represents the case where the request RPC
context does not exist or the current user does not have
access to the B-option representing the context.
RpcFaultException
This fault exception class is used for all Rpc-related errors
returned from the M system.
RpcNotInContextFaultException
This exception represents the case where the requested RPC is
not contained in the current RPC context.
RpcNotOkForProxyUseException
This exception represents the case where the requested RPC is
not marked as OK for use by an application proxy user, but has
been attempted to be invoked by one.
RpcResponseTypeIsNotXmlException
Represents an exception indicating the RpcResponse type if not
XML.
RpcTimeOutFaultException
This exception represents the case where the RPC execution
took too long on the server and the application gracefully
stopped the RPC's processing.
Package gov.va.med.vistalink.institution
========================================
Foundations utilities for working with VistaLink-related Institution
data.
Class Summary
=============
InstitutionMappingDelegate
The in-memory mapping is initialized during connector startup.
Exception Summary
=================
InstitutionMapNotInitializedException
Represents an attempt to access some functionality of the
InstitutionMappingImpl instance when that instance has not
been created.
InstitutionMappingNotFoundException
Represents a failure to retrieve an institution mapping based
on station number, due to requested station number not being
found in the list of instituion mappings maintained by the
InstitutionMappingImpl instance.
|