org.ietf.jgss: public class: MessageProp

org.ietf.jgss
public class: MessageProp [javadoc | source]

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

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.

Also see:

GSSContext#wrap

GSSContext#unwrap

GSSContext#getMIC

GSSContext#verifyMIC

author: Mayank - Upadhyay

since: 1.4 -

Constructor:

Constructor:
public MessageProp(boolean privState) { this(0, 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) { this.qop = qop; this.privacyState = privState; resetStatusValues(); } Constructor which sets the values for the qop and privacy state. Parameters: `qop` - the QOP value `privState` - the privacy (i.e. confidentiality) state

 public MessageProp(boolean privState) {
        this(0, 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) {
        this.qop = qop;
        this.privacyState = privState;
        resetStatusValues();
}

Constructor which sets the values for the qop and privacy state.

Parameters:

qop - the QOP value

privState - the privacy (i.e. confidentiality) state

Method from org.ietf.jgss.MessageProp Summary:
getMinorStatus, getMinorString, getPrivacy, getQOP, isDuplicateToken, isGapToken, isOldToken, isUnseqToken, setPrivacy, setQOP, setSupplementaryStates

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.ietf.jgss.MessageProp Detail:
public int getMinorStatus() { return minorStatus; } Retrieves the minor status code that the underlying mechanism might have set for this per-message operation.
public String getMinorString() { return minorString; } Retrieves a string explaining the minor status code.
public boolean getPrivacy() { return (privacyState); } Retrieves the privacy state.
public int getQOP() { return qop; } Retrieves the QOP value.
public boolean isDuplicateToken() { return dupToken; } Tests if this is a duplicate of an earlier token.
public boolean isGapToken() { return gapToken; } Tests if an expected token was not received, i.e., one or more predecessor tokens have not yet been successfully processed.
public boolean isOldToken() { return oldToken; } Tests if this token's validity period has expired, i.e., the token is too old to be checked for duplication.
public boolean isUnseqToken() { return unseqToken; } Tests if a later token had already been processed.
public void setPrivacy(boolean privState) { this.privacyState = privState; } Sets the privacy state.
public void setQOP(int qop) { this.qop = qop; } Sets the QOP value.
public void setSupplementaryStates(boolean duplicate, boolean old, boolean unseq, boolean gap, int minorStatus, String minorString) { this.dupToken = duplicate; this.oldToken = old; this.unseqToken = unseq; this.gapToken = gap; this.minorStatus = minorStatus; this.minorString = 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.

Method from org.ietf.jgss.MessageProp Detail:

 public int getMinorStatus() {
        return minorStatus;
}

Retrieves the minor status code that the underlying mechanism might have set for this per-message operation.

 public String getMinorString() {
        return minorString;
}

Retrieves a string explaining the minor status code.

 public boolean getPrivacy() {
        return (privacyState);
}

Retrieves the privacy state.

 public int getQOP() {
        return qop;
}

Retrieves the QOP value.

 public boolean isDuplicateToken() {
        return dupToken;
}

Tests if this is a duplicate of an earlier token.

 public boolean isGapToken() {
        return gapToken;
}

Tests if an expected token was not received, i.e., one or more predecessor tokens have not yet been successfully processed.

 public boolean isOldToken() {
        return oldToken;
}

Tests if this token's validity period has expired, i.e., the token is too old to be checked for duplication.

 public boolean isUnseqToken() {
        return unseqToken;
}

Tests if a later token had already been processed.

 public  void setPrivacy(boolean privState) {
        this.privacyState = privState;
}

Sets the privacy state.

 public  void setQOP(int qop) {
        this.qop = qop;
}

Sets the QOP value.

 public  void setSupplementaryStates(boolean duplicate,
    boolean old,
    boolean unseq,
    boolean gap,
    int minorStatus,
    String minorString) {
       this.dupToken = duplicate;
       this.oldToken = old;
       this.unseqToken = unseq;
       this.gapToken = gap;
       this.minorStatus = minorStatus;
       this.minorString = 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.