IT_Bus::Bus Class Reference

#include <it_bus/bus.h>

Inheritance diagram for IT_Bus::Bus:

List of all members.

---

Detailed Description

The IT_Bus::Bus class manages a collection of plugins, which provide the underlying functional capabilities of a Bus application.

The Bus provides integration between the application components generated from the WSDL file and the Bus runtime environment.

Bus plugins provide functionality for data marshalling, transport specifics, security, implementation of and integration with enterprise services such as logging and session management, routing, and access to raw and encoded messages.

Definition at line 53 of file bus.h.

Public Member Functions
virtual void	run ()=0
	Put event processing into an infinite loop to prevent the current thread from exiting.
virtual void	shutdown (IT_Bool wait_for_completion)=0 throw ((IT_Bus::Exception))
	Destroy the Bus instance.
virtual IT_Bus::TransactionSystem &	transactions ()=0 throw ((IT_Bus::Exception))
	Access the Transaction subsystem supported by the Bus.
virtual ContextRegistry *	get_context_registry ()=0
	Obtain a pointer to the ContextRegistry.
virtual void	register_servant (Servant &servant, IT_WSDL::WSDLService &wsdl_service, const String &port_name=IT_BUS_ALL_PORTS)=0 throw ((IT_Bus::Exception))
	Register a servant with a specific service.
virtual void	register_servant (Servant &servant, const String &wsdl_location, const QName &service_name, const String &port_name=IT_BUS_ALL_PORTS)=0 throw ((Exception))
	Register a servant with a specific service.
virtual Service_ptr	register_transient_servant (Servant &servant, IT_WSDL::WSDLService &wsdl_service, const String &port_name=IT_BUS_ALL_PORTS)=0 throw ((IT_Bus::Exception))
	Register a servant with a specific transient service.
virtual Service_ptr	register_transient_servant (Servant &servant, const String &wsdl_location, const QName &service_name, const String &port_name=IT_BUS_ALL_PORTS)=0 throw ((Exception))
	Register a servant with a specific service.
virtual Service_ptr	add_service (IT_WSDL::WSDLService &wsdl_service)=0 throw ((IT_Bus::Exception))
	Add/create a service.
virtual Service_ptr	add_service (const String &wsdl_location, const QName &service_name)=0 throw ((Exception))
	Add/create a service.
virtual Service_ptr	add_transient_service (IT_WSDL::WSDLService &wsdl_service)=0 throw ((IT_Bus::Exception))
	Add/create a transient service.
virtual Service_ptr	add_transient_service (const String &wsdl_location, const QName &service_name)=0 throw ((Exception))
	Add/create a transient service.
virtual Service_ptr	get_service (const QName &service_name)=0
	Obtain a pointer to a specific service.
virtual void	remove_service (const QName &service_name)=0
	Inactivate and destroy a specific service.
virtual void	populate_endpoint_reference (const IT_WSDL::WSDLService &service, Reference &endpoint_reference)=0
	Create a Service Reference for a specific service.
virtual IT_Bus::Boolean	register_initial_reference (const Reference &service_reference)=0 throw ((Exception))
	Register a Service Reference with the Bus so that others can resolve it using Bus::resolve_initial_reference.
virtual IT_Bus::Boolean	unregister_initial_reference (const QName &service_name)=0 throw ((Exception))
	Remove the Reference from the Bus so that others can no longer resolve it using resolve_initial_reference.
virtual IT_Bus::Boolean	resolve_initial_reference (const QName &service_name, Reference &endpoint_reference)=0 throw ((Exception))
	Find or resolve a Service Reference for a specific service.
virtual void	populate_endpoint_reference (const IT_WSDL::WSDLService &service, WS_Addressing::EndpointReferenceType &epr_reference)=0
	Create EndpointReferenceType to a specific service.
virtual IT_Bus::Boolean	resolve_initial_reference (const QName &service_name, WS_Addressing::EndpointReferenceType &epr_reference)=0 throw ((Exception))
	Find or resolve a Service EndpointReferenceType for a specific service.
