Class Hl7v3ContinuationAwareEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.openehealth.ipf.platform.camel.ihe.ws.AbstractWsEndpoint<Hl7v3AuditDataset>

org.openehealth.ipf.platform.camel.ihe.hl7v3.Hl7v3Endpoint

org.openehealth.ipf.platform.camel.ihe.hl7v3.Hl7v3ContinuationAwareEndpoint

All Implemented Interfaces:

AutoCloseable, CamelContextAware, ComponentAware, Endpoint, IsSingleton, Service, ShutdownableService, HasCamelContext, HasId, StatefulService, SuspendableService, AuditableEndpoint<Hl7v3AuditDataset>

public class Hl7v3ContinuationAwareEndpoint
extends Hl7v3Endpoint

Camel endpoint implementation for HL7v3-based IHE components with interactive response continuation support.

Author:

Dmytro Rud

Field Summary

Fields inherited from class AbstractWsEndpoint

CORRELATION_KEY_HEADER_NAME, INCOMING_HTTP_HEADERS, INCOMING_SOAP_HEADERS, OUTGOING_HTTP_HEADERS, OUTGOING_SOAP_HEADERS, WSA_REPLYTO_HEADER_NAME

Fields inherited from class BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Hl7v3ContinuationAwareEndpoint(String endpointUri, String address, Hl7v3Component component, Map<String,Object> parameters)

Method Summary

Modifier and Type	Method	Description
Hl7v3ContinuationStorage	getContinuationStorage()	Consumer-side only: Storage bean for continuation fragments.
int	getDefaultContinuationThreshold()	Consumer-side only: Default count of data records in the first response fragment, when the request does not contain "initialQuantity" element.
JaxWsClientFactory<Hl7v3AuditDataset>	getJaxWsClientFactory()
JaxWsServiceFactory<Hl7v3AuditDataset>	getJaxWsServiceFactory()
AbstractWsProducer<Hl7v3AuditDataset, ?, ?>	getProducer(AbstractWsEndpoint<Hl7v3AuditDataset> endpoint, JaxWsClientFactory<Hl7v3AuditDataset> clientFactory)	Constructs and returns a transaction-specific Camel producer instance
boolean	isAutoCancel()	Producer-side only: Whether a "cancel continuation" message should be automatically sent to the server when all continuation fragments have been read.
boolean	isManualAudit()
boolean	isSupportContinuation()	Whether this endpoint should support HL7v3 continuation.
boolean	isValidationOnContinuation()	Whether the system should validate messages which are internally handled when performing HL7v3 interactive continuation.
void	setAutoCancel(boolean autoCancel)	Producer-side only: Whether a "cancel continuation" message should be automatically sent to the server when all continuation fragments have been read.
void	setContinuationStorage(Hl7v3ContinuationStorage continuationStorage)	Consumer-side only: Storage bean for continuation fragments.
void	setDefaultContinuationThreshold(int defaultContinuationThreshold)	Consumer-side only: Default count of data records in the first response fragment, when the request does not contain "initialQuantity" element.
void	setSupportContinuation(boolean supportContinuation)	Whether this endpoint should support HL7v3 continuation.
void	setValidationOnContinuation(boolean validationOnContinuation)	Whether the system should validate messages which are internally handled when performing HL7v3 interactive continuation.

Methods inherited from class AbstractWsEndpoint

createConsumer, createProducer, getAuditContext, getClientAuditStrategy, getComponent, getCorrelator, getCustomCxfInterceptors, getCustomServiceInstance, getFeatures, getHomeCommunityId, getHostnameVerifier, getHttpClientPolicy, getPassword, getProperties, getRejectionHandlingStrategy, getSchemaLocations, getSecurityInformation, getServerAuditStrategy, getServiceAddress, getServiceInstance, getServiceUrl, getSslContextParameters, getUsername, isAddressing, isAudit, isMtom, isSecure, isSingleton, isSwaOutSupport, setAuditContext, setCorrelator, setHomeCommunityId, setHomeCommunityId, setHostnameVerifier, setHttpClientPolicy, setPassword, setRejectionHandlingStrategy, setSecure, setSslContextParameters, setUsername

Methods inherited from class org.apache.camel.support.DefaultEndpoint

configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

Methods inherited from class BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ComponentAware

getComponent, setComponent

Methods inherited from interface Endpoint

configureExchange, configureProperties, createAsyncProducer, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, getExchangePattern, isLenientProperties, isRemote, isSingletonProducer, setCamelContext

Methods inherited from interface Service

build, close, init, start, stop

Methods inherited from interface ShutdownableService

shutdown

Methods inherited from interface StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface SuspendableService

isSuspended, resume, suspend

Constructor Details

Hl7v3ContinuationAwareEndpoint

protected Hl7v3ContinuationAwareEndpoint(String endpointUri,
 String address,
 Hl7v3Component component,
 Map<String,Object> parameters)

Method Details

getProducer

public AbstractWsProducer<Hl7v3AuditDataset, ?, ?> getProducer(AbstractWsEndpoint<Hl7v3AuditDataset> endpoint,
 JaxWsClientFactory<Hl7v3AuditDataset> clientFactory)

Description copied from class: AbstractWsEndpoint

Constructs and returns a transaction-specific Camel producer instance

Specified by:

getProducer in class AbstractWsEndpoint<Hl7v3AuditDataset>

Parameters:

clientFactory - JAX-WS client factory instance.

Returns:

Camel producer instance.

isManualAudit

public boolean isManualAudit()

Returns:

true if ATNA audit strategies must be manually applied in Camel producer and consumer instead of CXF interceptors. This will be the case when interactive response continuation is supported.

getJaxWsClientFactory

public JaxWsClientFactory<Hl7v3AuditDataset> getJaxWsClientFactory()

Overrides:

getJaxWsClientFactory in class Hl7v3Endpoint

Returns:

JAX-WS client object factory.

getJaxWsServiceFactory

public JaxWsServiceFactory<Hl7v3AuditDataset> getJaxWsServiceFactory()

Overrides:

getJaxWsServiceFactory in class Hl7v3Endpoint

Returns:

JAX-WS service object factory.

setSupportContinuation

public void setSupportContinuation(boolean supportContinuation)

Whether this endpoint should support HL7v3 continuation. true when this endpoint supports HL7v3 continuation.

setAutoCancel

public void setAutoCancel(boolean autoCancel)

Producer-side only: Whether a "cancel continuation" message should be automatically sent to the server when all continuation fragments have been read.

This parameter is relevant only on producer side.

setDefaultContinuationThreshold

public void setDefaultContinuationThreshold(int defaultContinuationThreshold)

Consumer-side only: Default count of data records in the first response fragment, when the request does not contain "initialQuantity" element. Negative values mean "no continuation, when initialQuantity is not specified".

This parameter is relevant only on consumer side.

setContinuationStorage

public void setContinuationStorage(Hl7v3ContinuationStorage continuationStorage)

Consumer-side only: Storage bean for continuation fragments.

This parameter is relevant only on consumer side.

setValidationOnContinuation

public void setValidationOnContinuation(boolean validationOnContinuation)

Whether the system should validate messages which are internally handled when performing HL7v3 interactive continuation. true when messages, which are internally handled when performing HL7v3 interactive continuation, should be validated.

isSupportContinuation

public boolean isSupportContinuation()

Whether this endpoint should support HL7v3 continuation. true when this endpoint supports HL7v3 continuation.

isAutoCancel

public boolean isAutoCancel()

Producer-side only: Whether a "cancel continuation" message should be automatically sent to the server when all continuation fragments have been read.

This parameter is relevant only on producer side.

getDefaultContinuationThreshold

public int getDefaultContinuationThreshold()

Consumer-side only: Default count of data records in the first response fragment, when the request does not contain "initialQuantity" element. Negative values mean "no continuation, when initialQuantity is not specified".

This parameter is relevant only on consumer side.

getContinuationStorage

public Hl7v3ContinuationStorage getContinuationStorage()

Consumer-side only: Storage bean for continuation fragments.

This parameter is relevant only on consumer side.

isValidationOnContinuation

public boolean isValidationOnContinuation()

Whether the system should validate messages which are internally handled when performing HL7v3 interactive continuation. true when messages, which are internally handled when performing HL7v3 interactive continuation, should be validated.