Class EbicsMessage

Represents an EBICS request or response message.

Inheritance

System.Object

EbicsElement

EbicsMessage

EbicsRequest

EbicsResponse

Inherited Members

EbicsElement.BuildXmlDocument(EbicsVersion)

EbicsElement.Load(Stream, EbicsVersion)

EbicsElement.Load(String, EbicsVersion)

EbicsElement.Save(Stream, EbicsVersion)

EbicsElement.Save(String, EbicsVersion)

EbicsElement.FromBuffer(EbicsDataBuffer, EbicsVersion)

EbicsElement.ToBuffer(EbicsVersion)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Subsembly.EBICS

Assembly: Subsembly.EBICS.Core.dll

Syntax

public abstract class EbicsMessage : EbicsElement

Remarks

This EbicsElement implementation does not deal with authentication signatures. It only builds messages without authentication signatures and ignores authentication signatures during parsing. In order to create a message with authentication signature, the method BuildMessage(EbicsVersion, IEbicsSecurityOperations, EbicsSecurityCode) must be used. In order to parse a message and also to verify its authentication signature, the methods ParseMessage(XmlDocument) and VerifyAuthSignature(EbicsPubKeyInfo) must be used.

Constructors

EbicsMessage(String, Boolean)

Declaration

protected EbicsMessage(string sRootTag, bool fAuthSignature)

Parameters

Type	Name	Description
System.String	sRootTag
System.Boolean	fAuthSignature

Properties

AuthSignature

Indicates whether this message requires an authentication signature.

Declaration

public bool AuthSignature { get; }

Property Value

Type	Description
System.Boolean

DataTransfer

The data transfer element.

Declaration

public EbicsDataTransfer DataTransfer { get; set; }

Property Value

Type	Description
EbicsDataTransfer

LastSegment

Indicates the value of the lastSegment attribute included in the SegmentNumber of this message.

Declaration

public bool LastSegment { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

If no SegmentNumber is included in the message, then this property is fully ignored.

NumSegments

The NumSegments value included in the static header of this message.

Declaration

public int NumSegments { get; set; }

Property Value

Type	Description
System.Int32	The value -1 indicates that no NumSegments value was present/shall be included.

RootTag

The root tag of this message as it was given to its ctor.

Declaration

public string RootTag { get; }

Property Value

Type	Description
System.String

SegmentNumber

The SegmentNumber value included in the mutable header of this message.

Declaration

public int SegmentNumber { get; set; }

Property Value

Type	Description
System.Int32	The value -1 indicates that no SegmentNumber value was present/shall be included.

TransactionPhase

Declaration

public EbicsTransactionPhase TransactionPhase { get; set; }

Property Value

Type	Description
EbicsTransactionPhase

Version

The EBICS version used by this message.

Declaration

public EbicsVersion Version { get; }

Property Value

Type	Description
EbicsVersion

Methods

BuildBody(XmlElement, EbicsVersion)

Declaration

protected virtual void BuildBody(XmlElement xmlBody, EbicsVersion nVersion)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlBody
EbicsVersion	nVersion

Remarks

The base class just adds a DataTransfer element to the body.

BuildHeaderMutable(XmlElement, EbicsVersion)

Declaration

protected abstract void BuildHeaderMutable(XmlElement xmlMutable, EbicsVersion nVersion)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlMutable
EbicsVersion	nVersion

BuildHeaderStatic(XmlElement, EbicsVersion)

Declaration

protected abstract void BuildHeaderStatic(XmlElement xmlStatic, EbicsVersion nVersion)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlStatic
EbicsVersion	nVersion

BuildMessage(EbicsVersion, IEbicsSecurityOperations, EbicsSecurityCode)

Declaration

public XmlDocument BuildMessage(EbicsVersion nEbicsVersion, IEbicsSecurityOperations aSecurity, EbicsSecurityCode nAuthSecurityCode)

Parameters

Type	Name	Description
EbicsVersion	nEbicsVersion
IEbicsSecurityOperations	aSecurity
EbicsSecurityCode	nAuthSecurityCode

Returns

Type	Description
System.Xml.XmlDocument

BuildXml(XmlDocument, EbicsVersion)

Declaration

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

Type	Name	Description
System.Xml.XmlDocument	xmlDocument
EbicsVersion	nVersion

Returns

Type	Description
System.Xml.XmlElement

Overrides

EbicsElement.BuildXml(XmlDocument, EbicsVersion)

CreateMessage(String)

Creates an appropriately derived EbicsMessage from the given root tag.

Declaration

public static EbicsMessage CreateMessage(string sRootTag)

Parameters

Type	Name	Description
System.String	sRootTag

Returns

Type	Description
EbicsMessage

CreateMessage(XmlDocument)

Declaration

public static EbicsMessage CreateMessage(XmlDocument xmlDocument)

Parameters

Type	Name	Description
System.Xml.XmlDocument	xmlDocument

Returns

Type	Description
EbicsMessage

ParseBody(XmlElement, EbicsVersion)

Declaration

protected virtual void ParseBody(XmlElement xmlBody, EbicsVersion nVersion)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlBody
EbicsVersion	nVersion

ParseHeaderMutable(XmlElement, EbicsVersion)

Declaration

protected abstract void ParseHeaderMutable(XmlElement xmlMutable, EbicsVersion nVersion)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlMutable
EbicsVersion	nVersion

ParseHeaderStatic(XmlElement, EbicsVersion)

Declaration

protected abstract void ParseHeaderStatic(XmlElement xmlStatic, EbicsVersion nVersion)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlStatic
EbicsVersion	nVersion

ParseMessage(XmlDocument)

Declaration

public void ParseMessage(XmlDocument xmlDocument)

Parameters

Type	Name	Description
System.Xml.XmlDocument	xmlDocument

ParseXml(XmlElement, EbicsVersion)

Declaration

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The root element of the message.
EbicsVersion	nVersion	The EBICS version of the message. This must have been extracted from the root element's Version attribute.

Overrides

EbicsElement.ParseXml(XmlElement, EbicsVersion)

VerifyAuthSignature(EbicsPubKeyInfo)

Declaration

public bool VerifyAuthSignature(EbicsPubKeyInfo aAuthPubKey)

Parameters

Type	Name	Description
EbicsPubKeyInfo	aAuthPubKey	Authentication public key of the sender.

Returns

Type	Description
System.Boolean	If there was a valid authentication signature, then true is returned. If the message does not contain an authentication signature, then false is returned. If the message contains an invalid authentication signature, then a EbicsException is thrown.

Exceptions

Type	Condition
EbicsException	A contained authentication signature was invalid.