org.ietf.jgss

Class MessageProp

  1. java.lang.Object
  2. extended byorg.ietf.jgss.MessageProp

  1. public class MessageProp
  2. extends java.lang.Object
This is a utility class used within the per-message GSSContext methods to convey per-message properties. When used with the GSSContext interface's wrap and getMIC 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 unwrap and verifyMIC 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.

Based on the IETF RFC-2853.

Author:
Thomas Owusu

Constructor Summary

Constructor and Description
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

Modifier and Type Method and Description
  1. int
getMinorStatus()
Retrieves the minor status that the underlying mechanism might have set.
  1. java.lang.String
getMinorString()
Returns a string explaining the mechanism specific error code.
  1. boolean
getPrivacy()
Retrieves the privacy state.
  1. int
getQOP()
Retrieves the QOP value.
  1. boolean
isDuplicateToken()
Returns "true" if this is a duplicate of an earlier token.
  1. boolean
isGapToken()
Returns "true" if an expected per-message token was not received.
  1. boolean
isOldToken()
Returns "true" if the token's validity period has expired.
  1. boolean
isUnseqToken()
Returns "true" if a later token has already been processed.
  1. void
setPrivacy(boolean priv)
Sets the privacy state.
  1. void
setQOP(int qop)
Sets the QOP value.
  1. void
setSupplementaryStates(boolean duplicate,boolean old,boolean unseq,boolean gap,int minorStatus,java.lang.String minorString)
This method sets the state for the supplementary information flags and the minor status in MessageProp.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageProp

  1. public MessageProp(boolean privState)
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.

MessageProp

  1. public MessageProp(int qop,
  2. boolean privState)
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.

Method Detail

getQOP

  1. public int getQOP()
Retrieves the QOP value.
Returns:
the QOP value.

getPrivacy

  1. public boolean getPrivacy()
Retrieves the privacy state.
Returns:
the privacy state.

getMinorStatus

  1. public int getMinorStatus()
Retrieves the minor status that the underlying mechanism might have set.
Returns:
the minor status code set by the underlying mechanism.

getMinorString

  1. public java.lang.String getMinorString( )
Returns a string explaining the mechanism specific error code. null will be returned when no mechanism error code has been set.
Returns:
string explaining the minor status code set by the underlying mechanism.

setQOP

  1. public void setQOP(int qop)
Sets the QOP value.

setPrivacy

  1. public void setPrivacy(boolean priv)
Sets the privacy state.

isDuplicateToken

  1. public boolean isDuplicateToken( )
Returns "true" if this is a duplicate of an earlier token.
Returns:
true if token is a duplicate, else false.

isOldToken

  1. public boolean isOldToken()
Returns "true" if the token's validity period has expired.
Returns:
true if token is old, else false.

isUnseqToken

  1. public boolean isUnseqToken()
Returns "true" if a later token has already been processed.
Returns:
true if the token is out of sequence, else false.

isGapToken

  1. public boolean isGapToken()
Returns "true" if an expected per-message token was not received.
Returns:
true if an expected per-message token wsa not received.

setSupplementaryStates

  1. public void setSupplementaryStates( boolean duplicate,
  2. boolean old,
  3. boolean unseq,
  4. boolean gap,
  5. int minorStatus,
  6. java.lang.String minorString)
This method sets the state for the supplementary information flags and the minor status in MessageProp. It is not used by the application but by the GSS implementation to return this information to the caller of a per-message context method.
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