IT_Bus::ContextRegistry Class Reference

#include <it_bus_pdk/context.h>

List of all members.

---

Detailed Description

Class that maintains a collection of built-in and application specific contexts.

The context registry manages an instance of the context current.

Definition at line 34 of file context.h.

Public Types
enum	ContextType
	Used to indentify the type of context that is being registered. More...
Public Member Functions
virtual ContextCurrent &	get_current ()=0
	Obtain a reference to the context current.
virtual Boolean	register_context (const QName &context_name, const QName &context_type, ContextType type=TYPE, Boolean is_header=false)=0
	Register a context with the registry.
virtual Boolean	register_context (const QName &context_name, const QName &context_type, const QName &message_name, const String &part_name)=0
	Register a context with the registry.
virtual Boolean	register_context_as_element (const QName &context_name, const QName &element_name, const QName &message_name, const String &part_name)=0
	Register a context with the registry.
virtual Boolean	register_context (const QName &context_name, const QName &context_type, const unsigned long context_id)=0
	Register a context with the registry.
virtual Boolean	register_context_data (const QName &context_name)=0
	Register a context with the registry.
virtual Boolean	is_registered (const QName &context_name)=0
	Return an indicator of whether a specific context is registered.
virtual ContextContainer *	get_configuration_context (const QName &service_name, const String &port_name, bool create_if_not_found=false)=0
	Obtain a pointer to the configuration context container.

---

Member Enumeration Documentation

enum IT_Bus::ContextRegistry::ContextType

Used to indentify the type of context that is being registered.

TYPE identifies the context as a type. ELEMENT identifies the context as a element.

Definition at line 46 of file context.h.

---

Member Function Documentation

virtual ContextCurrent& IT_Bus::ContextRegistry::get_current

(

)

[pure virtual]

Obtain a reference to the context current.

Returns:

A reference to the context current.

virtual Boolean IT_Bus::ContextRegistry::register_context	(	const QName &	context_name,
		const QName &	context_type,
		ContextType	type = TYPE,
		Boolean	is_header = false
	)			[pure virtual]

Register a context with the registry.

Use this method when registering a context that defines data to be shared between an application and the interceptor chain.

Parameters:

	QName	for the context.
	QName	for the data type contained within the context.
	ContextType	indicating the type of context being registered. Default is TYPE.
	Boolean	indicating whether this context represents header data. Default is false; functionality for true not yet implemented.

virtual Boolean IT_Bus::ContextRegistry::register_context	(	const QName &	context_name,
		const QName &	context_type,
		const QName &	message_name,
		const String &	part_name
	)			[pure virtual]

Register a context with the registry.

Use this method when registering a context that defines custom soap header data. The data may also be shared between an application and the interceptor chain. Use this API when the context is defined as a type in schema.

Parameters:

	QName	for the context.
	QName	for the data type contained within the context.
	QName	for the message with which the header is associated.
	String	containing the name of the message part representing the header data.

virtual Boolean IT_Bus::ContextRegistry::register_context_as_element	(	const QName &	context_name,
		const QName &	element_name,
		const QName &	message_name,
		const String &	part_name
	)			[pure virtual]

Register a context with the registry.

Use this method when registering a context that defines custom soap header data. The data may also be shared between an application and the interceptor chain. Use this API when the context is defined as an element in schema.

Parameters:

	QName	for the context.
	QName	for the data type contained within the context.
	QName	for the message with which the header is associated.
	String	containing the name of the message part representing the header data.

virtual Boolean IT_Bus::ContextRegistry::register_context	(	const QName &	context_name,
		const QName &	context_type,
		const unsigned long	context_id
	)			[pure virtual]

Register a context with the registry.

Use this method when registering a context that may be passed as an IOP::ServiceContext. The data may also be shared between an application and the interceptor chain.

Parameters:

	QName	for the context.
	QName	for the data type contained within the context.
	unsigned	long

virtual Boolean IT_Bus::ContextRegistry::register_context_data

(

const QName &

context_name

)

[pure virtual]

Register a context with the registry.

Use this method when registering a context that represents arbitrary data.

Parameters:

QName

for the context.

virtual Boolean IT_Bus::ContextRegistry::is_registered

(

const QName &

context_name

)

[pure virtual]

Return an indicator of whether a specific context is registered.

Returns:

Boolean flag indicating whether the desired context is registered.

virtual ContextContainer* IT_Bus::ContextRegistry::get_configuration_context	(	const QName &	service_name,
		const String &	port_name,
		bool	create_if_not_found = false
	)			[pure virtual]

Obtain a pointer to the configuration context container.

Returns:

A reference to the context container

---