IT_Bus::ReferencePort Class Reference

#include <it_bus/reference.h>

Inheritance diagram for IT_Bus::ReferencePort:

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

Detailed Description

Class representing a Web service endpoint/port.

The Reference class holds a ReferencePort for each port in a Service.

Application code typically should not need to access the ReferencePort API unless you need to query the contents of the Reference before using it or are trying to build a Reference by hand.

The ReferencePort holds information similar to the WSDL Port like the binding QName, the port name and extension elements representing endpoint information like addressing or other extensions relevant to the client contract.

Definition at line 62 of file reference.h.

Public Types

typedef IT_ReferencePortReflection IT_ReflectionType

Public Member Functions

 ReferencePort ()
 Constructor.
 ReferencePort (const ReferencePort &copy)
 Copy Constructor.
virtual ~ReferencePort ()
 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::AnyListget_any ()
 Returns a list of all the Extension elements from the ReferencePort.
const IT_Bus::AnyListget_any () const
 Returns a list of all the Extension elements from the ReferencePort.
void set_any (const IT_Vector< IT_Bus::Any > &val)
 When populating a ReferencePort a user can set all the Extension elements for the endpoint in the ReferencePort.
IT_Bus::NCNameget_name ()
 Returns the name of the Port.
const IT_Bus::NCNameget_name () const
 Returns the name of the Port.
void set_name (const IT_Bus::NCName &val)
 Allows user to set the name of the Port.
IT_Bus::QNameget_binding ()
 Returns the QName of the binding used by this endpoint/port.
const IT_Bus::QNameget_binding () const
 Returns the QName of the binding used by this endpoint/port.
void set_binding (const IT_Bus::QName &val)
 Allows users to populate a ReferencePort and set the value for the QName of the binding used by the endpoint/port.
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::AnyListm_any
IT_Bus::NCName m_name
IT_Bus::QName m_binding

Friends

class IT_ReferencePortReflection


Member Function Documentation

IT_Bus::AnyType& IT_Bus::ReferencePort::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::ReferencePort::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::ReferencePort::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::ReferencePort::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::AnyList& IT_Bus::ReferencePort::get_any (  ) 

Returns a list of all the Extension elements from the ReferencePort.

These elements are presented by Anys.

Returns:
IT_Bus::AnyList &

const IT_Bus::AnyList& IT_Bus::ReferencePort::get_any (  )  const

Returns a list of all the Extension elements from the ReferencePort.

These elements are presented by Anys.

Returns:
const IT_Bus::AnyList &

void IT_Bus::ReferencePort::set_any ( const IT_Vector< IT_Bus::Any > &  val  ) 

When populating a ReferencePort a user can set all the Extension elements for the endpoint in the ReferencePort.

These elements are presented by Anys.

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

IT_Bus::NCName& IT_Bus::ReferencePort::get_name (  ) 

Returns the name of the Port.

This typically corresponds to the WSDL Port name.

Returns:
IT_Bus::NCName &

const IT_Bus::NCName& IT_Bus::ReferencePort::get_name (  )  const

Returns the name of the Port.

This typically corresponds to the WSDL Port name.

Returns:
const IT_Bus::NCName &

void IT_Bus::ReferencePort::set_name ( const IT_Bus::NCName val  ) 

Allows user to set the name of the Port.

This typically corresponds to the WSDL Port name.

Parameters:
const IT_Bus::NCName &

IT_Bus::QName& IT_Bus::ReferencePort::get_binding (  ) 

Returns the QName of the binding used by this endpoint/port.

Returns:
IT_Bus::QName &

const IT_Bus::QName& IT_Bus::ReferencePort::get_binding (  )  const

Returns the QName of the binding used by this endpoint/port.

Returns:
const IT_Bus::QName &

void IT_Bus::ReferencePort::set_binding ( const IT_Bus::QName val  ) 

Allows users to populate a ReferencePort and set the value for the QName of the binding used by the endpoint/port.

Parameters:
const IT_Bus::QName & val

virtual IT_Reflect::Reflection* IT_Bus::ReferencePort::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::ReferencePort::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