ee.ria.dhx.ws.service

Interface DhxPackageProviderService

All Known Implementing Classes:

DhxPackageProviderServiceImpl

public interface DhxPackageProviderService

Provides Dhx packages to send using DHX protocol. Multiple methods to get outgoing packages are provided. Besides the document that is being sent, package contains information about sender, recipient and consignmentId.

Author:

Aleksei Kokarev

Method Summary

Modifier and Type	Method and Description
java.util.List<ee.ria.dhx.types.OutgoingDhxPackage>	getOutgoingPackage(java.io.File capsuleFile, java.lang.String consignmentId) Deprecated. it is not always possible to define recipient from capsule recipient. For example if multiple subsystems are present. Use methods with defined recipient in input
java.util.List<ee.ria.dhx.types.OutgoingDhxPackage>	getOutgoingPackage(java.io.File capsuleFile, java.lang.String consignmentId, ee.ria.dhx.util.CapsuleVersionEnum version) Deprecated. it is not always possible to define recipient from capsule recipient. For example if multiple subsystems are present. Use methods with defined recipient in input
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.File capsuleFile, java.lang.String consignmentId, ee.ria.dhx.types.InternalXroadMember recipient) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.File capsuleFile, java.lang.String consignmentId, ee.ria.dhx.types.InternalXroadMember recipient, ee.ria.dhx.types.InternalXroadMember sender) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.File capsuleFile, java.lang.String consignmentId, ee.ria.dhx.types.InternalXroadMember recipient, ee.ria.dhx.types.InternalXroadMember sender, java.io.InputStream schemaStream, java.lang.String dhxProtocolVersion) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.File capsuleFile, java.lang.String consignmentId, java.lang.String recipientCode, java.lang.String recipientSystem) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.File capsuleFile, java.lang.String consignmentId, java.lang.String recipientCode, java.lang.String recipientSystem, java.lang.String senderSubsystem) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.File capsuleFile, java.lang.String consignmentId, java.lang.String recipientCode, java.lang.String recipientSystem, java.lang.String senderMemberCode, java.lang.String senderSubsystem) Get outgoing package.
java.util.List<ee.ria.dhx.types.OutgoingDhxPackage>	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId) Deprecated. it is not always possible to define recipient from capsule recipient. For example if multiple subsystems are present. Use methods with defined recipient in input
java.util.List<ee.ria.dhx.types.OutgoingDhxPackage>	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId, ee.ria.dhx.util.CapsuleVersionEnum version) Deprecated. it is not always possible to define recipient from capsule recipient. For example if multiple subsystems are present. Use methods with defined recipient in input
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId, ee.ria.dhx.types.InternalXroadMember recipient) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId, ee.ria.dhx.types.InternalXroadMember recipient, ee.ria.dhx.types.InternalXroadMember sender) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId, ee.ria.dhx.types.InternalXroadMember recipient, ee.ria.dhx.types.InternalXroadMember sender, java.io.InputStream schemaStream, java.lang.String dhxProtocolVersion) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId, java.lang.String recipientCode, java.lang.String recipientSystem) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId, java.lang.String recipientCode, java.lang.String recipientSystem, java.lang.String senderSubsystem) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId, java.lang.String recipientCode, java.lang.String recipientSystem, java.lang.String senderMemberCode, java.lang.String senderSubsystem) Get outgoing package.
ee.ria.dhx.types.OutgoingDhxPackage	getOutgoingPackage(java.io.InputStream capsuleStream, java.lang.String consignmentId, java.lang.String recipientCode, java.lang.String recipientSystem, java.lang.String senderMemberCode, java.lang.String senderSubsystem, java.io.InputStream schemaStream, java.lang.String dhxProtocolVersion) Get outgoing package.

Method Detail

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.File capsuleFile,
                                                       java.lang.String consignmentId,
                                                       ee.ria.dhx.types.InternalXroadMember recipient)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. Package recipient is defined in input. Default sender from configuration will be set as X-road sender. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleFile - - file to send

consignmentId - - consignment id of the document

recipient - - to whom the document is sent

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while creating package

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.File capsuleFile,
                                                       java.lang.String consignmentId,
                                                       ee.ria.dhx.types.InternalXroadMember recipient,
                                                       ee.ria.dhx.types.InternalXroadMember sender)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. Package recipient is defined in input. X-road sender is put from sender input parameter. Use this method if sender differs from the one configured as default(for example if sending from non default subsystem or if representee is sending the document). No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleFile - - file to send

consignmentId - - consignment id of the document

recipient - - to whom the document is sent

sender - - xroadMember representing sender of the document. Can be used if sender differs from the one from configuration or for example to send document from another(different from default configured) subsystem

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.InputStream capsuleStream,
                                                       java.lang.String consignmentId,
                                                       ee.ria.dhx.types.InternalXroadMember recipient,
                                                       ee.ria.dhx.types.InternalXroadMember sender)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. Package recipient is defined in input. Sender parameter will be put as X-road sender. Use this method if sender differs from the one configured as default(for example if sending from non default subsystem or if representee is sending the document). No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

