com.novell.nxpe
Class NxpeResult

java.lang.Object
  com.novell.nxpe.NxpeResult

public class NxpeResult
extends java.lang.Object

Defines a 32-bit result class to support the policy extension return codes.

Since:

NXPE1.0

Author:

Paladin Team

Nested Class Summary

static class	NxpeResult.Type
static class	NxpeResult.Value

Field Summary

static NxpeResult	Cancel Reserved.
static NxpeResult	ConditionFalse Returned by a condition extension when the compared values do not match.
static NxpeResult	ConditionTrue Returned by a condition extension when the compared values match.
static NxpeResult	ConditionUnknown Returned by a condition extension when the values cannot be compared.
static NxpeResult	Deny Returned by an action extension when a deny action was applied.
static NxpeResult	ErrorBadData Returned by a context data extension when the data cannot be parsed.
static java.lang.String	ErrorCodeComponent Reserved.
static NxpeResult	ErrorConfigInitialization Returned by an extension when the initialize method for the extension encounters an error.
static NxpeResult	ErrorDataUnavailable Returned by a context data extension when the requested data is not available.
static NxpeResult	ErrorIllegalArgument Returned by the extension when the informationContext object contains an unknown paramter.
static NxpeResult	ErrorIllegalState Reserved.
static NxpeResult	ErrorInterfaceUnavailable Returned when the extension has not implemented one of the required methods in the interface.
static NxpeResult	ErrorNoMemory Reserved.
static NxpeResult	GeneralFailure Returned by an extension when an unknown error occurs.
protected NxpeResult.Type	m_resultType Reserved.
protected NxpeResult.Value	m_resultValue Reserved.
static NxpeResult	NoAction Reserved.
static NxpeResult	Obligation Returned by an action extension when an abligation actions was performed.
static NxpeResult	Pending Reserved.
static NxpeResult	Permit Returned by an action extension when a permit action was applied.
static java.lang.String	SubGroupCodeActionHandler Reserved.
static java.lang.String	SubGroupCodeConditionHandler Reserved.
static java.lang.String	SubGroupCodeConfigureInformationContext Reserved.
static java.lang.String	SubGroupCodeEngine Reserved.
static java.lang.String	SubGroupCodeInformationContext Reserved.
static java.lang.String	SubGroupCodeResponseContext Reserved.
static NxpeResult	Success Reserved.
static NxpeResult	UserDataNotAccessible Returned by an extension when the user data required by the policy is not accessible.

Constructor Summary

NxpeResult(NxpeResult.Type resultType, NxpeResult.Value resultValue)

Method Summary

boolean	equals(java.lang.Object object) Reserved for internal use.
java.lang.String	getErrorCode() Reserved for internal use.
java.lang.String	getErrorCode(java.lang.String subGroup) Reserved for internal use.
java.lang.String	getErrorCode(java.lang.String component, java.lang.String subGroup) Reserved for internal use.
NxpeResult.Type	getResultType()
NxpeResult.Value	getResultValue()
int	hashCode() Reserved for internal use.
boolean	isError() Reserved for internal use.
boolean	isInformation() Reserved for internal use.
boolean	isSuccess() Reserved for internal use.
boolean	isUnknown() Reserved for internal use.
boolean	isWarning() Reserved for internal use.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

Success

public static final NxpeResult Success

Reserved.

Pending

public static final NxpeResult Pending

Reserved.

GeneralFailure

public static final NxpeResult GeneralFailure

Returned by an extension when an unknown error occurs.

ErrorNoMemory

public static final NxpeResult ErrorNoMemory

Reserved.

ErrorBadData

public static final NxpeResult ErrorBadData

Returned by a context data extension when the data cannot be parsed.

ErrorConfigInitialization

public static final NxpeResult ErrorConfigInitialization

Returned by an extension when the initialize method for the extension encounters an error.

UserDataNotAccessible

public static final NxpeResult UserDataNotAccessible

Returned by an extension when the user data required by the policy is not accessible.

Permit

public static final NxpeResult Permit

Returned by an action extension when a permit action was applied.

Deny

public static final NxpeResult Deny

Returned by an action extension when a deny action was applied.

Obligation

public static final NxpeResult Obligation

Returned by an action extension when an abligation actions was performed.

NoAction

public static final NxpeResult NoAction

Reserved.

ConditionFalse

public static final NxpeResult ConditionFalse

Returned by a condition extension when the compared values do not match.

ConditionTrue

public static final NxpeResult ConditionTrue

Returned by a condition extension when the compared values match.

ConditionUnknown

public static final NxpeResult ConditionUnknown

Returned by a condition extension when the values cannot be compared.

Cancel

public static final NxpeResult Cancel

Reserved.

ErrorInterfaceUnavailable

public static final NxpeResult ErrorInterfaceUnavailable

Returned when the extension has not implemented one of the required methods in the interface.

ErrorDataUnavailable

public static final NxpeResult ErrorDataUnavailable

Returned by a context data extension when the requested data is not available.

ErrorIllegalState

public static final NxpeResult ErrorIllegalState

Reserved.

ErrorIllegalArgument

public static final NxpeResult ErrorIllegalArgument

Returned by the extension when the informationContext object contains an unknown paramter.

ErrorCodeComponent

public static final java.lang.String ErrorCodeComponent

Reserved.

See Also:

Constant Field Values

SubGroupCodeEngine

public static final java.lang.String SubGroupCodeEngine

Reserved.

See Also:

Constant Field Values

SubGroupCodeConditionHandler

public static final java.lang.String SubGroupCodeConditionHandler

Reserved.

See Also:

Constant Field Values

SubGroupCodeActionHandler

public static final java.lang.String SubGroupCodeActionHandler

Reserved.

See Also:

Constant Field Values

SubGroupCodeConfigureInformationContext

public static final java.lang.String SubGroupCodeConfigureInformationContext

Reserved.

See Also:

Constant Field Values

SubGroupCodeInformationContext

public static final java.lang.String SubGroupCodeInformationContext

Reserved.

See Also:

Constant Field Values

SubGroupCodeResponseContext

public static final java.lang.String SubGroupCodeResponseContext

Reserved.

See Also:

Constant Field Values

m_resultType

protected NxpeResult.Type m_resultType

Reserved.

m_resultValue

protected NxpeResult.Value m_resultValue

Reserved.

Constructor Detail

NxpeResult

public NxpeResult(NxpeResult.Type resultType,
                  NxpeResult.Value resultValue)

Method Detail

equals

public boolean equals(java.lang.Object object)

Reserved for internal use.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Reserved for internal use.

Overrides:

hashCode in class java.lang.Object

isSuccess

public boolean isSuccess()

Reserved for internal use.

isError

public boolean isError()

Reserved for internal use.

isUnknown

public boolean isUnknown()

Reserved for internal use.

isWarning

public boolean isWarning()

Reserved for internal use.

isInformation

public boolean isInformation()

Reserved for internal use.

getResultType

public NxpeResult.Type getResultType()

getResultValue

public NxpeResult.Value getResultValue()

getErrorCode

public java.lang.String getErrorCode()

Reserved for internal use.

getErrorCode

public java.lang.String getErrorCode(java.lang.String subGroup)

Reserved for internal use.

getErrorCode

public java.lang.String getErrorCode(java.lang.String component,
                                     java.lang.String subGroup)

Reserved for internal use.