ca.uhn.hl7v2

Class DefaultHapiContext

java.lang.Object

ca.uhn.hl7v2.DefaultHapiContext

All Implemented Interfaces:

HapiContext, Closeable, AutoCloseable

public class DefaultHapiContext
extends Object
implements HapiContext

Default implementation for HapiContext. With this class you can configure HAPI and obtain all major HAPI business objects that are initialized accordingly. All configuration objects already have reasonable defaults.

When using Spring Framework for initializing objects, you can use the factory methods like this:

 <!-- Define the context -->
 <bean id="hapiContext" class="ca.uhn.hl7v2.DefaultHapiContext">
    ...
 </bean>
 
 <!-- Obtain the default PipeParser instance -->
 <bean id="pipeParser" factory-bean="hapiContext" factory-method="getPipeParser"/>
 ...
 

Constructor Summary

Constructors

Constructor and Description
DefaultHapiContext()
DefaultHapiContext(ExecutorService executorService)
DefaultHapiContext(HapiContext context)
DefaultHapiContext(ModelClassFactory modelClassFactory)
DefaultHapiContext(ParserConfiguration parserConfiguration, ValidationContext validationContext, ModelClassFactory modelClassFactory)
DefaultHapiContext(ParserConfiguration parserConfiguration, ValidationRuleBuilder builder, ModelClassFactory modelClassFactory)
DefaultHapiContext(ValidationContext validationContext)
DefaultHapiContext(ValidationRuleBuilder builder)

Method Summary

Modifier and Type	Method and Description
void	close()
CodeStoreRegistry	getCodeStoreRegistry()
Validator	getConformanceValidator() Returns a ca.uhn.hl7v2.conf.check.Validator instance.
ConnectionHub	getConnectionHub()
ExecutorService	getExecutorService()
GenericParser	getGenericParser()
LowerLayerProtocol	getLowerLayerProtocol()
<R> Validator<R>	getMessageValidator()
ModelClassFactory	getModelClassFactory()
ParserConfiguration	getParserConfiguration()
PipeParser	getPipeParser()
ProfileStore	getProfileStore()
ServerConfiguration	getServerConfiguration()
SocketFactory	getSocketFactory()
ValidationContext	getValidationContext() Returns the ValidationContext.
<R> ValidationExceptionHandlerFactory<R>	getValidationExceptionHandlerFactory()
ValidationRuleBuilder	getValidationRuleBuilder()
XMLParser	getXMLParser()
Connection	newClient(String host, int port, boolean tls) Construct a new HL7 Client which will connect to an external TCP server for the purpose of sending messages (and receiving responses).
Connection	newClient(String host, int outboundPort, int inboundPort, boolean tls) Construct a new HL7 two-port client which will connect to an external TCP server for the purpose of sending messages (and receiving responses).
Connection	newLazyClient(String host, int port, boolean tls) Construct a new HL7 Client which will connect to an external TCP server for the purpose of sending messages (and receiving responses).
Connection	newLazyClient(String host, int outboundPort, int inboundPort, boolean tls) Construct a new HL7 two-port client which will connect to an external TCP server for the purpose of sending messages (and receiving responses).
<T extends Message> T	newMessage(Class<T> clazz) Creates a new message of the provided message structure class, without further initializing the message
Message	newMessage(String eventType, String triggerEvent, Version version) Creates a new message of the given event type, trigger and version, and initializes the message header
SimpleServer	newServer(int port, boolean tls) Construct a new HL7 Server which will listen for incoming connections
TwoPortService	newServer(int port1, int port2, boolean tls) Construct a new HL7 Server which will listen for a pair of connections (one for incoming messages, one for outgoing)
void	setCodeStoreRegistry(CodeStoreRegistry codeStoreRegistry)
void	setExecutorService(ExecutorService executorService)
void	setLowerLayerProtocol(LowerLayerProtocol llp)
void	setModelClassFactory(ModelClassFactory modelClassFactory)
void	setParserConfiguration(ParserConfiguration configuration)
void	setProfileStore(ProfileStore profileStore)
void	setServerConfiguration(ServerConfiguration theServerConfiguration) Sets the ServerConfiguration to be used by all HL7 servers obtained from this class.
void	setSocketFactory(SocketFactory socketFactory)
void	setValidationContext(String contextClassName) Sets a default ValidationContext.
void	setValidationContext(ValidationContext context)
<R> void	setValidationExceptionHandlerFactory(ValidationExceptionHandlerFactory<R> factory)
void	setValidationRuleBuilder(String builderClassName) Sets a new instance of ValidationRuleBuilder as default.
void	setValidationRuleBuilder(ValidationRuleBuilder validationRuleBuilder) Sets a default ValidationRuleBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHapiContext

