#include <OperationContext.h>

Inheritance diagram for IdentityContainer:
OperationContext::Container

Public Member Functions

 IdentityContainer (const OperationContext::Container &container)
 
 IdentityContainer (const IdentityContainer &container)
 
 IdentityContainer (const String &userName)
 
virtual ~IdentityContainer ()
 
IdentityContaineroperator= (const IdentityContainer &container)
 
virtual String getName () const
 
virtual OperationContext::Containerclone () const
 
virtual void destroy ()
 
String getUserName () const
 
- Public Member Functions inherited from OperationContext::Container
virtual ~Container ()
 

Static Public Attributes

static const String NAME
 

Protected Attributes

IdentityContainerRep * _rep
 

Detailed Description

An IdentityContainer object holds the identity of a user associated with an operation. For example, a provider must use this Container to determine whether to perform an operation on the behalf of the requesting user.

Constructor & Destructor Documentation

◆ IdentityContainer() [1/3]

IdentityContainer::IdentityContainer ( const OperationContext::Container container)

Constructs an IdentityContainer object from the specified Container.

Parameters
containerThe Container object to copy.
Exceptions
DynamicCastFailedExceptionIf the specified Container object is not an IdentityContainer object.

◆ IdentityContainer() [2/3]

IdentityContainer::IdentityContainer ( const IdentityContainer container)

Constructs a copy of the specified IdentityContainer.

Parameters
containerThe IdentityContainer object to copy.

◆ IdentityContainer() [3/3]

IdentityContainer::IdentityContainer ( const String userName)

Constructs an IdentityContainer with a specified user name.

Parameters
userNameA String user name for this identity.

◆ ~IdentityContainer()

virtual IdentityContainer::~IdentityContainer ( )
virtual

Destructs the IdentityContainer.

Member Function Documentation

◆ clone()

virtual OperationContext::Container* IdentityContainer::clone ( ) const
virtual

Makes a copy of this IdentityContainer object. The caller is responsible for cleaning up the copy by calling destroy() method.

Returns
A pointer to the new Container object.

Implements OperationContext::Container.

◆ destroy()

virtual void IdentityContainer::destroy ( )
virtual

Cleans up an IdentityContainer object that was created by the clone() method.

Implements OperationContext::Container.

◆ getName()

virtual String IdentityContainer::getName ( ) const
virtual

Returns the unique name for this Container type.

Returns
The String name of the Container type.

Implements OperationContext::Container.

◆ getUserName()

String IdentityContainer::getUserName ( ) const

Gets the user name from the IdentityContainer object.

Returns
A String containing the user name identity.

◆ operator=()

IdentityContainer& IdentityContainer::operator= ( const IdentityContainer container)

Assigns the value of the specified IdentityContainer object to this object.

Parameters
containerThe IdentityContainer object to copy.

Member Data Documentation

◆ _rep

IdentityContainerRep* IdentityContainer::_rep
protected

An internal representation of the IdentityContainer attributes.

◆ NAME

const String IdentityContainer::NAME
static

The unique name for this container type.


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