gov.va.med.vistalink.rpc

Class RpcResponseFactory

Object

VistaLinkResponseFactoryImpl

RpcResponseFactory

All Implemented Interfaces:

VistaLinkResponseFactory

public class RpcResponseFactory
extends VistaLinkResponseFactoryImpl

Implements RPC specific response parsing logic

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CDATA_BEG Represents the beginning of the CDATA section
protected static String	CDATA_END_W_SUFFIX Represents the end of the CDATA section w/ the SUFFIX from VistaLinkResponseFactoryImpl
protected static String	CDATA_END_WO_SUFFIX Represents the end of the CDATA section wo/ the SUFFIX from VistaLinkResponseFactoryImpl
protected static String	COMMON_RESPONSE_VERSION version string most commonly expected in VL messages from M side
protected static String	ERROR_MSG_RPC Represents the strings that identifies if a RPC fault has occurred
protected static String	GOV_VA_MED_RPC_FAULT Represents a rpc fault
protected static String	GOV_VA_MED_RPC_RESPONSE The message type used for this response
protected static String	MOST_COMMON_ENDING
protected static String	MOST_COMMON_HEADER
protected static String	MOST_COMMON_MIDDLE

Fields inherited from class VistaLinkResponseFactoryImpl

ERROR_MSG_GEN, GOV_VA_MED_FOUNDATIONS_FAULT, SUFFIX, VISTALINK_ROOT_ELEMENT

Constructor Summary

Constructors

Constructor and Description
RpcResponseFactory() Constructor for VistaRPCResponseFactory.

Method Summary

Modifier and Type	Method and Description
protected boolean	doesResponseIndicateFault(String rawXml) Performs additional response XML string parsing to check if fault occured
protected String	filterResponseXmlString(String rawXml, boolean isFault) Filters response XML string specific to RPC implementation.
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) Perform RPC specific fault handling and creation of RPC specific FaultExceptions.
protected VistaLinkResponseVO	parseMessageBody(String rawXml, String filteredXml, Document doc, String messageType, VistaLinkRequestVO requestVO) RPC specific method to parse response XML string message body and to create RpcResponse object with appropriate data.

Methods inherited from class VistaLinkResponseFactoryImpl

handleFault

Methods inherited from class Object

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

Field Detail

GOV_VA_MED_RPC_RESPONSE

protected static final String GOV_VA_MED_RPC_RESPONSE

The message type used for this response

See Also:

Constant Field Values

GOV_VA_MED_RPC_FAULT

protected static final String GOV_VA_MED_RPC_FAULT

Represents a rpc fault

See Also:

Constant Field Values

ERROR_MSG_RPC

protected static final String ERROR_MSG_RPC

Represents the strings that identifies if a RPC fault has occurred

See Also:

Constant Field Values

COMMON_RESPONSE_VERSION

protected static final String COMMON_RESPONSE_VERSION

version string most commonly expected in VL messages from M side

See Also:

Constant Field Values

CDATA_BEG

protected static final String CDATA_BEG

Represents the beginning of the CDATA section

See Also:

Constant Field Values

CDATA_END_W_SUFFIX

protected static final String CDATA_END_W_SUFFIX

Represents the end of the CDATA section w/ the SUFFIX from VistaLinkResponseFactoryImpl

See Also:

Constant Field Values

CDATA_END_WO_SUFFIX

protected static final String CDATA_END_WO_SUFFIX

Represents the end of the CDATA section wo/ the SUFFIX from VistaLinkResponseFactoryImpl

See Also:

Constant Field Values

MOST_COMMON_HEADER

protected static final String MOST_COMMON_HEADER

See Also:

Constant Field Values

MOST_COMMON_MIDDLE

protected static final String MOST_COMMON_MIDDLE

See Also:

Constant Field Values

MOST_COMMON_ENDING

protected static final String MOST_COMMON_ENDING

See Also:

Constant Field Values

Constructor Detail

RpcResponseFactory

public RpcResponseFactory()

Constructor for VistaRPCResponseFactory.

Method Detail

handleResponse

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

Description copied from class: VistaLinkResponseFactoryImpl

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

Specified by:

handleResponse in interface VistaLinkResponseFactory

Overrides:

handleResponse in class VistaLinkResponseFactoryImpl

Returns:

@throws FoundationsException

Throws:

FoundationsException

See Also:

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

parseMessageBody

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

RPC specific method to parse response XML string message body and to create RpcResponse object with appropriate data.

Overrides:

parseMessageBody in class VistaLinkResponseFactoryImpl

Returns:

VistaLinkResponseVO

Throws:

FoundationsException

See Also:

VistaLinkResponseFactoryImpl.parseMessageBody(java.lang.String, java.lang.String, org.w3c.dom.Document, java.lang.String, gov.va.med.vistalink.adapter.record.VistaLinkRequestVO)

doesResponseIndicateFault

protected boolean doesResponseIndicateFault(String rawXml)

Performs additional response XML string parsing to check if fault occured

Overrides:

doesResponseIndicateFault in class VistaLinkResponseFactoryImpl

Returns:

boolean Returns true if response indicates specific fault condition.

See Also:

VistaLinkResponseFactoryImpl.doesResponseIndicateFault(java.lang.String)

filterResponseXmlString

protected String filterResponseXmlString(String rawXml,
                                         boolean isFault)

Filters response XML string specific to RPC implementation. Removes CDATA from within the response XML.

Overrides:

filterResponseXmlString in class VistaLinkResponseFactoryImpl

Returns:

String

See Also:

VistaLinkResponseFactoryImpl.filterResponseXmlString(java.lang.String, boolean)

handleSpecificFault

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

Perform RPC specific fault handling and creation of RPC specific FaultExceptions.

Overrides:

handleSpecificFault in class VistaLinkResponseFactoryImpl

Returns:

VistaLinkFaultException

Throws:

VistaLinkFaultException

FoundationsException

See Also:

VistaLinkResponseFactoryImpl.handleSpecificFault(org.w3c.dom.Document, java.lang.String, gov.va.med.vistalink.adapter.record.VistaLinkFaultException)