public DefaultHapiContext()

DefaultHapiContext

public DefaultHapiContext(ExecutorService executorService)

DefaultHapiContext

public DefaultHapiContext(ModelClassFactory modelClassFactory)

DefaultHapiContext

public DefaultHapiContext(ValidationContext validationContext)

DefaultHapiContext

public DefaultHapiContext(ValidationRuleBuilder builder)

DefaultHapiContext

public DefaultHapiContext(ParserConfiguration parserConfiguration,
                          ValidationContext validationContext,
                          ModelClassFactory modelClassFactory)

DefaultHapiContext

public DefaultHapiContext(ParserConfiguration parserConfiguration,
                          ValidationRuleBuilder builder,
                          ModelClassFactory modelClassFactory)

DefaultHapiContext

public DefaultHapiContext(HapiContext context)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface HapiContext

Returns:

the ExecutorService to be used by all services that spawn threads

setExecutorService

public void setExecutorService(ExecutorService executorService)

Specified by:

setExecutorService in interface HapiContext

Parameters:

executorService - the ExecutorService to be used by all services that spawn threads

getConnectionHub

public ConnectionHub getConnectionHub()

Specified by:

getConnectionHub in interface HapiContext

Returns:

a new ConnectionHub instance

getParserConfiguration

public ParserConfiguration getParserConfiguration()

Specified by:

getParserConfiguration in interface HapiContext

Returns:

the ParserConfiguration to be used by all parsers obtained from this class.

setParserConfiguration

public void setParserConfiguration(ParserConfiguration configuration)

Specified by:

setParserConfiguration in interface HapiContext

Parameters:

configuration - ParserConfiguration to be used by all parsers obtained from this class.

getValidationContext

public ValidationContext getValidationContext()

Returns the ValidationContext. If none has been explicitly set, getValidationRuleBuilder() is called in order to to contruct a context. If this is also null, the ca.uhn.hl7v2.validation.context_class system property is evaluated, otherwise it returns the DefaultValidation context.

Specified by:

getValidationContext in interface HapiContext

Returns:

the ValidationContext to be used by all parsers obtained from this class.

setValidationContext

public void setValidationContext(ValidationContext context)

Specified by:

setValidationContext in interface HapiContext

Parameters:

context - ValidationContext to be used by all parsers obtained from this class.

setValidationContext

public void setValidationContext(String contextClassName)

Description copied from interface: HapiContext

Sets a default ValidationContext. Note that a default ValidationRuleBuilder has precedence of this ValidationContext.

Specified by:

setValidationContext in interface HapiContext

Parameters:

contextClassName - class name of the ValidationContext to be used by all parsers obtained from this class.

getValidationRuleBuilder

public ValidationRuleBuilder getValidationRuleBuilder()

Specified by:

getValidationRuleBuilder in interface HapiContext

Returns:

the ValidationRuleBuilder to be used by all parsers obtained from this class.

setValidationRuleBuilder

public void setValidationRuleBuilder(ValidationRuleBuilder validationRuleBuilder)

Description copied from interface: HapiContext

Sets a default ValidationRuleBuilder. Note that this ValidationRuleBuilder has precedence over a default ValidationContext set with HapiContext.setValidationContext(ValidationContext) or HapiContext.setValidationContext(String)

