com.pingidentity.pa.sdk.policy

Annotation Type Rule

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface Rule

Required Annotation for defining Rules. Applies to RuleInterceptor

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	label The Label displayed in the UI, allowing the user to differentiate between Rules.
String	type An alphanumeric string used within the REST interface to designate a type of Rule.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	agentCachingDisabled Defines if the Rule should disable Agent caching.
RuleInterceptorCategory	category Defines whether the Rule interceptor is meant to perform as RuleInterceptorCategory.AccessControl or RuleInterceptorCategory.Processing.
RuleInterceptorSupportedDestination[]	destination Defines the situations in which the Rule can be used.
Class<? extends PluginConfiguration>	expectedConfiguration Describes an implementation of SimplePluginConfiguration that is provided to the ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) method.

Element Detail

label

public abstract String label

The Label displayed in the UI, allowing the user to differentiate between Rules. Should be unique.

Returns:

A Label String.

type

public abstract String type

An alphanumeric string used within the REST interface to designate a type of Rule. Should be unique.

Returns:

the Rule type

category

public abstract RuleInterceptorCategory category

Defines whether the Rule interceptor is meant to perform as RuleInterceptorCategory.AccessControl or RuleInterceptorCategory.Processing.

Returns:

the RuleInterceptorCategory

Default:

com.pingidentity.pa.sdk.policy.RuleInterceptorCategory.AccessControl

destination

public abstract RuleInterceptorSupportedDestination[] destination

Defines the situations in which the Rule can be used. Can the rule be applied to a RuleInterceptorSupportedDestination.Site or an RuleInterceptorSupportedDestination.Agent or both (the default.)

Returns:

the RuleInterceptorSupportedDestination array

Default:

{com.pingidentity.pa.sdk.policy.RuleInterceptorSupportedDestination.Site, com.pingidentity.pa.sdk.policy.RuleInterceptorSupportedDestination.Agent}

expectedConfiguration

public abstract Class<? extends PluginConfiguration> expectedConfiguration

Describes an implementation of SimplePluginConfiguration that is provided to the ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) method.

Returns:

the plugin configuration class

Default:

com.pingidentity.pa.sdk.policy.SimplePluginConfiguration.class

agentCachingDisabled

public abstract boolean agentCachingDisabled

Defines if the Rule should disable Agent caching. This only applies if destination includes RuleInterceptorSupportedDestination.Agent. Setting to true may have a negative impact on Application or Resource performance.

Returns:

true if this rule should disable Agent caching

Default:

false