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.
*/ public class MessageProp { // Fields. // ------------------------------------------------------------------------- private int qopVal; private boolean privState; private boolean duplicate; private boolean old; private boolean unseq; private boolean gap; private int minorStatus; private String minorString; // Constructors. // ------------------------------------------------------------------------- /** *Constructor which sets QOP to 0 indicating that the default QOP is * requested.
* * @param privState The desired privacy state. "true" for privacy and * "false" for integrity only. */ public MessageProp(boolean privState) { this(0, privState); } /** *Constructor which sets the values for the qop and privacy state.
* * @param qop The desired QOP. Use 0 to request a default QOP. * @param privState The desired privacy state. "true" for privacy and * "false" for integrity only. */ public MessageProp(int qop, boolean privState) { this.qopVal = qop; this.privState = privState; } // Instance methods. // ------------------------------------------------------------------------- /** * Retrieves the QOP value. * * @return The QOP value. */ public int getQOP() { return qopVal; } /** * Retrieves the privacy state. * * @return The privacy state. */ public boolean getPrivacy() { return privState; } /** * Retrieves the minor status that the underlying mechanism might have * set. * * @return The minor status. */ public int getMinorStatus() { return minorStatus; } /** * Returns a string explaining the mechanism specific error code. *null will be returned when no mechanism error code has
* been set.
*
* @return The minor status string.
*/
public String getMinorString()
{
return minorString;
}
/**
* Sets the QOP value.
*
* @param qopVal The QOP value to be set. Use 0 to request a default
* QOP value.
*/
public void setQOP(int qopVal)
{
this.qopVal = qopVal;
}
/**
* Sets the privacy state.
*
* @param privState The privacy state to set.
*/
public void setPrivacy(boolean privState)
{
this.privState = privState;
}
/**
* Returns "true" if this is a duplicate of an earlier token.
*
* @return True if this is a duplicate of an earlier token.
*/
public boolean isDuplicateToken()
{
return duplicate;
}
/**
* Returns "true" if the token's validity period has expired.
*
* @return True if the token's validity period has expired.
*/
public boolean isOldToken()
{
return old;
}
/**
* Returns "true" if a later token has already been processed.
*
* @return True if a later token has already been processed.
*/
public boolean isUnseqToken()
{
return unseq;
}
/**
* Returns "true" if an expected per-message token was not received.
*
* @return True if an expected per-message token was not received.
*/
public boolean isGapToken()
{
return gap;
}
/**
* 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.
*
* @param duplicate True if the token was a duplicate of an earlier
* token, false otherwise.
* @param old True if the token's validity period has expired,
* false otherwise.
* @param unseq True if a later token has already been processed,
* false otherwise.
* @param gap True if one or more predecessor tokens have not yet
* been successfully processed, false otherwise.
* @param minorStatus The integer minor status code that the underlying
* mechanism wants to set.
* @param minorString The textual representation of the minorStatus
* value.
*/
public void setSupplementaryStates(boolean duplicate, boolean old,
boolean unseq, boolean gap,
int minorStatus, String minorString)
{
this.duplicate = duplicate;
this.old = old;
this.unseq = unseq;
this.gap = gap;
this.minorStatus = minorStatus;
this.minorString = minorString;
}
}