virtual IT_Bus::Boolean	register_initial_reference (const WS_Addressing::EndpointReferenceType &service_epr)=0 throw ((Exception))
	Register a Service EndpointReferenceType with the Bus so that others can resolve it using Bus::resolve_initial_reference.
virtual IT_WSDL::WSDLDefinitions_ptr	get_wsdl_model (const String &wsdl_location)=0 throw ((IT_WSDL::WSDLException))
	Return a pointer to the collection of objects that correspond to the in-memory representation of a WSDL file.
virtual IT_WSDL::WSDLService *	get_service_contract (const QName &service_name)=0 throw ((Exception))
	Return a pointer to object that corresponds to the in-memory representation of a specified Service.
virtual PDKBus *	get_pdk_bus ()=0
	Return a pointer to the PDKBus instance associated with this bus.
Static Public Member Functions
static Bus *	create_reference (CORBA::ORB *orb=0)
	Return a pointer to the active Bus.
static void	release_reference (Bus *bus)
	Release memory associated with Bus.
static Bus *	_duplicate (Bus *bus)
	Increment the reference count for the memory associated with the Bus and return a pointer to the Bus.
Protected Member Functions
	Bus ()
	Constructor.
virtual	~Bus ()
	Destructor.

---

Constructor & Destructor Documentation

IT_Bus::Bus::Bus

(

)

[protected]

Constructor.

Not called by application code. Applications initialize a Bus instance and obtain a pointer to the Bus instance by invoking the method IT_Bus::init, which is defined within the IT_Bus namespace in the file bus.h.

 Bus_var init(
   int& argc,
   char* argv[],
   const char* orb_identifier = ""
 );
 

virtual IT_Bus::Bus::~Bus

(

)

[protected, virtual]

Destructor.

Not called by application code. Applications destroy a Bus instance by invoking the method IT_Bus::shutdown, which is defined within the IT_Bus namespace in the file bus.h.

 void shutdown(
   IT_Bool wait_for_completion = true
 ) throw((IT_Bus::Exception));
 

---

Member Function Documentation

static Bus* IT_Bus::Bus::create_reference

(

CORBA::ORB *

orb = 0

)

[static]

Return a pointer to the active Bus.

Parameters:

Default

null.

Returns:

IT_Bus::Bus

static Bus* IT_Bus::Bus::_duplicate

(

Bus *

bus

)

[static]

Increment the reference count for the memory associated with the Bus and return a pointer to the Bus.

Parameters:

Pointer

to IT_Bus::Bus

Returns:

Pointer to IT_Bus::Bus

virtual void IT_Bus::Bus::run

(

)

[pure virtual]

Put event processing into an infinite loop to prevent the current thread from exiting.

It is not necessary to call run() to process incoming requests; run prevents the process from exiting. Once a servant is registered with the Bus, it will receive incoming requests.

virtual void IT_Bus::Bus::shutdown

(

IT_Bool

wait_for_completion

)

throw ((IT_Bus::Exception)) [pure virtual]

Destroy the Bus instance.

Parameters:

IT_Bool

indicating whether to delay return from this method until shutdown completes.

virtual IT_Bus::TransactionSystem& IT_Bus::Bus::transactions

(

)

throw ((IT_Bus::Exception)) [pure virtual]

Access the Transaction subsystem supported by the Bus.

This subsystem allows the caller to perform such actions as begin & end transactions, enlist transaction participants, register for transaction related notification events, assign transaction<->thread affinity etc. See IT_Bus::TransactionSystem interface for more details on the available operations.

Returns:

IT_Bus::TransactionSystem The transaction system supported by the Bus. This interface is used to initiate and complete transactional units of work.

virtual ContextRegistry* IT_Bus::Bus::get_context_registry

(

)

[pure virtual]

Obtain a pointer to the ContextRegistry.

Returns:

Pointer to the ContextRegistry

