Interface IFinFilter

Interface to an implementation of a filter function that can be applied when transmitting and receiving FinTS messages.

Namespace: Subsembly.FinTS

Assembly: Subsembly.FinTS.Core.dll

Syntax

public interface IFinFilter

Properties

FilterFunction

The name of the filter function that is implemented by this filter.

Declaration

string FilterFunction { get; }

Property Value

Type	Description
System.String

Remarks

This is the name that appears in the HIKOM segment. At this time only the filter names MIM for base 64 encoding and UUE for UUencoding are defined. The HIKOM segment restricts this name to three characters.

FilterFunctionVersion

The version of the filter function that is implemented by this filter.

Declaration

int FilterFunctionVersion { get; }

Property Value

Type	Description
System.Int32

Remarks

This is not the version number of the implementation itself, but the specification version of the filter function according to FinTS. Currently this must always be 1.

Methods

FilteredOutputSize(Int32)

Computes the resulting size of the output data after applying this filter function.

Declaration

int FilteredOutputSize(int nMsgSize)

Parameters

Type	Name	Description
System.Int32	nMsgSize	The original size of the FinTS request message that shall be filtered by this filter before transmission.

Returns

Type	Description
System.Int32	The resulting size of the output data after applying this filter function.

InputFilter(Stream)

Creates a new instance of an input stream filter.

Declaration

Stream InputFilter(Stream aStream)

Parameters

Type	Name	Description
System.IO.Stream	aStream	Source stream that provides the raw data onto which the input filter function shall be applied. This stream must be readable. It is not required that this stream be seekable.

Returns

Type	Description
System.IO.Stream	A readable Stream is returned that filters all data from the source stream and provides the resulting data through its read functions. The returned stream is not seekable. The returned stream shall be used to read a single FinTS message only. After all message data has been read the stream must be closed.

OutputFilter(Stream)

Creates a new instance of an output stream filter.

Declaration

Stream OutputFilter(Stream aStream)

Parameters

Type	Name	Description
System.IO.Stream	aStream	Destination stream that ultimately receives the written data after the filter function was applied. This stream must be writable. It is not required that this stream be seekable.

Returns

Type	Description
System.IO.Stream	A writable Stream is returned that filters all written data and writes the resulting data to the given destination stream. The returned stream is not seekable. The returned stream shall be used to write a single FinTS message only. After all message data has been written to that stream it must be flushed and then closed.