IT_Bus::Reference Class Reference

#include <it_bus/reference.h>

Inheritance diagram for IT_Bus::Reference:

IT_Bus::SequenceComplexType IT_Bus::ComplexType IT_Bus::AnyType IT_Bus::ImplementationDetails List of all members.

Detailed Description

Class representing a reference to a Web service.

Application code typically receives a Reference as part of a message exchange or else resolve ones from a Bus or a Service. A Reference contains all the information necessary in order to create a client proxy to the target Service.

A Reference represents a full Service so it may contain multiple ReferencePorts where each ReferencePort represent a WSDL Endpoint/Port.

Definition at line 297 of file reference.h.

Public Types

typedef IT_ReferenceReflection IT_ReflectionType

Public Member Functions

 Reference ()
 Constructor.
 Reference (const Reference &copy)
 Copy constructor.
virtual ~Reference ()
 Destructor.
IT_Bus::AnyTypecopy (const IT_Bus::AnyType &rhs)
 Returns a reference to an AnyType that is a copy of the AnyType parameter.
virtual const IT_Bus::QNameget_type () const
 Returns the IT_Bus::QName for the type.
virtual void write_contents (IT_Bus::ComplexTypeWriter &writer) const throw ((IT_Bus::SerializationException))
 Write the member values of the instance.
virtual void read_contents (IT_Bus::ComplexTypeReader &reader) throw ((IT_Bus::DeserializationException))
 Read the member values into the instance.
IT_Bus::ElementListT< IT_Bus::ReferencePort > & get_port ()
 Returns an list of all ReferencePorts represented by the Service.
const IT_Bus::ElementListT<
IT_Bus::ReferencePort > & 
get_port () const
 Returns an list of all ReferencePorts represented by the Service.
void set_port (const IT_Vector< IT_Bus::ReferencePort > &val)
 Allows a user to populate a Reference with the endpoint information by setting the ReferencePorts representing the Service.
IT_Bus::QNameget_service ()
 Returns the QName of the Service represented by the the Reference.
const IT_Bus::QNameget_service () const
 Returns the QName of the Service represented by the the Reference.
void set_service (const IT_Bus::QName &val)
 Allows a user to set the QName of the Service representing the Reference.
IT_Bus::Stringget_wsdl_location ()
 Returns a String which gives the user the location of WSDL that contains the Service meta-data for this Reference.
const IT_Bus::Stringget_wsdl_location () const
 Returns a String which gives the user the location of WSDL that contains the Service meta-data for this Reference.
void set_wsdl_location (const IT_Bus::String &val)
 Allows the usert to set the String which specifies the location of WSDL for the Service meta-data for this Reference.
virtual IT_Reflect::Reflectionget_reflection () throw ((IT_Reflect::ReflectException))
 Return an instance of the IT_Reflect::Reflection type that encapsulates this instance.
virtual const IT_Reflect::Reflectionget_reflection () const throw ((IT_Reflect::ReflectException))
 Return an instance of the IT_Reflect::Reflection type that encapsulates this instance.

Private Attributes

IT_Bus::ElementListT< IT_Bus::ReferencePortm_port
IT_Bus::QName m_service_name
IT_Bus::String m_wsdl_location
WSDL_Schema::tService * m_service
WS_Addressing::EndpointReferenceType m_endpoint_reference
bool m_populate_epr_from_reference

Friends

class IT_ReferenceReflection
class WS_Addressing::EndpointReferenceUtil


Member Function Documentation

IT_Bus::AnyType& IT_Bus::Reference::copy ( const IT_Bus::AnyType rhs  )  [virtual]

Returns a reference to an AnyType that is a copy of the AnyType parameter.

Derived classes override this method, providing an appropriate implementation. In this base class, this method is not supported; an exception is always thrown.

Parameters:
AnyType to be copied.
Returns:
A reference to AnyType.
Exceptions:
IT_Bus::Exception with message "Copy not supported"

Reimplemented from IT_Bus::AnyType.

virtual const IT_Bus::QName& IT_Bus::Reference::get_type (  )  const [virtual]

Returns the IT_Bus::QName for the type.

Derived subclasses implement this method and return their QName.

Returns:
IT_Bus::QName.

Implements IT_Bus::AnyType.

virtual void IT_Bus::Reference::write_contents ( IT_Bus::ComplexTypeWriter writer  )  const throw ((IT_Bus::SerializationException)) [virtual]

Write the member values of the instance.

Derived subclasses implement this method.

Implements IT_Bus::SequenceComplexType.

virtual void IT_Bus::Reference::read_contents ( IT_Bus::ComplexTypeReader reader  )  throw ((IT_Bus::DeserializationException)) [virtual]

Read the member values into the instance.

Derived subclasses implement this method.

Implements IT_Bus::SequenceComplexType.

IT_Bus::ElementListT<IT_Bus::ReferencePort>& IT_Bus::Reference::get_port (  ) 

Returns an list of all ReferencePorts represented by the Service.

Returns:
IT_Bus::ElementListT<IT_Bus::ReferencePort> &

const IT_Bus::ElementListT<IT_Bus::ReferencePort>& IT_Bus::Reference::get_port (  )  const

Returns an list of all ReferencePorts represented by the Service.

Returns:
const IT_Bus::ElementListT<IT_Bus::ReferencePort> &

void IT_Bus::Reference::set_port ( const IT_Vector< IT_Bus::ReferencePort > &  val  ) 

Allows a user to populate a Reference with the endpoint information by setting the ReferencePorts representing the Service.

Parameters:
const IT_Vector<IT_Bus::ReferencePort> & val

IT_Bus::QName& IT_Bus::Reference::get_service (  ) 

Returns the QName of the Service represented by the the Reference.

This would correspond to the QName in the WSDL

Returns:
QName &

const IT_Bus::QName& IT_Bus::Reference::get_service (  )  const

Returns the QName of the Service represented by the the Reference.

This would correspond to the QName in the WSDL

Returns:
const QName &

void IT_Bus::Reference::set_service ( const IT_Bus::QName val  ) 

Allows a user to set the QName of the Service representing the Reference.

This would correspond to the QName in the WSDL

Parameters:
const QName & value

IT_Bus::String& IT_Bus::Reference::get_wsdl_location (  ) 

Returns a String which gives the user the location of WSDL that contains the Service meta-data for this Reference.

The location is a URL

Returns:
String &

const IT_Bus::String& IT_Bus::Reference::get_wsdl_location (  )  const

Returns a String which gives the user the location of WSDL that contains the Service meta-data for this Reference.

The location is a URL

Returns:
const String &

void IT_Bus::Reference::set_wsdl_location ( const IT_Bus::String val  ) 

Allows the usert to set the String which specifies the location of WSDL for the Service meta-data for this Reference.

The location can be treated as a URL.

Parameters:
const String & val

virtual IT_Reflect::Reflection* IT_Bus::Reference::get_reflection (  )  throw ((IT_Reflect::ReflectException)) [virtual]

Return an instance of the IT_Reflect::Reflection type that encapsulates this instance.

Returns:
IT_Reflect::Reflection
Exceptions:
IT_Reflect::ReflectException 

Reimplemented from IT_Bus::AnyType.

virtual const IT_Reflect::Reflection* IT_Bus::Reference::get_reflection (  )  const throw ((IT_Reflect::ReflectException)) [virtual]

Return an instance of the IT_Reflect::Reflection type that encapsulates this instance.

Returns:
IT_Reflect::Reflection
Exceptions:
IT_Reflect::ReflectException 

Reimplemented from IT_Bus::AnyType.


Generated on Tue Mar 20 15:28:06 2007 for Artix by  doxygen 1.5.1-p1