| DCMTK Version 3.6.9
    OFFIS DICOM Toolkit | 
Class for User Identity Negotiation request user item. More...
 Inheritance diagram for UserIdentityNegotiationSubItemRQ:
 Inheritance diagram for UserIdentityNegotiationSubItemRQ:| 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. | |
| UserIdentityNegotiationSubItemRQ & | operator= (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 (const unsigned char itemType) | |
| Constructor. | |
| UserIdentityNegotiationSubItem (const UserIdentityNegotiationSubItem &src) | |
| Copy constructor. | |
| virtual unsigned char | getItemType () const | 
| Returns item type, which is 0x58 for requests, and 0x58 for acknowledgements. | |
| 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. | |
Class for User Identity Negotiation request user item.
| UserIdentityNegotiationSubItemRQ::UserIdentityNegotiationSubItemRQ | ( | const UserIdentityNegotiationSubItemRQ & | rhs | ) | 
Copy constructor, does a deep copy of a class instance.
| rhs | The class instance to copy from | 
References UserIdentityNegotiationSubItemRQ().
| 
 | virtual | 
Dump content of this user identity sub item to output stream.
| outstream | The stream to dump to | 
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.
| Uint16 UserIdentityNegotiationSubItemRQ::getPrimField | ( | char *& | resultBuf, | 
| Uint16 & | resultLen ) const | 
Returns content of primary field.
Memory is allocated by this function for resultBuf and must be freed by the caller.
| resultBuf | Returns content of primary field. NULL if not set. Memory of this buffer must be freed by the caller. | 
| resultLen | Returns length of returned buffer | 
| Uint16 UserIdentityNegotiationSubItemRQ::getSecField | ( | char *& | resultBuf, | 
| Uint16 & | resultLen ) const | 
Returns content of secondary field.
Memory is allocated by this function for resultBuf must be freed by the caller.
| resultBuf | Returns content of secondary field. NULL if not set. Memory of buffer must be freed by the caller. | 
| resultLen | Returns length of returned buffer | 
| 
 | inline | 
Informs (the server) whether a positive response was requested.
References m_posRspRequested.
| UserIdentityNegotiationSubItemRQ & UserIdentityNegotiationSubItemRQ::operator= | ( | const UserIdentityNegotiationSubItemRQ & | rhs | ) | 
Assignment operator, does a deep copy of a class instance.
| rhs | Right hand side of assignment | 
References UserIdentityNegotiationSubItemRQ().
| 
 | virtual | 
Parse sub item from buffer.
The buffer has to start with the correct user item type.
| readBuffer | The buffer to read from. The pointer to the buffer gets incremented by "bytesRead" bytes. | 
| bytesRead | Returns number of bytes read by this function | 
| availData | Size of the readBuffer | 
Implements UserIdentityNegotiationSubItem.
| 
 | virtual | 
Denotes that instance is part of a request (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.
| mode | Identification mode | 
| void UserIdentityNegotiationSubItemRQ::setPrimField | ( | const char * | buffer, | 
| const Uint16 | length ) | 
Sets content of primary field.
| buffer | Content of primary field | 
| length | Length of buffer | 
| void UserIdentityNegotiationSubItemRQ::setReqPosResponse | ( | const OFBool & | reqPosRsp | ) | 
Enables/disables requesting a positive response from the server.
| reqPosRsp | If OFTrue, a positive response is requested | 
| void UserIdentityNegotiationSubItemRQ::setSecField | ( | const char * | buffer, | 
| const Uint16 | length ) | 
Sets content of secondary field.
| buffer | Content of secondary field. | 
| length | Length of buffer | 
| 
 | virtual | 
Stream the package into a byte stream for network transmission.
| targetBuffer | The buffer to stream to. Must be big enough (must be allocated by caller). | 
| lengthWritten | Returns number of bytes written to buffer | 
Implements UserIdentityNegotiationSubItem.
| 
 | virtual | 
Computes total length of item if streamed into buffer.
| length | Returns the total length of the item in bytes | 
Implements UserIdentityNegotiationSubItem.