summary> This class extends the [logic_error] exception class. More...

#include <AbstractFilter.h>

Inheritance diagram for FinTP::AbstractFilter:

Public Types
enum	FilterResult { Completed = 1, Fail = 2 }
	Return completed if the filter has successfully processed the message. More...

enum	FilterMethod { XmlToXml = 0, XmlToBuffer = 1, BufferToXml = 2, BufferToBuffer = 3 }
	Methods for filters. More...

typedef WorkItem< ManagedBuffer >	buffer_type

Public Member Functions
virtual	~AbstractFilter ()
	Destructor. More...

virtual bool	canLogPayload ()

virtual FilterResult	ProcessMessage (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *inputOutputData, NameValueCollection &transportHeaders, bool asClient)=0

virtual FilterResult	ProcessMessage (const XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *inputData, AbstractFilter::buffer_type outputData, NameValueCollection &transportHeaders, bool asClient)=0

virtual FilterResult	ProcessMessage (AbstractFilter::buffer_type inputData, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *outputData, NameValueCollection &transportHeaders, bool asClient)=0

virtual FilterResult	ProcessMessage (AbstractFilter::buffer_type inputData, AbstractFilter::buffer_type outputData, NameValueCollection &transportHeaders, bool asClient)=0

virtual FilterResult	ProcessMessage (const XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument inputData, unsigned char *outputData, NameValueCollection &transportHeaders, bool asClient)=0

virtual FilterResult	ProcessMessage (AbstractFilter::buffer_type inputData, unsigned char **outputData, NameValueCollection &transportHeaders, bool asClient)=0

virtual bool	isMethodSupported (FilterMethod method, bool asClient)

const NameValueCollection &	getProperties () const

void	setLogFile (const string &filename)
	sets the name of the file where the payload will be logged More...

string	getLogFile () const
	gets the name of the file where the payload will be logged More...

virtual bool	isTransportType ()

void	addProperty (const string &name, const string &value)

FilterType::FilterTypeEnum	getFilterType () const

virtual void	Init ()

virtual void	Rollback ()

virtual void	Commit ()

virtual void	Abort ()

virtual bool	isBatch () const

virtual string	getQueueManagerName () const

virtual string	getTransportURI () const

virtual string	getQueueName () const

Static Public Member Functions
static string	ToString (const FilterMethod type)

Protected Member Functions
	AbstractFilter (FilterType::FilterTypeEnum type)
	Constructor. More...

Protected Attributes
NameValueCollection	m_Properties
	Collection of name-value pairs = additional properties for the filter e.g. More...

FilterType::FilterTypeEnum	m_FilterType

string	m_LogPayloadFile

Detailed Description

summary> This class extends the [logic_error] exception class.

Base class for filters.

Should be used if a Filter does not support a certain processing mode ex. if the Filter does not support BufferToBuffer, it throws this exception. /summary>

Note for overrides : Always call base constructor in your derived classes

Author: Horia Beschea

Member Typedef Documentation

typedef WorkItem< ManagedBuffer > FinTP::AbstractFilter::buffer_type

Member Enumeration Documentation

enum FinTP::AbstractFilter::FilterMethod

Methods for filters.

Enumerator
XmlToXml
XmlToBuffer
BufferToXml
BufferToBuffer

enum FinTP::AbstractFilter::FilterResult

Return completed if the filter has successfully processed the message.

Enumerator
Completed
Fail

Constructor & Destructor Documentation

virtual FinTP::AbstractFilter::~AbstractFilter ( )

inlinevirtual

Destructor.

FinTP::AbstractFilter::AbstractFilter ( FilterType::FilterTypeEnum type )

inlineexplicitprotected

Constructor.

Parameters

type	Type of the filter to construct

Member Function Documentation

virtual void FinTP::AbstractFilter::Abort ( )

inlinevirtual

Reimplemented in FinTP::MqFilter, and FinTP::FilterChain.

void AbstractFilter::addProperty	(	const string &	name,
		const string &	value
	)

bool AbstractFilter::canLogPayload ( )

virtual

Reimplemented in FinTP::MqFilter, FinTP::Base64Filter, FinTP::TemplateTransformFilter, FinTP::XSLTFilter, FinTP::FilterChain, FinTP::SwiftFormatFilter, FinTP::SAAFilter, FinTP::XSDFilter, and FinTP::ZipFilter.

virtual void FinTP::AbstractFilter::Commit ( )

inlinevirtual

Reimplemented in FinTP::MqFilter, FinTP::FilterChain, and FinTP::SAAFilter.

FilterType::FilterTypeEnum FinTP::AbstractFilter::getFilterType ( ) const

inline

string AbstractFilter::getLogFile ( ) const

gets the name of the file where the payload will be logged

const NameValueCollection & AbstractFilter::getProperties ( ) const

virtual string FinTP::AbstractFilter::getQueueManagerName ( ) const

inlinevirtual

Reimplemented in FinTP::MqFilter.

virtual string FinTP::AbstractFilter::getQueueName ( ) const

inlinevirtual

Reimplemented in FinTP::MqFilter.

virtual string FinTP::AbstractFilter::getTransportURI ( ) const

inlinevirtual

Reimplemented in FinTP::MqFilter.

virtual void FinTP::AbstractFilter::Init ( )

inlinevirtual

Reimplemented in FinTP::MqFilter.

