OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Attributes
UserIdentityNegotiationSubItemRQ Class Reference

Class for User Identity Negotiation request user item. More...

Inheritance diagram for UserIdentityNegotiationSubItemRQ:
[legend]
Collaboration diagram for UserIdentityNegotiationSubItemRQ:
[legend]

List of all members.

Public Member Functions

 UserIdentityNegotiationSubItemRQ ()
 Constructor.
unsigned char pduType () const
 Denotes that instance is part of a request (DUL_TYPEASSOCIATERQ)
virtual void clear ()
 Clears member variables and frees memory.
void setIdentityType (const T_ASC_UserIdentityNegotiationMode &mode)
 Sets identity type to be used.
T_ASC_UserIdentityNegotiationMode getIdentityType ()
 Returns identity type that will be used.
void setPrimField (const char *buffer, const Uint16 &length)
 Sets content of primary field.
void setSecField (const char *buffer, const Uint16 &length)
 Sets content of secondary field.
Uint16 getPrimField (char *&resultBuf, Uint16 &resultLen) const
 Returns content of primary field.
Uint16 getSecField (char *&resultBuf, Uint16 &resultLen) const
 Returns content of secondary field.
void setReqPosResponse (const OFBool &reqPosRsp)
 Enables/disables requesting a positive response from the server.
OFBool isPosResponseRequested ()
 Informs (the server) whether a positive response was requested.
OFCondition stream (unsigned char *targetBuffer, unsigned long &lengthWritten) const
 Stream the package into a byte stream for network transmission.
OFCondition streamedLength (unsigned long &length) const
 Computes total length of item if streamed into buffer.
OFCondition parseFromBuffer (unsigned char *readBuffer, unsigned long &bytesRead, unsigned long availData)
 Parse sub item from buffer.
void dump (STD_NAMESPACE ostream &outstream) const
 Dump content of this user identity sub item to output stream.
UserIdentityNegotiationSubItemRQoperator= (const UserIdentityNegotiationSubItemRQ &rhs)
 Assignment operator, does a deep copy of a class instance.
 UserIdentityNegotiationSubItemRQ (const UserIdentityNegotiationSubItemRQ &rhs)
 Copy constructor, does a deep copy of a class instance.
 ~UserIdentityNegotiationSubItemRQ ()
 Destructor, nothing to clean up.
- Public Member Functions inherited from UserIdentityNegotiationSubItem
 UserIdentityNegotiationSubItem ()
 Constructor.
virtual unsigned char getItemType () const
 Returns item type, which is constantly 0x58.
virtual unsigned char getReserved () const
 Returns reserved field, which is 0 in this implementation (see DICOM standard)
virtual ~UserIdentityNegotiationSubItem ()
 Destructor, nothing to clean up.

Private Attributes

T_ASC_UserIdentityNegotiationMode m_userIdentityType
 User Identity Type: 1 (username), 2 (username/password), 3 (kerberos), 4 (SAML)
unsigned char m_posRspRequested
 If 1, positive response is requested from server. Set to 0 otherwise.
char * m_primField
 Buffer for primary value field.
Uint16 m_primFieldLength
 Length of primary value field in bytes.
char * m_secField
 Buffer for secondary value field.
Uint16 m_secFieldLength
 Length of primary value field in bytes.

Detailed Description

Class for User Identity Negotiation request user item.

Definition at line 133 of file dcuserid.h.


Constructor & Destructor Documentation

UserIdentityNegotiationSubItemRQ::UserIdentityNegotiationSubItemRQ ( const UserIdentityNegotiationSubItemRQ rhs)

Copy constructor, does a deep copy of a class instance.

Parameters:
rhs- [in] The class instance to copy from
Returns:
none

Member Function Documentation

virtual void UserIdentityNegotiationSubItemRQ::clear ( )
virtual

Clears member variables and frees memory.

Returns:
none

Implements UserIdentityNegotiationSubItem.

void UserIdentityNegotiationSubItemRQ::dump ( STD_NAMESPACE ostream &  outstream) const
virtual

Dump content of this user identity sub item to output stream.

Parameters:
outstream- [out] The stream to dump to
Returns:
none

Implements UserIdentityNegotiationSubItem.

T_ASC_UserIdentityNegotiationMode UserIdentityNegotiationSubItemRQ::getIdentityType ( )

Returns identity type that will be used.

At this time, user, user/password, kerberos and SAML are known.

Returns:
the identification mode
Uint16 UserIdentityNegotiationSubItemRQ::getPrimField ( char *&  resultBuf,
Uint16 &  resultLen 
) const

Returns content of primary field.

Memory is allocated by this function and must be freed by the caller.

Parameters:
buffer- [out] Content of primary field. NULL if not set. Memory of buffer must be freed by the caller.
length- [out] Length of returned buffer
Returns:
none
Uint16 UserIdentityNegotiationSubItemRQ::getSecField ( char *&  resultBuf,
Uint16 &  resultLen 
) const

Returns content of secondary field.

Memory is allocated by this function and must be freed by the caller.

Parameters:
buffer- [out] Content of secondary field. NULL if not set. Memory of buffer must be freed by the caller.
length- [out] Length of returned buffer
Returns:
none
OFBool UserIdentityNegotiationSubItemRQ::isPosResponseRequested ( )
inline

Informs (the server) whether a positive response was requested.

Returns:
OFTrue if a response was requested

Definition at line 210 of file dcuserid.h.

References m_posRspRequested.

UserIdentityNegotiationSubItemRQ& UserIdentityNegotiationSubItemRQ::operator= ( const UserIdentityNegotiationSubItemRQ rhs)

Assignment operator, does a deep copy of a class instance.

Parameters:
rhs- [in] Right hand side of assignment
Returns:
none
OFCondition UserIdentityNegotiationSubItemRQ::parseFromBuffer ( unsigned char *  readBuffer,
unsigned long &  bytesRead,
unsigned long  availData 
)
virtual

Parse sub item from buffer.

The buffer has to start with the correct user item type.

Parameters:
readBuffer- [in] The buffer to read from. The pointer to the buffer gets incremented by "bytesRead" bytes.
bytesRead- [out] Number of bytes read by this function
availData- [in] Size of the buffer.
Returns:
EC_Normal if successful, error code otherwise

Implements UserIdentityNegotiationSubItem.

unsigned char UserIdentityNegotiationSubItemRQ::pduType ( ) const
virtual

Denotes that instance is part of a request (DUL_TYPEASSOCIATERQ)

Returns:
DUL_TYPEASSOCIATERQ

Implements UserIdentityNegotiationSubItem.

void UserIdentityNegotiationSubItemRQ::setIdentityType ( const T_ASC_UserIdentityNegotiationMode &  mode)

Sets identity type to be used.

At this time, user, user/password, kerberos and SAML are known.

Parameters:
mode- [in] the identification mode
Returns:
none
void UserIdentityNegotiationSubItemRQ::setPrimField ( const char *  buffer,
const Uint16 &  length 
)

Sets content of primary field.

Parameters:
buffer- [in] Content of primary field.
length- [in] Length of buffer
Returns:
none
void UserIdentityNegotiationSubItemRQ::setReqPosResponse ( const OFBool &  reqPosRsp)

Enables/disables requesting a positive response from the server.

Parameters:
reqPosRsp- [in] If true, a positive response is requested
Returns:
none
void UserIdentityNegotiationSubItemRQ::setSecField ( const char *  buffer,
const Uint16 &  length 
)

Sets content of secondary field.

Parameters:
buffer- [in] Content of secondary field.
length- [in ] Length of buffer
Returns:
none
OFCondition UserIdentityNegotiationSubItemRQ::stream ( unsigned char *  targetBuffer,
unsigned long &  lengthWritten 
) const
virtual

Stream the package into a byte stream for network transmission.

Parameters:
targetBuffer- [out] The buffer to stream to. Must be big enough (not allocated in function).
lengthWritten- [out] Number of bytes written to buffer
Returns:
EC_Normal, if successful, error code otherwise

Implements UserIdentityNegotiationSubItem.

OFCondition UserIdentityNegotiationSubItemRQ::streamedLength ( unsigned long &  length) const
virtual

Computes total length of item if streamed into buffer.

Parameters:
length- [out] The total length of the item in bytes
Returns:
EC_Normal if successful, error code otherwise

Implements UserIdentityNegotiationSubItem.


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


Generated on Thu May 31 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.1