Implement AbstractFilter methods for base64 format. More...

#include <Base64Filter.h>

Inheritance diagram for FinTP::Base64Filter:

Public Member Functions
	Base64Filter ()
	Constructor. More...

	~Base64Filter ()
	Destructor. More...

bool	canLogPayload ()
	Return TRUE if the filter supports logging payload to a file. More...

bool	isMethodSupported (FilterMethod method, bool asClient)
	Return TRUE if the filter can execute the requested operation in client/server context. More...

AbstractFilter::FilterResult	ProcessMessage (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *inputOutputData, NameValueCollection &transportHeaders, bool asClient)
	Process message from XML to XML , encode if as client , decode if as server, using options from transportHeaders. More...

AbstractFilter::FilterResult	ProcessMessage (const XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *inputData, AbstractFilter::buffer_type outputData, NameValueCollection &transportHeaders, bool asClient)
	Process message from XML to Buffer , encode if as client , decode if as server, using options from transportHeaders. More...

AbstractFilter::FilterResult	ProcessMessage (AbstractFilter::buffer_type inputData, XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *outputData, NameValueCollection &transportHeaders, bool asClient)
	Process message from Buffer to XML , encode if as client , decode if as server, using options from transportHeaders. More...

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

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

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

Public Member Functions inherited from FinTP::AbstractFilter
virtual	~AbstractFilter ()
	Destructor. More...

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

Public Attributes
string	m_XPath
	Path to be used by Xalan to find value in input documnet More...

bool	m_KeepOriginal
	Keep or no the original text. More...

string	m_EncodedNodeName
	Name of the node where encoded data to be inserted. More...

Static Public Attributes
static const string	XPATH = "XPATH"
	Path to be used by Xalan to find value in input document More...

static const string	KEEP_ORIGINAL = "KeepOriginal"
	Keep or no the original text. More...

static const string	ENCODED_NODE_NAME = "EncodedNodeName"
	Name of the node where encoded data to be inserted. More...

Private Member Functions
void	ValidateProperties ()
	Validates required properties. More...

Additional Inherited Members
Public Types inherited from FinTP::AbstractFilter
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

Static Public Member Functions inherited from FinTP::AbstractFilter
static string	ToString (const FilterMethod type)

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

Protected Attributes inherited from FinTP::AbstractFilter
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

Implement AbstractFilter methods for base64 format.

Author: Horia Beschea

Constructor & Destructor Documentation

Base64Filter::Base64Filter ( )

Constructor.

Base64Filter::~Base64Filter ( )

Destructor.

Member Function Documentation

bool Base64Filter::canLogPayload ( )

virtual

Return TRUE if the filter supports logging payload to a file.

Note for overrides : return TRUE|FALSE if the payload can be read without rewinding ( not a stream )

Returns: TRUE if the filter supports logging payload to a file

Reimplemented from FinTP::AbstractFilter.

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

virtual

Return TRUE if the filter can execute the requested operation in client/server context.

Parameters

[in]	method	Method to test if supported
[in]	asClient	TRUE if run as client , FALSE if run as server

Returns: TRUE if the filter can execute the requested operation in client/server context

Reimplemented from FinTP::AbstractFilter.

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

virtual

Process message from XML to XML , encode if as client , decode if as server, using options from transportHeaders.

Parameters

[in,out]	inputOutputData	Data to be transform in Xerces DOMDocument format
[in]	transportHeaders	Collection of options and parameters for transform
[in]	asClient	TRUE if run as client , FALSE if run as server

Returns: AbstractFilter::Completed if successful

Implements FinTP::AbstractFilter.

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

virtual

Process message from XML to Buffer , encode if as client , decode if as server, using options from transportHeaders.

Parameters

[in]	inputData	Data to be transform in Xerces DOMDocument format
[out]	outputData	Data after transform in a buffer
[in]	transportHeaders	Collection of options and parameters for transform
[in]	asClient	TRUE if run as client , FALSE if run as server

Returns: AbstractFilter::Completed if successful

Implements FinTP::AbstractFilter.

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

virtual

Process message from Buffer to XML , encode if as client , decode if as server, using options from transportHeaders.

Parameters

[in]	inputData	Data to be transform in a buffer
[out]	outputData	Data after transform in Xerces DOMDocument format
[in]	transportHeaders	Collection of options and parameters for transform
[in]	asClient	TRUE if run as client , FALSE if run as server

Returns: AbstractFilter::Completed if successful

Implements FinTP::AbstractFilter.

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

inlinevirtual

Attention: Method Buffer to Buffer not supported by this filter

Implements FinTP::AbstractFilter.

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

inlinevirtual

Attention: Method XML to Buffer in char* format not supported by this filter

Implements FinTP::AbstractFilter.

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

inlinevirtual

Attention: Method Buffer to Buffer in char* format not supported by this filter

Implements FinTP::AbstractFilter.

void Base64Filter::ValidateProperties ( )

private

Validates required properties.

private methods implementation

Member Data Documentation

const string Base64Filter::ENCODED_NODE_NAME = "EncodedNodeName"

static

Name of the node where encoded data to be inserted.

const string Base64Filter::KEEP_ORIGINAL = "KeepOriginal"

static

Keep or no the original text.

string FinTP::Base64Filter::m_EncodedNodeName

Name of the node where encoded data to be inserted.

bool FinTP::Base64Filter::m_KeepOriginal

Keep or no the original text.

string FinTP::Base64Filter::m_XPath

Path to be used by Xalan to find value in input documnet

const string Base64Filter::XPATH = "XPATH"

static

Path to be used by Xalan to find value in input document

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

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation