com.novell.nxpe
Interface NxpeContextDataElement

public interface NxpeContextDataElement

Defines the methods required to create a context data element that can be used for injection, for activating roles, or in a condition.

Since:

NXPE1.0

Author:

Paladin Team

Method Summary

int	getEnumerativeValue() Returns -1.
java.lang.String	getName() Retrieves the name of the data element of the policy.
java.lang.String	getParameter() Retrieves the string value of the parameter of the policy.
java.lang.Object	getValue(NxpeInformationContext informationContext, NxpeResponseContext responseContext) Called by the policy engine when a request triggers a policy evaluation.
void	initialize(NxpeParameterList configurationValues) Called by the policy engine to initialize a component in preparation for policy evaluation.

Method Detail

initialize

void initialize(NxpeParameterList configurationValues)
                throws NxpeException

Called by the policy engine to initialize a component 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 - The list of configuration data required by the extension. This object is only valid during the lifetime of the initialize method. If the extension wants to preserver the config data, it must be copied to the context data element handler.

Throws:

NxpeException

getName

java.lang.String getName()

Retrieves the name of the data element of the policy.

getEnumerativeValue

int getEnumerativeValue()

Returns -1. Reserved for future releases.

getParameter

java.lang.String getParameter()

Retrieves the string value of the parameter of the policy.

getValue

java.lang.Object getValue(NxpeInformationContext informationContext,
                          NxpeResponseContext responseContext)
                          throws NxpeException

Called by the policy engine when a request triggers a policy evaluation.

Parameters:

informationContext - The parameter values that you need from the policy engine in order to perform the evaluation.

reponseContext - The results of the evaluation.

Throws:

NxpeException