com.novell.nxpe
Interface NxpeResponseContext

public interface NxpeResponseContext

Defines the response class for the policy extension interface. The NxpeResponseContext contains methods to set state information for the response in the application. This response class can call multiple response methods for the same request. The extension application should derive its response handling object from this class.

Since:

NXPE1.0

Author:

Paladin Team

Method Summary

void	addLogEntry(java.lang.String policyName, int iRule, java.lang.String actionName) Adds a log entry for this extension.
void	addTraceEntry(Trace traceObject) Adds a trace entry for this extension.
void	addTraceString(java.lang.String traceString) Adds a trace string for this extension.
NxpeResult	doAction(int eActionEnumerativeValue, NxpeParameterList parameterList, NxpeEvaluationContext hEvalQueryContext) Signals that an action being handled by the application has been triggered.
void	externalActionComplete(int eActionEnumerativeValue, NxpeResult actionReturnValue) Signals the application that an extension action has been performed.

Method Detail

doAction

NxpeResult doAction(int eActionEnumerativeValue,
                    NxpeParameterList parameterList,
                    NxpeEvaluationContext hEvalQueryContext)
                    throws NxpeException

Signals that an action being handled by the application has been triggered. This method can be called multiple times during policy evaluation.

Parameters:

eActionEnumerativeValue - - The ActionEnumerativeValue from the policy type specification.

parameterList - - The parameter list as defined in the action from the policy collection.

hEvalQueryContext - - The object you can query for the interface identifier of this action in the configuration XML. It is used for tracing.

Returns:

nxpeResult - Either Success or Terminate to stop the evaluation

Throws:

NxpeException

externalActionComplete

void externalActionComplete(int eActionEnumerativeValue,
                            NxpeResult actionReturnValue)
                            throws NxpeException

Signals the application that an extension action has been performed. This method can be called multiple times during policy evaluation.

Parameters:

eActionEnumerativeValue - - The ActionEnumerativeValue from the policy type specification.

actionReturnValue - - The action's return value. Either Success or Cancel. If Cancel is returned, the evaluation is terminated.

Throws:

NxpeException

addLogEntry

void addLogEntry(java.lang.String policyName,
                 int iRule,
                 java.lang.String actionName)
                 throws NxpeException

Adds a log entry for this extension.

Parameters:

policyName - - The name of policy where action was triggered.

iRule - - Tthe rule number that triggered the action.

actionName - - The name of the action triggered.

Throws:

NxpeException

addTraceString

void addTraceString(java.lang.String traceString)
                    throws NxpeException

Adds a trace string for this extension.

Parameters:

traceString - - The string containing trace information.

Throws:

NxpeException

addTraceEntry

void addTraceEntry(Trace traceObject)
                   throws NxpeException

Adds a trace entry for this extension.

Throws:

NxpeException