virtual void IT_Bus::Bus::register_servant	(	Servant &	servant,
		IT_WSDL::WSDLService &	wsdl_service,
		const String &	port_name = IT_BUS_ALL_PORTS
	)			throw ((IT_Bus::Exception)) [pure virtual]

Register a servant with a specific service.

Parameters:

	Servant	to be registered.
	IT_WSDL::WSDLService	object corresponding to the in-memory representation of the service.
	String	containing the port name through which the servant receives requests; default is to associate the servant with all ports within a service.

virtual void IT_Bus::Bus::register_servant	(	Servant &	servant,
		const String &	wsdl_location,
		const QName &	service_name,
		const String &	port_name = IT_BUS_ALL_PORTS
	)			throw ((Exception)) [pure virtual]

Register a servant with a specific service.

Parameters:

	Servant	to be registered.
	String	containing the path (absolute or relative) to the WSDL file describing the Web service.
	String	containing the port name through which the servant receives requests; default is to associate the servant with all ports within a service.

virtual Service_ptr IT_Bus::Bus::register_transient_servant	(	Servant &	servant,
		IT_WSDL::WSDLService &	wsdl_service,
		const String &	port_name = IT_BUS_ALL_PORTS
	)			throw ((IT_Bus::Exception)) [pure virtual]

Register a servant with a specific transient service.

Parameters:

	Servant	to be registered.
	IT_WSDL::WSDLService	object corresponding to the in-memory representation of the service.
	String	containing the port name through which the servant receives requests; default is to associate the servant with all ports within a service.

Returns:

A pointer to the Service.

virtual Service_ptr IT_Bus::Bus::register_transient_servant	(	Servant &	servant,
		const String &	wsdl_location,
		const QName &	service_name,
		const String &	port_name = IT_BUS_ALL_PORTS
	)			throw ((Exception)) [pure virtual]

Register a servant with a specific service.

Parameters:

	Servant	to be registered.
	String	containing the path (absolute or relative) to the WSDL file describing the Web service.
	String	containing the port name through which the servant receives requests; default is to associate the servant with all ports within a service.

Returns:

A pointer to the Service.

virtual Service_ptr IT_Bus::Bus::add_service

(

IT_WSDL::WSDLService &

wsdl_service

)

throw ((IT_Bus::Exception)) [pure virtual]

Add/create a service.

Use this method when the application must invoke the register_servant method directly on the Service class.

Parameters:

IT_WSDL::WSDLService

object corresponding to the in-memory representation of the service.

Returns:

A pointer to the Service.

virtual Service_ptr IT_Bus::Bus::add_service	(	const String &	wsdl_location,
		const QName &	service_name
	)			throw ((Exception)) [pure virtual]

Add/create a service.

Use this method when the application must invoke the register_servant method directly on the Service class.

Parameters:

	String	containing the path (absolute or relative) to the WSDL file describing the Web service.
	QName	for the service.

Returns:

A pointer to the Service.

virtual Service_ptr IT_Bus::Bus::add_transient_service

(

IT_WSDL::WSDLService &

wsdl_service

)

throw ((IT_Bus::Exception)) [pure virtual]

Add/create a transient service.

Use this method when the application must invoke the register_servant method directly on the Service class.

Parameters:

IT_WSDL::WSDLService

object corresponding to the in-memory representation of the service.

Returns:

A pointer to the Service.

virtual Service_ptr IT_Bus::Bus::add_transient_service	(	const String &	wsdl_location,
		const QName &	service_name
	)			throw ((Exception)) [pure virtual]

Add/create a transient service.

Use this method when the application must invoke the register_servant method directly on the Service class.

Parameters:

	String	containing the path (absolute or relative) to the WSDL file describing the Web service.
	QName	for the service.

Returns:

A pointer to the Service.

virtual Service_ptr IT_Bus::Bus::get_service

(

const QName &

service_name

)

[pure virtual]

Obtain a pointer to a specific service.

Parameters:

QName

of the desired service.

Returns:

Pointer to the Service.

virtual void IT_Bus::Bus::remove_service

(

const QName &

service_name

)

[pure virtual]