recipient - - to whom the document is sent

sender - - xroadMember representing sender of the document. Can be used if sender differs from the one from configuration or for example to send document from another(different from default configured) subsystem

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.InputStream capsuleStream,
                                                       java.lang.String consignmentId,
                                                       ee.ria.dhx.types.InternalXroadMember recipient)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. Package recipient is defined in input. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

recipient - - to whom the document is sent

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.File capsuleFile,
                                                       java.lang.String consignmentId,
                                                       java.lang.String recipientCode,
                                                       java.lang.String recipientSystem)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. Package recipient is defined in input. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleFile - - file to send

consignmentId - - consignment id of the document

recipientCode - - to whom document is sent. registry code of the recipient or representee

recipientSystem - - system of the recipient to send to. NULL if sending to default DHX system.

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.File capsuleFile,
                                                       java.lang.String consignmentId,
                                                       java.lang.String recipientCode,
                                                       java.lang.String recipientSystem,
                                                       java.lang.String senderSubsystem)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. Package recipient is defined in input. senderSubsystem represents X-road subSystem which will used to send the document. Use this method if sending from same X-road member as configured but from non default subsystem. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleFile - - file to send

consignmentId - - consignment id of the document

recipientCode - - to whom document is sent. registry code of the recipient or representee

recipientSystem - - system of the recipient to send to. NULL if sending to default DHX system.

senderSubsystem - - X-road subsytem of the sender to use when sending the document

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.File capsuleFile,
                                                       java.lang.String consignmentId,
                                                       java.lang.String recipientCode,
                                                       java.lang.String recipientSystem,
                                                       java.lang.String senderMemberCode,
                                                       java.lang.String senderSubsystem)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. Package recipient is defined in input. Sender is defined in input by senderMemberCode and senderSubsystem. Use this method if sender differs from the configuder default. For example if sending from behalf of representee. No capsule parsing is done, only validation if it is enabled in configuration.XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleFile - - file to send

consignmentId - - consignment id of the document

recipientCode - - to whom document is sent. registry code of the recipient or representee

recipientSystem - - system of the recipient to send to. NULL if sending to default DHX system.

senderMemberCode - - X-road member code of the sender to use when sending the document

senderSubsystem - - X-road subsytem of the sender to use when sending the document

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.InputStream capsuleStream,
                                                       java.lang.String consignmentId,
                                                       java.lang.String recipientCode,
                                                       java.lang.String recipientSystem,
                                                       java.lang.String senderMemberCode,
                                                       java.lang.String senderSubsystem)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. No capsule parsing is done and package recipient is defined in input. Sender is defined in input by senderMemberCode and senderSubsystem. Use this method if sender differs from the configuder default. For example if sending from behalf of representee. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

recipientCode - - to whom document is sent. registry code of the recipient or representee

recipientSystem - - system of the recipient to send to. NULL if sending to default DHX system.

senderMemberCode - - X-road member code of the sender to use when sending the document

senderSubsystem - - X-road subsytem of the sender to use when sending the document

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.InputStream capsuleStream,
                                                       java.lang.String consignmentId,
                                                       java.lang.String recipientCode,
                                                       java.lang.String recipientSystem)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. No capsule parsing is done and package recipient is defined in input. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

recipientCode - - to whom document is sent. registry code of the recipient or representee

recipientSystem - - system of the recipient to send to. NULL if sending to default DHX system.

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.InputStream capsuleStream,
                                                       java.lang.String consignmentId,
                                                       java.lang.String recipientCode,
                                                       java.lang.String recipientSystem,
                                                       java.lang.String senderSubsystem)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. No capsule parsing is done and package recipient is defined in input. senderSubsystem represents X-road subSystem which will be used to send the document. Use this method if sending from same X-road member as configured but from non default subsystem. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

recipientCode - - to whom document is sent. registry code of the recipient or representee

recipientSystem - - system of the recipient to send to. NULL if sending to default DHX system.

senderSubsystem - - X-road subsytem of the sender to use when sending the document

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.InputStream capsuleStream,
                                                       java.lang.String consignmentId,
                                                       java.lang.String recipientCode,
                                                       java.lang.String recipientSystem,
                                                       java.lang.String senderMemberCode,
                                                       java.lang.String senderSubsystem,
                                                       java.io.InputStream schemaStream,
                                                       java.lang.String dhxProtocolVersion)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. No capsule parsing is done and package recipient is defined in input. Sender is defined in input by senderMemberCode and senderSubsystem. Use this method if sender differs from the configuder default. For example if sending from behalf of representee. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema from input is used for validation. Protocol version from input is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

recipientCode - - to whom document is sent. registry code of the recipient or representee

recipientSystem - - system of the recipient to send to. NULL if sending to default DHX system.

senderMemberCode - - X-road member code of the sender to use when sending the document

senderSubsystem - - X-road subsytem of the sender to use when sending the document

