Package com.pingidentity.sdk

Class PluginDescriptor

java.lang.Object

com.pingidentity.sdk.PluginDescriptor

Direct Known Subclasses:

AdapterSelectorDescriptor, AuthenticationSelectorDescriptor, AuthnAdapterDescriptor, AuthorizationDetailProcessorDescriptor, CaptchaProviderDescriptor, DynamicClientRegistrationPluginDescriptor, IdentityStoreProvisionerDescriptor, NotificationSenderPluginDescriptor, SecretManagerDescriptor, SourceDescriptor, TokenPluginDescriptor

public class PluginDescriptor
extends Object

This class is used to describe plugin implementation to the PingFederate server.

Field Summary

Fields

Modifier and Type	Field	Description
static String	UNDEFINED

Constructor Summary

Constructors

Constructor	Description
PluginDescriptor()	Creates an empty PluginDescriptor.
PluginDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptor guiConfigDesc)	Creates a PluginDescriptor based on the specified type, plugin and a GUI configuration descriptor.
PluginDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptorBuilder guiConfigDescBuilder)	Creates a PluginDescriptor based on the specified type, plugin and a GUI configuration descriptor builder.
PluginDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptorBuilder guiConfigDescBuilder, String version)	Creates a PluginDescriptor based on the specified type, plugin and a GUI configuration descriptor builder.
PluginDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptor guiConfigDesc, String version)	Creates a PluginDescriptor based on the specified type, plugin and a GUI configuration descriptor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Set<String>	getAttributeContractSet()	Gets the attribute contract of the plugin that this object describes.
GuiConfigDescriptor	getGuiConfigDescriptor()	Deprecated. As of 6.11, replaced by getGuiConfigDescriptorBuilder()
GuiConfigDescriptorBuilder	getGuiConfigDescriptorBuilder()	The GUI descriptor builder this PluginDescriptor represents.
Map<String,Object>	getMetadata()	Get additional metadata about the plugin.
String	getPluginClassName()	Gets the class name of the implementing plugin that this PluginDescriptor describes.
String	getType()	Gets the the type (or name) of the plugin that this object describes.
String	getVersion()	Gets the version of this PluginDescriptor.
int	hashCode()
boolean	isSupportsExtendedContract()	Returns whether or not the implementing plugin allows for attributes in addition to those in its contract.
void	setAttributeContactSet(Set<String> attributeContactSet)	Deprecated. Use the correctly spelled method setAttributeContractSet(Set).
void	setAttributeContractSet(Set<String> attributeContractSet)	Sets the attribute contract that this plugin describes.
void	setMetadata(Map<String,Object> metadata)	Set additional metadata about the plugin.
void	setSupportsExtendedContract(boolean supportsExtendedContract)	Sets whether or not the implementing plugin allows for attributes in addition to those in its contract.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNDEFINED

public static final String UNDEFINED

See Also:

Constant Field Values

Constructor Detail

PluginDescriptor

public PluginDescriptor()

Creates an empty PluginDescriptor.

PluginDescriptor

public PluginDescriptor(String type,
                        ConfigurablePlugin plugin,
                        GuiConfigDescriptor guiConfigDesc)

Creates a PluginDescriptor based on the specified type, plugin and a GUI configuration descriptor. The version of this PluginDescriptor will be undefined.

Parameters:

type - A name to represent the type of this plugin.

plugin - The configurable plugin that this descriptor is meant to represent.

guiConfigDesc - The GUI configuration descriptor associated with this PluginDescriptor.

PluginDescriptor

public PluginDescriptor(String type,
                        ConfigurablePlugin plugin,
                        GuiConfigDescriptor guiConfigDesc,
                        String version)

Creates a PluginDescriptor based on the specified type, plugin and a GUI configuration descriptor.

Parameters:

type - A name to represent the type of this plugin.

plugin - The configurable plugin that this descriptor is meant to represent.

guiConfigDesc - The GUI configuration descriptor associated with this PluginDescriptor.

