org.ietf.jgss
public class MessageProp extends Object
This is a utility class used within the per-message {@link GSSContext} methods to convey per-message properties.
When used with the GSSContext interface's {@link GSSContext#wrap(byte[],int,int,org.ietf.jgss.MessageProp)} and {@link GSSContext#getMIC(byte[],int,int,org.ietf.jgss.MessageProp)} methods, an instance of this class is used to indicate the desired QOP and to request if confidentiality services are to be applied to caller supplied data (wrap only). To request default QOP, the value of 0 should be used for QOP.
When used with the {@link GSSContext#unwrap(byte[],int,int,org.ietf.jgss.MessageProp)} and {@link GSSContext#verifyMIC(byte[],int,int,byte[],int,int,org.ietf.jgss.MessageProp)} methods of the GSSContext interface, an instance of this class will be used to indicate the applied QOP and confidentiality services over the supplied message. In the case of verifyMIC, the confidentiality state will always be "false". Upon return from these methods, this object will also contain any supplementary status values applicable to the processed token. The supplementary status values can indicate old tokens, out of sequence tokens, gap tokens or duplicate tokens.
| Constructor Summary | |
|---|---|
| MessageProp(boolean privState) Constructor which sets QOP to 0 indicating that the default QOP is requested. | |
| MessageProp(int qop, boolean privState) Constructor which sets the values for the qop and privacy state. | |
| Method Summary | |
|---|---|
| int | getMinorStatus()
Retrieves the minor status that the underlying mechanism might have
set.
|
| String | getMinorString()
Returns a string explaining the mechanism specific error code.
|
| boolean | getPrivacy()
Retrieves the privacy state.
|
| int | getQOP()
Retrieves the QOP value.
|
| boolean | isDuplicateToken()
Returns "true" if this is a duplicate of an earlier token.
|
| boolean | isGapToken()
Returns "true" if an expected per-message token was not received.
|
| boolean | isOldToken()
Returns "true" if the token's validity period has expired.
|
| boolean | isUnseqToken()
Returns "true" if a later token has already been processed.
|
| void | setPrivacy(boolean privState)
Sets the privacy state.
|
| void | setQOP(int qopVal)
Sets the QOP value.
|
| void | setSupplementaryStates(boolean duplicate, boolean old, boolean unseq, boolean gap, int minorStatus, String minorString)
This method sets the state for the supplementary information flags
and the minor status in MessageProp. |
Constructor which sets QOP to 0 indicating that the default QOP is requested.
Parameters: privState The desired privacy state. "true" for privacy and "false" for integrity only.
Constructor which sets the values for the qop and privacy state.
Parameters: qop The desired QOP. Use 0 to request a default QOP. privState The desired privacy state. "true" for privacy and "false" for integrity only.
Returns: The minor status.
null will be returned when no mechanism error code has
been set.
Returns: The minor status string.
Returns: The privacy state.
Returns: The QOP value.
Returns: True if this is a duplicate of an earlier token.
Returns: True if an expected per-message token was not received.
Returns: True if the token's validity period has expired.
Returns: True if a later token has already been processed.
Parameters: privState The privacy state to set.
Parameters: qopVal The QOP value to be set. Use 0 to request a default QOP value.
Parameters: duplicate True if the token was a duplicate of an earlier token, false otherwise. old True if the token's validity period has expired, false otherwise. unseq True if a later token has already been processed, false otherwise. gap True if one or more predecessor tokens have not yet been successfully processed, false otherwise. minorStatus The integer minor status code that the underlying mechanism wants to set. minorString The textual representation of the minorStatus value.