oracle.hsgbu.hdr.ihe.xdsb.configuration

Interface IHEXDSConfigService

public interface IHEXDSConfigService

Provides a set of APIs to configure profile options used by HDR as an XDS.b Document Repository actor.

Method Summary

Modifier and Type	Method and Description
void	configureRegistryAsyncURL(String registryAsyncURL) Configuration API to configure the Asynchronous XDS.b webservice endpoint of document registry.
void	configureRegistryServerDetails(String registryURL) Configuration API to configure the XDS.b registry server host name and port number that will be used by HDR's XDS.b repository for sending XDS.b document registry messages.
void	configureRepositoryUniqueId(String repositoryUniqueId) Configuration API to configure the HDR XDS.b repository unique id.
void	configureSyslogAuditServerDetails(String syslogServerHost, String syslogServerPort, String transportProtocol) Configuration API to configure the syslog audit server host name, port number, and transport protocol name (TLS or UDP).
void	configureWSAtomicTransactionProtocol(boolean enableWSATProtocol) Configuration API to enable the WS-Atomic Transaction protocol.

Method Detail

configureRegistryServerDetails

void configureRegistryServerDetails(String registryURL)
                             throws oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException

Configuration API to configure the XDS.b registry server host name and port number that will be used by HDR's XDS.b repository for sending XDS.b document registry messages.

Parameters:

registryURL - - The HTTP/HTTPS URL of the XDS.b registry server including the port number. This should be the webservice end point for the XDS.b registry webservice call.

Throws:

oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException - When configuration fails.

configureSyslogAuditServerDetails

void configureSyslogAuditServerDetails(String syslogServerHost,
                                       String syslogServerPort,
                                       String transportProtocol)
                                throws oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException

Configuration API to configure the syslog audit server host name, port number, and transport protocol name (TLS or UDP). HDR's XDS.b supports TLS or UDP for transporting audit messages. The format of syslog messages generated complies with standard RFC 5426. Note that if you are using TLS, make sure that keystore & truststore are properly configured in ihe_xdsb_config.xml

Parameters:

syslogServerHost - - The host name or IP address of the syslog audit server.

syslogServerPort - - The TLS/UDP port number of the syslog audit server.

transportProtocol - - The protocol used to transport the audit messages - TLS or UDP

Throws:

oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException - When configuration fails.

configureRepositoryUniqueId

void configureRepositoryUniqueId(String repositoryUniqueId)
                          throws oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException

Configuration API to configure the HDR XDS.b repository unique id. The repository unique id will be added to the XDS.b Register Document Set-b messages generated by HDR XDS.b repository. Also incoming requests for Retrieve Document Set-b will be validated to check if the repository unique id in the request matches the configured repository unique id.

Parameters:

repositoryUniqueId - - The repository unique id for HDR XDS.b repository in URI format.

Throws:

oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException - When configuration fails.

configureRegistryAsyncURL

void configureRegistryAsyncURL(String registryAsyncURL)
                        throws oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException

Configuration API to configure the Asynchronous XDS.b webservice endpoint of document registry. This endpoint will be used by HDR's XDS.b repository for sending XDS.b document registry messages.

Parameters:

registryAsyncURL - - The HTTP/HTTPS URL of the Asynchronous XDS.b registry server including the port number. This should be the webservice end point for the Asynchronous XDS.b registry webservice call.

Throws:

oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException - When configuration fails.

configureWSAtomicTransactionProtocol

void configureWSAtomicTransactionProtocol(boolean enableWSATProtocol)
                                   throws oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException

Configuration API to enable the WS-Atomic Transaction protocol. HDR depends on this parameter value to enable WS-Atomic Transaction protocol while invoking the Document Registry. In case the WS-Atomic Transaction protocol is enabled, HDR attaches WS-Atomic Transaction protocol related SOAP headers to the IHE XDS.b ITI-42 Register Document Set-b SOAP message

Parameters:

enableWSATProtocol - - enable or disable the WS-Atomic Transaction protocol

Throws:

oracle.hsgbu.hdr.ihe.xdsb.configuration.exception.IHEXDSConfigException - When configuration fails.