virtual bool FinTP::AbstractFilter::isBatch ( ) const

inlinevirtual

Reimplemented in FinTP::MqFilter.

bool AbstractFilter::isMethodSupported	(	AbstractFilter::FilterMethod	method,
		bool	asClient
	)

virtual

Reimplemented in FinTP::P7MFilter, FinTP::MqFilter, FinTP::Base64Filter, FinTP::TemplateTransformFilter, FinTP::SSLFilter, FinTP::CSVFilter, FinTP::XSLTFilter, FinTP::SwiftFormatFilter, FinTP::XSDFilter, FinTP::SAAFilter, and FinTP::ZipFilter.

virtual bool FinTP::AbstractFilter::isTransportType ( )

inlinevirtual

Reimplemented in FinTP::MqFilter.

virtual FilterResult FinTP::AbstractFilter::ProcessMessage	(	XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *	inputOutputData,
		NameValueCollection &	transportHeaders,
		bool	asClient
	)

pure virtual

Implemented in FinTP::P7MFilter, FinTP::SSLFilter, FinTP::Base64Filter, FinTP::MqFilter, FinTP::XSLTFilter, FinTP::FilterChain, FinTP::XSDFilter, FinTP::SwiftFormatFilter, FinTP::SAAFilter, FinTP::TemplateTransformFilter, FinTP::ZipFilter, and FinTP::CSVFilter.

virtual FilterResult FinTP::AbstractFilter::ProcessMessage	(	const XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *	inputData,
		AbstractFilter::buffer_type	outputData,
		NameValueCollection &	transportHeaders,
		bool	asClient
	)

pure virtual

Implemented in FinTP::P7MFilter, FinTP::Base64Filter, FinTP::SSLFilter, FinTP::MqFilter, FinTP::XSLTFilter, FinTP::FilterChain, FinTP::XSDFilter, FinTP::SwiftFormatFilter, FinTP::TemplateTransformFilter, FinTP::SAAFilter, FinTP::CSVFilter, and FinTP::ZipFilter.

virtual FilterResult FinTP::AbstractFilter::ProcessMessage	(	AbstractFilter::buffer_type	inputData,
		XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *	outputData,
		NameValueCollection &	transportHeaders,
		bool	asClient
	)

pure virtual

Implemented in FinTP::Base64Filter, FinTP::P7MFilter, FinTP::MqFilter, FinTP::SSLFilter, FinTP::XSLTFilter, FinTP::XSDFilter, FinTP::FilterChain, FinTP::ZipFilter, FinTP::SwiftFormatFilter, FinTP::SAAFilter, FinTP::TemplateTransformFilter, and FinTP::CSVFilter.

virtual FilterResult FinTP::AbstractFilter::ProcessMessage	(	AbstractFilter::buffer_type	inputData,
		AbstractFilter::buffer_type	outputData,
		NameValueCollection &	transportHeaders,
		bool	asClient
	)

pure virtual

Implemented in FinTP::Base64Filter, FinTP::P7MFilter, FinTP::MqFilter, FinTP::SSLFilter, FinTP::XSLTFilter, FinTP::XSDFilter, FinTP::ZipFilter, FinTP::FilterChain, FinTP::SwiftFormatFilter, FinTP::SAAFilter, FinTP::TemplateTransformFilter, and FinTP::CSVFilter.

virtual FilterResult FinTP::AbstractFilter::ProcessMessage	(	const XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *	inputData,
		unsigned char **	outputData,
		NameValueCollection &	transportHeaders,
		bool	asClient
	)

pure virtual

Implemented in FinTP::P7MFilter, FinTP::Base64Filter, FinTP::SSLFilter, FinTP::MqFilter, FinTP::XSLTFilter, FinTP::FilterChain, FinTP::XSDFilter, FinTP::TemplateTransformFilter, FinTP::SwiftFormatFilter, FinTP::CSVFilter, FinTP::SAAFilter, and FinTP::ZipFilter.

virtual FilterResult FinTP::AbstractFilter::ProcessMessage	(	AbstractFilter::buffer_type	inputData,
		unsigned char **	outputData,
		NameValueCollection &	transportHeaders,
		bool	asClient
	)

pure virtual

Implemented in FinTP::P7MFilter, FinTP::Base64Filter, FinTP::SSLFilter, FinTP::MqFilter, FinTP::XSDFilter, FinTP::XSLTFilter, FinTP::FilterChain, FinTP::ZipFilter, FinTP::TemplateTransformFilter, FinTP::SwiftFormatFilter, FinTP::SAAFilter, and FinTP::CSVFilter.

virtual void FinTP::AbstractFilter::Rollback ( )

inlinevirtual

Reimplemented in FinTP::MqFilter, FinTP::FilterChain, and FinTP::SAAFilter.

void AbstractFilter::setLogFile ( const string & filename )

sets the name of the file where the payload will be logged

string AbstractFilter::ToString ( const FilterMethod type )

static

Member Data Documentation

FilterType::FilterTypeEnum FinTP::AbstractFilter::m_FilterType

protected

string FinTP::AbstractFilter::m_LogPayloadFile

protected

NameValueCollection FinTP::AbstractFilter::m_Properties

protected

Collection of name-value pairs = additional properties for the filter e.g.

XLSTFILE="blabla.xslt" or MQQUEUE="myqueue" ...

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation