ee.ria.dhx.types

Class DhxPackage

java.lang.Object

ee.ria.dhx.types.DhxPackage

Direct Known Subclasses:

IncomingDhxPackage, OutgoingDhxPackage

public abstract class DhxPackage
extends java.lang.Object

DHX package object. Contains information needed for sending the document and for receiving the document. Cannot be instantiated by itself. Eiteher outgoing or incoming package must be instantiated

Author:

Aleksei Kokarev

Method Summary

Modifier and Type	Method and Description
InternalXroadMember	getClient() client represents the one who sent the document(document sender).
java.lang.String	getDhxProtocolVersion()
javax.activation.DataHandler	getDocumentFile() getDocumentFile.
java.lang.Object	getParsedContainer() Parsed container of the document(capsule).
CapsuleVersionEnum	getParsedContainerVersion() Version of the container that is parsed.
InternalXroadMember	getService() service represents the one to whom the document is being sent.
void	setClient(InternalXroadMember client) client represents the one who sent the document(document sender).
void	setDhxProtocolVersion(java.lang.String dhxProtocolVersion)
void	setDocumentFile(javax.activation.DataHandler documentFile) setDocumentFile.
void	setParsedContainer(java.lang.Object parsedContainer) Parsed container of the document(capsule).
void	setParsedContainerVersion(CapsuleVersionEnum parsedContainerVersion) Version of the container that is parsed.
void	setService(InternalXroadMember service) service represents the one to whom the document is being sent(adressee).
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getDhxProtocolVersion

public java.lang.String getDhxProtocolVersion()

Returns:

dhxProtocolVersion of the package being sent or received.

setDhxProtocolVersion

public void setDhxProtocolVersion(java.lang.String dhxProtocolVersion)

Parameters:

dhxProtocolVersion - - version of the DHX protocol which corresponds to the package.

getDocumentFile

public javax.activation.DataHandler getDocumentFile()

getDocumentFile.

Returns:

- datahandler of the file being sent or received

setDocumentFile

public void setDocumentFile(javax.activation.DataHandler documentFile)

setDocumentFile.

Parameters:

documentFile - - datahandler of the file being sent or received

getClient

public InternalXroadMember getClient()

client represents the one who sent the document(document sender). if it is outbound document then client represents self X-road member

Returns:

client

setClient

public void setClient(InternalXroadMember client)

client represents the one who sent the document(document sender). if it is outbound document then client is NULL.

Parameters:

client - - client represents the one who sent the document(document sender). if it is outbound document then client represents self X-road member

getService

public InternalXroadMember getService()

service represents the one to whom the document is being sent. if it is inbound document then service represents self X-road member.

Returns:

service

setService

public void setService(InternalXroadMember service)

service represents the one to whom the document is being sent(adressee). if it is inbound document then service represents self X-road member.

Parameters:

service - - xroad member of the recipient

getParsedContainer

public java.lang.Object getParsedContainer()

Parsed container of the document(capsule). Is of object type, because different capsule versions might be sent with different object types. Container is parsed only if container parsing is turned on in cofiguration, otherwise parsedConrtainer is NULL.

Returns:

parsedContainer

setParsedContainer

public void setParsedContainer(java.lang.Object parsedContainer)

Parsed container of the document(capsule). Is of object type, because different capsule versions might be sent with different object types. Container is parsed only if container parsing is turned on in cofiguration, otherwise parsedConrtainer is NULL.

Parameters:

parsedContainer - - Parsed container of the document(capsule)

getParsedContainerVersion

public CapsuleVersionEnum getParsedContainerVersion()

Version of the container that is parsed. Only filled if container parsing is turned on in configuration, otherwise is NULL.

Returns:

- parsed container object

setParsedContainerVersion

public void setParsedContainerVersion(CapsuleVersionEnum parsedContainerVersion)

Version of the container that is parsed. Only filled if container parsing is turned on in configuration, otherwise is NULL.

Parameters:

parsedContainerVersion - - parsed container version

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object