gov.va.med.vistalink.adapter.record

Class VistaLinkResponseFactoryImpl

Object

VistaLinkResponseFactoryImpl

All Implemented Interfaces:

VistaLinkResponseFactory

Direct Known Subclasses:

RpcResponseFactory, SecurityResponseFactory, VistaHeartBeatTimerResponseFactory, VistaLinkInitSocketResponseFactory, VistaLinkSystemInfoResponseFactory, VistaLinkUpgradeToTlsResponseFactory

public class VistaLinkResponseFactoryImpl
extends Object
implements VistaLinkResponseFactory

Base response factory implementation. Performs system level response parsing tasks. Allows subclasses to plugin more specific parsing implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERROR_MSG_GEN Defines the message type for a security errors response
protected static String	GOV_VA_MED_FOUNDATIONS_FAULT Fault message type name.
protected static String	SUFFIX Response message suffix (i.e., the last two XML tags).
protected static String	VISTALINK_ROOT_ELEMENT Response message root element name.

Constructor Summary

Constructors

Constructor and Description
VistaLinkResponseFactoryImpl() Constructor for VistaLinkResponseFactoryImpl.

Method Summary

Modifier and Type	Method and Description
protected boolean	doesResponseIndicateFault(String rawXml) Should be overriden by the child classes to discover additional fault indication.
protected String	filterResponseXmlString(String rawXml, boolean isFault) Allows child classes to implement their own response XML filtering before any other work is done on the response String (e.g., removing CDATA from the response XML.)
protected void	handleFault(Document xdoc, String messageType) Initiates VLJ Fault handling.
VistaLinkResponseVO	handleResponse(String response, VistaLinkRequestVO requestVO) Called by the managedConnection to parse the response String and return VistaLinkResponseVO implementation.
protected VistaLinkFaultException	handleSpecificFault(Document xdoc, String messageType, VistaLinkFaultException faultException) This method can be overriden by the subclasses to perform additional fault handling and return a subclass of VistaLinkFaultException.
protected VistaLinkResponseVO	parseMessageBody(String rawXml, String filteredXml, Document doc, String messageType, VistaLinkRequestVO requestVO) Parses message body.

Methods inherited from class Object

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

Field Detail

GOV_VA_MED_FOUNDATIONS_FAULT

protected static final String GOV_VA_MED_FOUNDATIONS_FAULT

Fault message type name.

See Also:

Constant Field Values

ERROR_MSG_GEN

protected static final String ERROR_MSG_GEN

Defines the message type for a security errors response

See Also:

Constant Field Values

SUFFIX

protected static final String SUFFIX

Response message suffix (i.e., the last two XML tags).

See Also:

Constant Field Values

VISTALINK_ROOT_ELEMENT

protected static final String VISTALINK_ROOT_ELEMENT

Response message root element name.

See Also:

Constant Field Values

Constructor Detail

VistaLinkResponseFactoryImpl

public VistaLinkResponseFactoryImpl()

Constructor for VistaLinkResponseFactoryImpl.

Method Detail

handleResponse

public VistaLinkResponseVO handleResponse(String response,
                                          VistaLinkRequestVO requestVO)
                                   throws FoundationsException

Called by the managedConnection to parse the response String and return VistaLinkResponseVO implementation.

Specified by:

handleResponse in interface VistaLinkResponseFactory

Returns:

@throws FoundationsException

Throws:

FoundationsException

See Also:

VistaLinkResponseFactory.handleResponse(java.lang.String, gov.va.med.vistalink.adapter.record.VistaLinkRequestVO)

doesResponseIndicateFault

protected boolean doesResponseIndicateFault(String rawXml)

Should be overriden by the child classes to discover additional fault indication.

Parameters:

rawXml -

Returns:

boolean Returns true if response indicates specific fault condition.

filterResponseXmlString

protected String filterResponseXmlString(String rawXml,
                                         boolean isFault)

Allows child classes to implement their own response XML filtering before any other work is done on the response String (e.g., removing CDATA from the response XML.)

Parameters:

rawXml -

Returns:

String

parseMessageBody

protected VistaLinkResponseVO parseMessageBody(String rawXml,
                                               String filteredXml,
                                               Document doc,
                                               String messageType,
                                               VistaLinkRequestVO requestVO)
                                        throws FoundationsException

Parses message body. Child classes need to implement this method to be able to create their specific response objects.

Parameters:

filteredXml -

doc -

messageType -

requestVO -

Returns:

VistaLinkResponseVO

Throws:

FoundationsException

handleFault

protected final void handleFault(Document xdoc,
                                 String messageType)
                          throws VistaLinkFaultException,
                                 FoundationsException

1. Initiates VLJ Fault handling.
2. Parses Fault message and stores fault data in the VistaLinkFaultException.
3. Calls handleAndDelegateSpecificFault to perform more specific fault handling tasks.

Handles generic VLJ faults.

Parameters:

xdoc -

messageType -

Throws:

VistaLinkFaultException

FoundationsException

handleSpecificFault

protected VistaLinkFaultException handleSpecificFault(Document xdoc,
                                                      String messageType,
                                                      VistaLinkFaultException faultException)
                                               throws VistaLinkFaultException,
                                                      FoundationsException

This method can be overriden by the subclasses to perform additional fault handling and return a subclass of VistaLinkFaultException.

Implementation in this class returns faultException that is passed into the class.

Overriden method can either return a:

• More specific VistaLinkFaultException implementation.
• The same faultException that is passed into the method.
• null. Will have the same result as returning the same faultException that is passed into the method.

Parameters:

xdoc -

messageType -

faultException -

Returns:

VistaLinkFaultException

Throws:

VistaLinkFaultException

FoundationsException