com.novell.nxpe
Interface NxpeResponseContext

public interface NxpeResponseContext

Response class for the nxpe policy interface nxpeResponseContextImpl contains methods to set state information for the response in the application. This response class may call multiple response methods for the same request. It is intended that the application will derive their 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) Method to signal the application an action has been triggered as a result of policy evaluation
void	addTraceEntry(Trace traceObject) Method to signal the application an action has been triggered as a result of policy evaluation
void	addTraceString(java.lang.String traceString) Method to signal the application an action has been triggered as a result of policy evaluation
NxpeResult	doAction(int eActionEnumerativeValue, NxpeParameterList parameterList, NxpeEvaluationContext hEvalQueryContext) Signal that an action being handled by the application has been triggered.
void	externalActionComplete(int eActionEnumerativeValue, NxpeResult actionReturnValue) Method to signal the application an extension action has been performed This method may be called multiple times during policy evaluation.

Method Detail

doAction

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

Signal that an action being handled by the application has been triggered. This method may 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 paladin policy collection.

hEvalQueryContext - object we can query for the interface identifier of this action in the configuration xml. -- used for tracing

Returns:

nxpeResult - One of Success or Terminate to stop evaluation

Throws:

NxpeException

externalActionComplete

void externalActionComplete(int eActionEnumerativeValue,
                            NxpeResult actionReturnValue)
                            throws NxpeException

Method to signal the application an extension action has been performed This method may be called multiple times during policy evaluation.

Parameters:

eActionEnumerativeValue - the ActionEnumerativeValue from the policy type specification

actionReturnValue - the action's return value

Throws:

NxpeException

addLogEntry

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

Method to signal the application an action has been triggered as a result of policy evaluation

Parameters:

policyName - name of policy where action was triggered

iRule - the rule number that triggered the action

actionName - name of the action triggered

Throws:

NxpeException

addTraceString

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

Method to signal the application an action has been triggered as a result of policy evaluation

Parameters:

traceString - string containing trace information

Throws:

NxpeException

addTraceEntry

void addTraceEntry(Trace traceObject)
                   throws NxpeException

Method to signal the application an action has been triggered as a result of policy evaluation

Throws:

NxpeException