com.pingidentity.pa.sdk.ha.lb

Annotation Type LoadBalancingStrategy

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

Required annotation for defining LoadBalancingStrategies. This annotation must be applied to make the LoadBalancingPlugin available as a LoadBalancingStrategy in the PingAccess Administrative API and UI.

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 LoadBalancingStrategies.
String	type An alphanumeric string used within the REST interface to designate a type of LoadBalancingStrategies.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends PluginConfiguration>	expectedConfiguration Describes an implementation of SimplePluginConfiguration expected by the ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) method.
Class<? extends LoadBalancingHandler>	handlerClass Deprecated. this attribute is no longer used by PingAccess

Element Detail

label

public abstract String label

The Label displayed in the UI, allowing the user to differentiate between LoadBalancingStrategies. 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 LoadBalancingStrategies. Should be unique.

Returns:

The type.

expectedConfiguration

public abstract Class<? extends PluginConfiguration> expectedConfiguration

Describes an implementation of SimplePluginConfiguration expected by the ConfigurablePlugin.configure(com.pingidentity.pa.sdk.policy.PluginConfiguration) method.

Returns:

The configuration class.

Default:

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

handlerClass

@Deprecated
public abstract Class<? extends LoadBalancingHandler> handlerClass

Deprecated. this attribute is no longer used by PingAccess

Describes an implementation of LoadBalancingHandler created by the EntityScopedHandlerPlugin.getHandler() and EntityScopedHandlerPlugin.getHandler(Object) methods.

Returns:

The handler class.

Default:

com.pingidentity.pa.sdk.ha.lb.LoadBalancingStrategy.NONE.class