Package ca.uhn.hl7v2.validation

Class RespondingValidationExceptionHandler

java.lang.Object

ca.uhn.hl7v2.HapiContextSupport

ca.uhn.hl7v2.validation.AbstractValidationExceptionHandler<R>

ca.uhn.hl7v2.validation.CollectingValidationExceptionHandler<Message>

ca.uhn.hl7v2.validation.RespondingValidationExceptionHandler

All Implemented Interfaces:

ValidationExceptionHandler<Message>, ValidationExceptionHandlerFactory<Message>

public class RespondingValidationExceptionHandler
extends CollectingValidationExceptionHandler<Message>
implements ValidationExceptionHandlerFactory<Message>

ValidationExceptionHandler that generates response messages as statically configured and based on the outcome of a validation process. Aspects of creating and populating the response message can be overwritten in subclasses.

This handler (or a subclass thereof) can be used for validation if a response message must be generated upon the validation result.

Author:

Christian Ohr

Constructor Summary

Constructors

Constructor	Description
RespondingValidationExceptionHandler(HapiContext context)

Method Summary

Modifier and Type	Method	Description
protected Message	generateResponseMessage(Object request)	Generates an empty response message.
AcknowledgmentCode	getErrorAcknowledgementCode()
ValidationExceptionHandler<Message>	getNewInstance(HapiContext context)
AcknowledgmentCode	getSuccessAcknowledgementCode()
protected void	populateResponseMessage(Message response)	Populates the generated response based on the collected ValidationExceptions.
final Message	result()	Returns the generated response message.
void	setErrorAcknowledgementCode(AcknowledgmentCode errorAcknowledgementCode)	Set acknowledgment code (AR, AE ,CR, CE) in case validation passes.
void	setSuccessAcknowledgementCode(AcknowledgmentCode successAcknowledgementCode)	Set acknowledgment code (AA,CA) in case validation passes.

Methods inherited from class ca.uhn.hl7v2.validation.CollectingValidationExceptionHandler

error, getExceptions, getMinimumSeverityToCollect, hasFailed, info, setMinimumSeverityToCollect, warning

Methods inherited from class ca.uhn.hl7v2.validation.AbstractValidationExceptionHandler

getValidationSubject, onExceptions, setValidationSubject

Methods inherited from class ca.uhn.hl7v2.HapiContextSupport

getHapiContext, setHapiContext

Methods inherited from class java.lang.Object

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

Constructor Details

RespondingValidationExceptionHandler

public RespondingValidationExceptionHandler(HapiContext context)

Parameters:

context - Hapi context

Method Details

result

public final Message result()
                     throws HL7Exception

Returns the generated response message.

Specified by:

result in interface ValidationExceptionHandler<Message>

Returns:

the generated response

Throws:

HL7Exception - if no response could be generated

setSuccessAcknowledgementCode

public void setSuccessAcknowledgementCode(AcknowledgmentCode successAcknowledgementCode)

Set acknowledgment code (AA,CA) in case validation passes.

Parameters:

successAcknowledgementCode - (AA, CA)

setErrorAcknowledgementCode

public void setErrorAcknowledgementCode(AcknowledgmentCode errorAcknowledgementCode)

Set acknowledgment code (AR, AE ,CR, CE) in case validation passes.

Parameters:

errorAcknowledgementCode - (AR, AE ,CR, CE)

getSuccessAcknowledgementCode

public AcknowledgmentCode getSuccessAcknowledgementCode()

Returns:

the acknowledgement code if validation has succeeded. Default is AA.

getErrorAcknowledgementCode

public AcknowledgmentCode getErrorAcknowledgementCode()

Returns:

the acknowledgement code if validation has failed. Default is AE.

generateResponseMessage

protected Message generateResponseMessage(Object request)
                                   throws HL7Exception

Generates an empty response message. This class generates an ACKnowledgement using the code returned by getSuccessAcknowledgementCode().

Parameters:

request - request message, either a String or a Message

Returns:

acknowledgment to the request

Throws:

HL7Exception

populateResponseMessage

protected void populateResponseMessage(Message response)
                                throws HL7Exception

Populates the generated response based on the collected ValidationExceptions. In case of exceptions, each exception will cause an entry in one or more ERR segments.

Parameters:

response - response message to be populated

Throws:

HL7Exception

getNewInstance

public ValidationExceptionHandler<Message> getNewInstance(HapiContext context)

Specified by:

getNewInstance in interface ValidationExceptionHandlerFactory<Message>

Parameters:

context - HAPI context

Returns:

a new instance of a ValidationExceptionHandler