Inactivate and destroy a specific service.

Parameters:

QName

of the service to remove.

virtual void IT_Bus::Bus::populate_endpoint_reference	(	const IT_WSDL::WSDLService &	service,
		Reference &	endpoint_reference
	)			[pure virtual]

Create a Service Reference for a specific service.

Parameters:

	IT_WSDL::WSDLService	object corresponding to the in-memory representation of the service.
	Reference	to the Service; NOTE that this is an out parameter.

virtual IT_Bus::Boolean IT_Bus::Bus::register_initial_reference

(

const Reference &

service_reference

)

throw ((Exception)) [pure virtual]

Register a Service Reference with the Bus so that others can resolve it using Bus::resolve_initial_reference.

Parameters:

Reference

to the Service being registered.

virtual IT_Bus::Boolean IT_Bus::Bus::unregister_initial_reference

(

const QName &

service_name

)

throw ((Exception)) [pure virtual]

Remove the Reference from the Bus so that others can no longer resolve it using resolve_initial_reference.

This assumes that user has previously called Bus::register_initial_reference

Parameters:

Reference

to the Service being unregistered.

virtual IT_Bus::Boolean IT_Bus::Bus::resolve_initial_reference	(	const QName &	service_name,
		Reference &	endpoint_reference
	)			throw ((Exception)) [pure virtual]

Find or resolve a Service Reference for a specific service.

Parameters:

	QName	of the service to resolve/find.
	Reference	to the Service; NOTE that this is an out parameter and can not be used to instantiate a client proxy to communicate with the Service.

virtual void IT_Bus::Bus::populate_endpoint_reference	(	const IT_WSDL::WSDLService &	service,
		WS_Addressing::EndpointReferenceType &	epr_reference
	)			[pure virtual]

Create EndpointReferenceType to a specific service.

Parameters:

	IT_WSDL::WSDLService	object corresponding to the in-memory representation of the service.
	EndpointReferenceType	to the Service; NOTE that this is an out parameter.

virtual IT_Bus::Boolean IT_Bus::Bus::resolve_initial_reference	(	const QName &	service_name,
		WS_Addressing::EndpointReferenceType &	epr_reference
	)			throw ((Exception)) [pure virtual]

Find or resolve a Service EndpointReferenceType for a specific service.

Parameters:

	QName	of the service to resolve/find.
	EndpointReferenceType	to the Service; NOTE that this is an out parameter and can not be used to instantiate a client proxy to communicate with the Service.

virtual IT_Bus::Boolean IT_Bus::Bus::register_initial_reference

(

const WS_Addressing::EndpointReferenceType &

service_epr

)

throw ((Exception)) [pure virtual]

Register a Service EndpointReferenceType with the Bus so that others can resolve it using Bus::resolve_initial_reference.

Parameters:

EndpointReferenceType

to the Service being registered.

virtual IT_WSDL::WSDLDefinitions_ptr IT_Bus::Bus::get_wsdl_model

(

const String &

wsdl_location

)

throw ((IT_WSDL::WSDLException)) [pure virtual]

Return a pointer to the collection of objects that correspond to the in-memory representation of a WSDL file.

Use this method to programmatically parse a WSDL file, creating an in-memory representation.

Parameters:

String

containing the path (absolute or relative) to the WSDL file describing the Web service.

Returns:

Pointer to IT_WSDL::WSDLDefinitions.

virtual IT_WSDL::WSDLService* IT_Bus::Bus::get_service_contract

(

const QName &

service_name

)

throw ((Exception)) [pure virtual]

Return a pointer to object that corresponds to the in-memory representation of a specified Service.

Parameters:

QName

of the desired Service.

Returns:

Pointer to IT_WSDL::WSDLService.

virtual PDKBus* IT_Bus::Bus::get_pdk_bus

(

)

[pure virtual]

Return a pointer to the PDKBus instance associated with this bus.

The PDKBus implements some of the core and service functionality of the Bus class.

Returns:

A pointer to an instance of PDKBus.

---