| java.lang.Object | |
| ↳ | org.ietf.jgss.MessageProp |
Class Overview
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 Quality-of-Protection (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.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructor which sets the desired privacy state.
| |||||||||||
Constructor which sets the values for the qop and privacy state.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Retrieves the minor status code that the underlying mechanism might
have set for this per-message operation.
| |||||||||||
Retrieves a string explaining the minor status code.
| |||||||||||
Retrieves the privacy state.
| |||||||||||
Retrieves the QOP value.
| |||||||||||
Tests if this is a duplicate of an earlier token.
| |||||||||||
Tests if an expected token was not received, i.e., one or more
predecessor tokens have not yet been successfully processed.
| |||||||||||
Tests if this token's validity period has expired, i.e., the token
is too old to be checked for duplication.
| |||||||||||
Tests if a later token had already been processed.
| |||||||||||
Sets the privacy state.
| |||||||||||
Sets the QOP value.
| |||||||||||
This method sets the state for the supplementary information flags
and the minor status in MessageProp.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public MessageProp (boolean privState)
Constructor which sets the desired privacy state. The QOP value used is 0.
Parameters
| privState | the privacy (i.e. confidentiality) state |
|---|
public MessageProp (int qop, boolean privState)
Constructor which sets the values for the qop and privacy state.
Parameters
| qop | the QOP value |
|---|---|
| privState | the privacy (i.e. confidentiality) state |
Public Methods
public int getMinorStatus ()
Retrieves the minor status code that the underlying mechanism might have set for this per-message operation.
Returns
- the int minor status
public String getMinorString ()
Retrieves a string explaining the minor status code.
Returns
- a String corresponding to the minor status
code.
nullwill be returned when no minor status code has been set.
public boolean getPrivacy ()
Retrieves the privacy state.
Returns
- true if the privacy (i.e., confidentiality) state is true, false otherwise.
See Also
public int getQOP ()
public boolean isDuplicateToken ()
Tests if this is a duplicate of an earlier token.
Returns
- true if this is a duplicate, false otherwise.
public boolean isGapToken ()
Tests if an expected token was not received, i.e., one or more predecessor tokens have not yet been successfully processed.
Returns
- true if an expected per-message token was not received, false otherwise.
public boolean isOldToken ()
Tests if this token's validity period has expired, i.e., the token is too old to be checked for duplication.
Returns
- true if the token's validity period has expired, false otherwise.
public boolean isUnseqToken ()
Tests if a later token had already been processed.
Returns
- true if a later token had already been processed, false otherwise.
public void setPrivacy (boolean privState)
Sets the privacy state.
Parameters
| privState | true is the privacy (i.e., confidentiality) state is true, false otherwise. |
|---|
See Also
public void setQOP (int qop)
public 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. 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 int minor status code for the per-message operation |
| minorString | the textual representation of the minorStatus value |