com.pingidentity.pa.sdk.siteauthenticator

Annotation Type SiteAuthenticator

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

Used to mark a SiteAuthenticatorInterceptor. This annotation must be applied to make the SiteAuthenticatorInterceptor available in PingAccess.

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

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.

Element Detail

label

public abstract String label

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

Returns:

the SiteAuthenticator 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 plugin configuration class

Default:

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