Specified by:

setValidationRuleBuilder in interface HapiContext

Parameters:

validationRuleBuilder - ValidationRuleBuilder to be used by all parsers obtained from this class.

setValidationRuleBuilder

public void setValidationRuleBuilder(String builderClassName)

Description copied from interface: HapiContext

Sets a new instance of ValidationRuleBuilder as default. Note that this ValidationRuleBuilder has precedence over a default ValidationContext set with HapiContext.setValidationContext(ValidationContext) or HapiContext.setValidationContext(String)

Specified by:

setValidationRuleBuilder in interface HapiContext

Parameters:

builderClassName - class name of the ValidationRuleBuilder to be used by all parsers obtained from this class.

getModelClassFactory

public ModelClassFactory getModelClassFactory()

Specified by:

getModelClassFactory in interface HapiContext

Returns:

the ModelClassFactory to be used by all parsers obtained from this class.

setModelClassFactory

public void setModelClassFactory(ModelClassFactory modelClassFactory)

Specified by:

setModelClassFactory in interface HapiContext

Parameters:

modelClassFactory - the ModelClassFactory to be used by all parsers obtained from this class.

getProfileStore

public ProfileStore getProfileStore()

Specified by:

getProfileStore in interface HapiContext

Returns:

the ProfileStore to be used for loading conformance profile files

setProfileStore

public void setProfileStore(ProfileStore profileStore)

Specified by:

setProfileStore in interface HapiContext

Parameters:

profileStore - the ProfileStore to be used for loading conformance profile files

getCodeStoreRegistry

public CodeStoreRegistry getCodeStoreRegistry()

Specified by:

getCodeStoreRegistry in interface HapiContext

Returns:

the CodeStoreRegistry to be used for serving codes for conformance profiles

setCodeStoreRegistry

public void setCodeStoreRegistry(CodeStoreRegistry codeStoreRegistry)

Specified by:

setCodeStoreRegistry in interface HapiContext

Parameters:

codeStoreRegistry - the CodeStoreRegistry to be used for serving codes for conformance profiles

getConformanceValidator

public Validator getConformanceValidator()

Description copied from interface: HapiContext

Returns a ca.uhn.hl7v2.conf.check.Validator instance. It is recommended to use HapiContext.getMessageValidator() and configure a Validation rule that checks a message against a conformance profile

Specified by:

getConformanceValidator in interface HapiContext

Returns:

a ca.uhn.hl7v2.conf.check.Validator instance initialized as set with HapiContext.setCodeStoreRegistry(CodeStoreRegistry)

getPipeParser

public PipeParser getPipeParser()

Specified by:

getPipeParser in interface HapiContext

Returns:

a new PipeParser instance initialized as set with HapiContext.setModelClassFactory(ModelClassFactory), HapiContext.setValidationContext(String) and HapiContext.setParserConfiguration(ParserConfiguration).

getXMLParser

public XMLParser getXMLParser()

Specified by:

getXMLParser in interface HapiContext

Returns:

a new XMLParser instance initialized as set with HapiContext.setModelClassFactory(ModelClassFactory), HapiContext.setValidationContext(String) and HapiContext.setParserConfiguration(ParserConfiguration).

getGenericParser

public GenericParser getGenericParser()

Specified by:

getGenericParser in interface HapiContext

Returns:

a new GenericParser instance initialized as set with HapiContext.setModelClassFactory(ModelClassFactory), HapiContext.setValidationContext(String) and HapiContext.setParserConfiguration(ParserConfiguration).

getMessageValidator

public <R> Validator<R> getMessageValidator()

Specified by:

getMessageValidator in interface HapiContext

Returns:

a MessageValidator instance initialized with the ValidationContext as set using HapiContext.setValidationContext(ValidationContext). For each validation it will use a new instance of ValidationExceptionHandler as obtained by HapiContext.getValidationExceptionHandlerFactory().

getValidationExceptionHandlerFactory