schemaStream - - stream of the XSD schema to use for capsule validation.

dhxProtocolVersion - - dhx protocol version to set to SOAP request that will be sent

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.InputStream capsuleStream,
                                                       java.lang.String consignmentId,
                                                       ee.ria.dhx.types.InternalXroadMember recipient,
                                                       ee.ria.dhx.types.InternalXroadMember sender,
                                                       java.io.InputStream schemaStream,
                                                       java.lang.String dhxProtocolVersion)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. No capsule parsing is done and package recipient is defined in input. Sender parameter will be put as X-road sender. Use this method if sender differs from the configuder default. For example if sending from behalf of representee. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema from input is used for validation. Protocol version from input is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

recipient - - to whom the document is sent

sender - - xroadMember representing sender of the document. Can be used if sender differs from the one from configuration or for example to send document from another(different from default configured) subsystem

schemaStream - - stream of the XSD schema to use for capsule validation.

dhxProtocolVersion - - dhx protocol version to set to SOAP request that will be sent

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

ee.ria.dhx.types.OutgoingDhxPackage getOutgoingPackage(java.io.File capsuleFile,
                                                       java.lang.String consignmentId,
                                                       ee.ria.dhx.types.InternalXroadMember recipient,
                                                       ee.ria.dhx.types.InternalXroadMember sender,
                                                       java.io.InputStream schemaStream,
                                                       java.lang.String dhxProtocolVersion)
                                                throws ee.ria.dhx.exception.DhxException

Get outgoing package. No capsule parsing is done and package recipient is defined in input. Sender parameter will be put as X-road sender. Use this method if sender differs from the configuder default. For example if sending from behalf of representee. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema from input is used for validation. Protocol version from input is used.

Parameters:

capsuleFile - - file to send

consignmentId - - consignment id of the document

recipient - - to whom the document is sent

sender - - xroadMember representing sender of the document. Can be used if sender differs from the one from configuration or for example to send document from another(different from default configured) subsystem

schemaStream - - stream of the XSD schema to use for capsule validation.

dhxProtocolVersion - - dhx protocol version to set to SOAP request that will be sent

Returns:

- OutgoingDhxPackage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

java.util.List<ee.ria.dhx.types.OutgoingDhxPackage> getOutgoingPackage(java.io.File capsuleFile,
                                                                       java.lang.String consignmentId)
                                                                throws ee.ria.dhx.exception.DhxException

Deprecated. it is not always possible to define recipient from capsule recipient. For example if multiple subsystems are present. Use methods with defined recipient in input

Get outgoing package. Parses capsule from file and creates package for each adressee defined in capsule. Uses default capsule version from configuration to parse capsule. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleFile - - file to send

consignmentId - - consignment id of the document

Returns:

- outgoing package list

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

java.util.List<ee.ria.dhx.types.OutgoingDhxPackage> getOutgoingPackage(java.io.File capsuleFile,
                                                                       java.lang.String consignmentId,
                                                                       ee.ria.dhx.util.CapsuleVersionEnum version)
                                                                throws ee.ria.dhx.exception.DhxException

Deprecated. it is not always possible to define recipient from capsule recipient. For example if multiple subsystems are present. Use methods with defined recipient in input

Parses capsule from file and sends document. Document is sent to every recipient defined in capsule. Uses default capsule version from configuration to parse capsule. No capsule parsing is done, only validation if it is enabled in configuration. XSD schema of current capsule defined in configuration is used to validate capsule. Protocol version from configuration is used.

Parameters:

capsuleFile - - file to send

consignmentId - - consignment id of the document

version - - version of the capsule to parse

Returns:

- outgoing package list

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

java.util.List<ee.ria.dhx.types.OutgoingDhxPackage> getOutgoingPackage(java.io.InputStream capsuleStream,
                                                                       java.lang.String consignmentId)
                                                                throws ee.ria.dhx.exception.DhxException

Deprecated. it is not always possible to define recipient from capsule recipient. For example if multiple subsystems are present. Use methods with defined recipient in input

Parses capsule from file and sends document. Document is sent to every recipient defined in capsule. Uses default capsule version from configuration to parse capsule. Protocol version from configuration is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

Returns:

- outgoing package list

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

getOutgoingPackage

java.util.List<ee.ria.dhx.types.OutgoingDhxPackage> getOutgoingPackage(java.io.InputStream capsuleStream,
                                                                       java.lang.String consignmentId,
                                                                       ee.ria.dhx.util.CapsuleVersionEnum version)
                                                                throws ee.ria.dhx.exception.DhxException

Deprecated. it is not always possible to define recipient from capsule recipient. For example if multiple subsystems are present. Use methods with defined recipient in input

Parses capsule from file and sends document. Document is sent to every recipient defined in capsule. Uses default capsule version from configuration to parse capsule. Protocol version from configuration is used.

Parameters:

capsuleStream - - stream to send

consignmentId - - consignment id of the document

version - - version of the capsule to parse

Returns:

- outgoing package list

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document