org.ietf.jgss
Class MessageProp

java.lang.Object
  org.ietf.jgss.MessageProp

public class MessageProp

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.

Component:

Security-Core

Field Summary

protected boolean	duplicate
protected boolean	gap
protected int	minorStatus
protected java.lang.String	minorString
protected boolean	old
protected boolean	privState
protected int	qop
protected boolean	unseq

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.
java.lang.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, java.lang.String minorString) This method sets the state for the supplementary information flags and the minor status in MessageProp.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

privState

protected boolean privState

qop

protected int qop

minorStatus

protected int minorStatus

minorString

protected java.lang.String minorString

duplicate

protected boolean duplicate

old

protected boolean old

unseq

protected boolean unseq

gap

protected boolean gap

Constructor Detail

MessageProp

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

public MessageProp(int qop,
                   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

public int getQOP()

Retrieves the QOP value.

getPrivacy

public boolean getPrivacy()

Retrieves the privacy state.

getMinorStatus

public int getMinorStatus()

Retrieves the minor status that the underlying mechanism might have set.

getMinorString

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.

setQOP

public void setQOP(int qopVal)

Sets the QOP value.

Parameters:

qopVal - The QOP value to be set. Use 0 to request a default QOP value.

setPrivacy

public void setPrivacy(boolean privState)

Sets the privacy state.

Parameters:

privState - The privacy state to set.

isDuplicateToken

public boolean isDuplicateToken()

Returns "true" if this is a duplicate of an earlier token.

isOldToken

public boolean isOldToken()

Returns "true" if the token's validity period has expired.

isUnseqToken

public boolean isUnseqToken()

Returns "true" if a later token has already been processed.

isGapToken

public boolean isGapToken()

Returns "true" if an expected per-message token was not received.

setSupplementaryStates

public 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. 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

toString

public java.lang.String toString()