com.novell.nxpe
Interface NxpeCondition

public interface NxpeCondition

Defines an interface you need to extend. It contains the methods required to evaluate the condition for a policy.

Since:

NXPE1.0

Author:

Paladin Team

Method Summary

NxpeResult	evaluate(NxpeInformationContext informationContext, NxpeResponseContext responseContext) Called by the policy engine to evaluate the condition.
void	initialize(NxpeParameterList configurationValues) Called by the policy engine to initialize the condition in preparation for policy evaluation.
void	setInterfaceId(java.lang.String interfaceId) Sets the unique string value for the condition.

Method Detail

initialize

void initialize(NxpeParameterList configurationValues)
                throws NxpeException

Called by the policy engine to initialize the condition in preparation for policy evaluation.

Derived classes are required to override this method. This method is guaranteed to be called before any other method is called, as this is part of object construction.

Parameters:

configurationValues - A list of configuration data required by the external condition handler. This object is only valid during the lifetime of the initialize method. If you want to preserve config data, it must be copied to the condition handler.

Throws:

NxpeException

evaluate

NxpeResult evaluate(NxpeInformationContext informationContext,
                    NxpeResponseContext responseContext)
                    throws NxpeException

Called by the policy engine to evaluate the condition.

Derived classes are require to override this method to implement the supported condition.

Parameters:

informationContext - The parameter information the extension needs from the policy engine to evaluate the condition.

responseContext - The object for communicating detailed response information back to the application. This does not replace the need to notify the policy engine of the condition completion status via the return value from this call.

Returns:

The results of the evaluation.

Throws:

NxpeException

setInterfaceId

void setInterfaceId(java.lang.String interfaceId)
                    throws NxpeException

Sets the unique string value for the condition.

This is currently the InterfaceId found in the condition element. This data is used for tracing evaluation.

Parameters:

interfaceId - The unique string value for the condition.

Throws:

NxpeException