Class TransferRequestElement

java.lang.Object

org.kopi.ebics.xml.DefaultEbicsRootElement

org.kopi.ebics.xml.TransferRequestElement

All Implemented Interfaces:

Serializable, EbicsElement, EbicsRootElement

Direct Known Subclasses:

DownloadTransferRequestElement, UploadTransferRequestElement

public abstract class TransferRequestElement
extends DefaultEbicsRootElement

The TransferRequestElement is the common root element for all ebics transfer for the bank server.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	lastSegment
protected int	segmentNumber
protected byte[]	transactionId

Fields inherited from class DefaultEbicsRootElement

document, session

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransferRequestElement(EbicsSession session, String name, EbicsOrderType type, int segmentNumber, boolean lastSegment, byte[] transactionId)	Constructs a new TransferRequestElement element.

Method Summary

Modifier and Type	Method	Description
void	build()	Builds the EbicsElement XML fragment
abstract void	buildTransfer()	Builds the transfer request.
byte[]	getDigest()	Returns the digest value of the authenticated XML portions.
String	getName()	Returns the name of this EbicsElement
String	getOrderType()	Returns the order type of the element.
byte[]	toByteArray()	Converts the EbicsElement to a byte array

Methods inherited from class DefaultEbicsRootElement

addNamespaceDecl, generateName, generateName, insertSchemaLocation, prettyPrint, print, save, setSaveSuggestedPrefixes, toPrettyString, toString, validate

Methods inherited from class Object

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

Field Details

segmentNumber

protected int segmentNumber

lastSegment

protected boolean lastSegment

transactionId

protected byte[] transactionId

Constructor Details

TransferRequestElement

protected TransferRequestElement(EbicsSession session,
 String name,
 EbicsOrderType type,
 int segmentNumber,
 boolean lastSegment,
 byte[] transactionId)

Constructs a new TransferRequestElement element.

Parameters:

session - the current ebics session

name - the element name

type - the order type

segmentNumber - the segment number to be sent

lastSegment - is it the last segment?

transactionId - the transaction ID

Method Details

build

public void build()
           throws EbicsException

Description copied from interface: EbicsElement

Builds the EbicsElement XML fragment

Throws:

EbicsException

getName

public String getName()

Description copied from interface: EbicsElement

Returns the name of this EbicsElement

Returns:

the name of the element

getDigest

public byte[] getDigest()
                 throws EbicsException

Returns the digest value of the authenticated XML portions.

Returns:

the digest value.

Throws:

EbicsException - Failed to retrieve the digest value.

getOrderType

public String getOrderType()

Returns the order type of the element.

Returns:

the order type element.

toByteArray

public byte[] toByteArray()

Description copied from interface: EbicsRootElement

Converts the EbicsElement to a byte array

Specified by:

toByteArray in interface EbicsRootElement

Overrides:

toByteArray in class DefaultEbicsRootElement

Returns:

the equivalent byte array of this EbicsElement

buildTransfer

public abstract void buildTransfer()
                            throws EbicsException

Builds the transfer request.

Throws:

EbicsException