version - The version of this PluginDescriptor.

PluginDescriptor

public PluginDescriptor(String type,
                        ConfigurablePlugin plugin,
                        GuiConfigDescriptorBuilder guiConfigDescBuilder)

Creates a PluginDescriptor based on the specified type, plugin and a GUI configuration descriptor builder. The version of this PluginDescriptor will be undefined.

Parameters:

type - A name to represent the type of this plugin.

plugin - The configurable plugin that this descriptor is meant to represent.

guiConfigDescBuilder - The GUI configuration descriptor builder associated with this PluginDescriptor.

Since:

6.11

PluginDescriptor

public PluginDescriptor(String type,
                        ConfigurablePlugin plugin,
                        GuiConfigDescriptorBuilder guiConfigDescBuilder,
                        String version)

Creates a PluginDescriptor based on the specified type, plugin and a GUI configuration descriptor builder.

Parameters:

type - A name to represent the type of this plugin.

plugin - The configurable plugin that this descriptor is meant to represent.

guiConfigDescBuilder - The GUI configuration descriptor builder associated with this PluginDescriptor.

version - The version of this PluginDescriptor.

Since:

6.11

Method Detail

setAttributeContactSet

@Deprecated
public void setAttributeContactSet(Set<String> attributeContactSet)

Deprecated.

Use the correctly spelled method setAttributeContractSet(Set).

Sets the attribute contract that this plugin describes.

Parameters:

attributeContactSet - A set of strings defining the names of the attributes.

setAttributeContractSet

public void setAttributeContractSet(Set<String> attributeContractSet)

Sets the attribute contract that this plugin describes.

Parameters:

attributeContractSet - A set of strings defining the names of the attributes.

getType

public String getType()

Gets the the type (or name) of the plugin that this object describes.

Returns:

The type as a String.

getAttributeContractSet

public Set<String> getAttributeContractSet()

Gets the attribute contract of the plugin that this object describes.

Returns:

The plugin attribute contract as a Set of Strings.

getPluginClassName

public String getPluginClassName()

Gets the class name of the implementing plugin that this PluginDescriptor describes.

Returns:

The class name of the implementing plugin this PluginDescriptor describes.

getGuiConfigDescriptor

@Deprecated
public GuiConfigDescriptor getGuiConfigDescriptor()

Deprecated.

As of 6.11, replaced by getGuiConfigDescriptorBuilder()

The GUI descriptor this PluginDescriptor represents.

Returns:

The GUI descriptor this PluginDescriptor represents.

getGuiConfigDescriptorBuilder

public GuiConfigDescriptorBuilder getGuiConfigDescriptorBuilder()

The GUI descriptor builder this PluginDescriptor represents.

Returns:

The GUI descriptor builder this PluginDescriptor represents.

Since:

6.11

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isSupportsExtendedContract

public boolean isSupportsExtendedContract()

Returns whether or not the implementing plugin allows for attributes in addition to those in its contract.

Returns:

Returns true if the implementing plugin allows for attributes in addition to those in its contract, false otherwise.

setSupportsExtendedContract

public void setSupportsExtendedContract(boolean supportsExtendedContract)

Sets whether or not the implementing plugin allows for attributes in addition to those in its contract.

Parameters:

supportsExtendedContract - Whether or not the implementing plugin allows for attributes in addition to those in its contract.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getVersion

public String getVersion()

Gets the version of this PluginDescriptor.

Returns:

The version of this PluginDescriptor.

getMetadata

public Map<String,Object> getMetadata()

Get additional metadata about the plugin. Allowed keys are defined in PluginMetadataKeys.

Returns:

Additional metadata about the plugin. The returned map is not modifiable.

Since:

10.2

setMetadata

public void setMetadata(Map<String,Object> metadata)

Set additional metadata about the plugin. Allowed keys are defined in PluginMetadataKeys.

Parameters:

metadata - Plugin metadata.

Since:

10.2