public <R> ValidationExceptionHandlerFactory<R> getValidationExceptionHandlerFactory()

Specified by:

getValidationExceptionHandlerFactory in interface HapiContext

setValidationExceptionHandlerFactory

public <R> void setValidationExceptionHandlerFactory(ValidationExceptionHandlerFactory<R> factory)

Specified by:

setValidationExceptionHandlerFactory in interface HapiContext

Parameters:

factory - a ValidationExceptionHandlerFactory that is used to create a ValidationExceptionHandler during message validation.

getLowerLayerProtocol

public LowerLayerProtocol getLowerLayerProtocol()

Specified by:

getLowerLayerProtocol in interface HapiContext

Returns:

the LowerLayerProtocol instance used by all HL7 MLLP operations

setLowerLayerProtocol

public void setLowerLayerProtocol(LowerLayerProtocol llp)

Specified by:

setLowerLayerProtocol in interface HapiContext

Parameters:

llp - the LowerLayerProtocol instance used by all HL7 MLLP operations

getSocketFactory

public SocketFactory getSocketFactory()

Specified by:

getSocketFactory in interface HapiContext

Returns:

the SocketFactory instance used by HL7 networking operations

setSocketFactory

public void setSocketFactory(SocketFactory socketFactory)

Specified by:

setSocketFactory in interface HapiContext

Parameters:

socketFactory - the SocketFactory instance used by HL7 networking operations

newServer

public SimpleServer newServer(int port,
                              boolean tls)

Description copied from interface: HapiContext

Construct a new HL7 Server which will listen for incoming connections

Specified by:

newServer in interface HapiContext

Parameters:

port - The port on which to listen for new connections

tls - Whether or not to use SSL/TLS

Returns:

HL7 service running on the configured port using the default parser and executor service instances provided by this interface. Note that the returned service will not be started, and must manually be started using Service.start() or Service.startAndWait()

See Also:

here for an example of how to use this method, HapiContext.setSocketFactory(SocketFactory)

newServer

public TwoPortService newServer(int port1,
                                int port2,
                                boolean tls)

Description copied from interface: HapiContext

Construct a new HL7 Server which will listen for a pair of connections (one for incoming messages, one for outgoing)

Specified by:

newServer in interface HapiContext

Parameters:

port1 - The port on which to listen for connections for inbound messages

port2 - The port on which to listen for connections for outgoing messages

tls - Whether or not to use SSL/TLS

Returns:

HL7 service running on the configured ports using the default parser and executor service instances provided by this interface. Note that the returned service will not be started, and must manually be started using Service.start() or Service.startAndWait()

See Also:

here for an example of how to use this method, HapiContext.setSocketFactory(SocketFactory)

newClient

public Connection newClient(String host,
                            int port,
                            boolean tls)
                     throws HL7Exception

Description copied from interface: HapiContext

Construct a new HL7 Client which will connect to an external TCP server for the purpose of sending messages (and receiving responses). Unless otherwise stated, the connection is established by the time this method returns, or an exception should be thrown if the connection can not be established. If a connection to this server already exists, it is reused.

Note that connections are pooled by the HapiContext by default. If multiple concurrent connections to the same server are required, the easiest way to accomplish this is currently to create multiple HapiContext instances.

Specified by:

newClient in interface HapiContext

Parameters:

host - The host IP/hostname to connect to

port - The port to connect to

tls - Whether or not to use SSL/TLS

Returns:

Returns a connection which can be used to transmit messages. Note that this method will attempt to connect to the specified address, and will throw an exception if it fails to connect.

Throws:

HL7Exception - If the connection can not be initialized for any reason

See Also:

here for an example of how to use this method

newClient

public Connection newClient(String host,
                            int outboundPort,
                            int inboundPort,
                            boolean tls)
                     throws HL7Exception

Description copied from interface: HapiContext

Construct a new HL7 two-port client which will connect to an external TCP server for the purpose of sending messages (and receiving responses). Unless otherwise stated, the connection is established by the time this method returns, or an exception should be thrown if the connection can not be established. If a connection to this server already exists, it is reused.

Note that connections are pooled by the HapiContext by default. If multiple concurrent connections to the same server are required, the easiest way to accomplish this is currently to create multiple HapiContext instances.

Specified by:

newClient in interface HapiContext

Parameters:

host - The host IP/hostname to connect to

outboundPort - The port to connect to for outgoing messages

inboundPort - The port to connect to for inbound (response) messages

tls - Whether or not to use SSL/TLS

Returns:

Returns a connection which can be used to transmit messages. Note that this method will attempt to connect to the specified address, and will throw an exception if it fails to connect.

Throws:

HL7Exception - If the connection can not be initialized for any reason

newLazyClient

public Connection newLazyClient(String host,
                                int port,
                                boolean tls)
                         throws HL7Exception

Description copied from interface: HapiContext

Construct a new HL7 Client which will connect to an external TCP server for the purpose of sending messages (and receiving responses). The connection should be established by the time the first message is sent.

Note that connections are pooled by the HapiContext by default. If multiple concurrent connections to the same server are required, the easiest way to accomplish this is currently to create multiple HapiContext instances.

Specified by:

newLazyClient in interface HapiContext

Parameters:

host - The host IP/hostname to connect to

port - The port to connect to

tls - Whether or not to use SSL/TLS

Returns:

Returns a connection which can be used to transmit messages.

Throws:

HL7Exception - If the connection can not be initialized for any reason

See Also:

here for an example of how to use this method

newLazyClient

public Connection newLazyClient(String host,
                                int outboundPort,
                                int inboundPort,
                                boolean tls)
                         throws HL7Exception

Description copied from interface: HapiContext

Construct a new HL7 two-port client which will connect to an external TCP server for the purpose of sending messages (and receiving responses). The connection should be established by the time the first message is sent.

Note that connections are pooled by the HapiContext by default. If multiple concurrent connections to the same server are required, the easiest way to accomplish this is currently to create multiple HapiContext instances.

Specified by:

newLazyClient in interface HapiContext

Parameters:

host - The host IP/hostname to connect to

outboundPort - The port to connect to for outgoing messages

inboundPort - The port to connect to for inbound (response) messages

tls - Whether or not to use SSL/TLS

Returns:

Returns a connection which can be used to transmit messages.

Throws:

HL7Exception - If the connection can not be initialized for any reason

getServerConfiguration

public ServerConfiguration getServerConfiguration()

Specified by:

getServerConfiguration in interface HapiContext

Returns:

the ServerConfiguration to be used by all HL7 servers obtained from this class.

See Also:

HapiContext.newServer(int, boolean), HapiContext.newServer(int, int, boolean)

setServerConfiguration

public void setServerConfiguration(ServerConfiguration theServerConfiguration)

Description copied from interface: HapiContext

Sets the ServerConfiguration to be used by all HL7 servers obtained from this class.

Specified by:

setServerConfiguration in interface HapiContext

See Also:

HapiContext.newServer(int, boolean), HapiContext.newServer(int, int, boolean)

newMessage

public Message newMessage(String eventType,
                          String triggerEvent,
                          Version version)
                   throws HL7Exception

Description copied from interface: HapiContext

Creates a new message of the given event type, trigger and version, and initializes the message header

Specified by:

newMessage in interface HapiContext

Parameters:

eventType - event type, e.g. ADT

triggerEvent - trigger event, e.g. A01

version - HL7v2 version

Returns:

Message object of the type determined by the underlying model class factory

Throws:

HL7Exception - if no message object could be created

newMessage

public <T extends Message> T newMessage(Class<T> clazz)
                                 throws HL7Exception

Description copied from interface: HapiContext

Creates a new message of the provided message structure class, without further initializing the message

Specified by:

newMessage in interface HapiContext

Type Parameters:

T - message structure class type

Parameters:

clazz - message structure class

Returns:

the created message instance

Throws:

HL7Exception