Package com.pingidentity.sdk

Class IdentityStoreProvisionerDescriptor

java.lang.Object

com.pingidentity.sdk.PluginDescriptor

com.pingidentity.sdk.IdentityStoreProvisionerDescriptor

public class IdentityStoreProvisionerDescriptor
extends PluginDescriptor

This class is used to describe an Identity Store Provisioner implementation to the PingFederate server.

Since:

7.1

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_MEMBERS_ATTR_NAME	The default name of the groups' members attribute

Fields inherited from class com.pingidentity.sdk.PluginDescriptor

UNDEFINED

Constructor Summary

Constructors

Constructor	Description
IdentityStoreProvisionerDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptorBuilder guiConfigDescBuilder, Set<String> attributeContractSet)	Constructor for the IdentityStoreProvisionerDescriptor class.
IdentityStoreProvisionerDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptorBuilder guiConfigDescBuilder, Set<String> attributeContractSet, String version)	Constructor for the IdentityStoreProvisionerDescriptor class.
IdentityStoreProvisionerDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptor guiConfigDesc, Set<String> attributeContractSet)	Constructor for the IdentityStoreProvisionerDescriptor class.
IdentityStoreProvisionerDescriptor(String type, ConfigurablePlugin plugin, GuiConfigDescriptor guiConfigDesc, Set<String> attributeContractSet, String version)	Constructor for the IdentityStoreProvisionerDescriptor class.

Method Summary

Modifier and Type	Method	Description
Set<String>	getGroupAttributeContractSet()	Gets the group attribute contract of the Identity Store Provisioner plugin that this object describes.
String	getGroupMembersAttributeName()	Returns the name of the attribute that will store the MemberAttribute values.
boolean	isSupportsExtendedGroupContract()	Returns whether or not the implementing plugin allows for group attributes in addition to those in its group attribute contract.
void	setGroupAttributeContractSet(Set<String> groupAttributeContract)	Sets the group attribute contract that this plugin describes.
void	setGroupMembersAttributeName(String groupMembersAttributeName)	Sets the name of the attribute that will store the MemberAttribute values.
void	setSupportsExtendedGroupContract(boolean supportsExtendedGroupContract)	Sets whether or not the implementing plugin allows for group attributes in addition to those in its group attribute contract.

Methods inherited from class com.pingidentity.sdk.PluginDescriptor

equals, getAttributeContractSet, getGuiConfigDescriptor, getGuiConfigDescriptorBuilder, getMetadata, getPluginClassName, getType, getVersion, hashCode, isSupportsExtendedContract, setAttributeContactSet, setAttributeContractSet, setMetadata, setSupportsExtendedContract

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MEMBERS_ATTR_NAME

public static final String DEFAULT_MEMBERS_ATTR_NAME

The default name of the groups' members attribute

See Also:

Constant Field Values

Constructor Detail

IdentityStoreProvisionerDescriptor

public IdentityStoreProvisionerDescriptor(String type,
                                          ConfigurablePlugin plugin,
                                          GuiConfigDescriptor guiConfigDesc,
                                          Set<String> attributeContractSet)

Constructor for the IdentityStoreProvisionerDescriptor class.

Parameters:

type - A text label for the Identity Store Provisioner

plugin - The plugin instance

guiConfigDesc - The graphical user interface descriptor used for expressing the configurable fields of the Identity Store Provisioner

attributeContractSet - The attribute contract that this plugin describes.

IdentityStoreProvisionerDescriptor

public IdentityStoreProvisionerDescriptor(String type,
                                          ConfigurablePlugin plugin,
                                          GuiConfigDescriptor guiConfigDesc,
                                          Set<String> attributeContractSet,
                                          String version)

Constructor for the IdentityStoreProvisionerDescriptor class.

Parameters:

type - A text label for the Identity Store Provisioner

plugin - The plugin instance

guiConfigDesc - The graphical user interface descriptor used for expressing the configurable fields of the Identity Store Provisioner

attributeContractSet - The attribute contract that this plugin describes.

version - The version of this Identity Store Provisioner

IdentityStoreProvisionerDescriptor

public IdentityStoreProvisionerDescriptor(String type,
                                          ConfigurablePlugin plugin,
                                          GuiConfigDescriptorBuilder guiConfigDescBuilder,
                                          Set<String> attributeContractSet)

Constructor for the IdentityStoreProvisionerDescriptor class.

Parameters:

type - A text label for the Identity Store Provisioner

plugin - The plugin instance

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

attributeContractSet - The attribute contract that this plugin describes.

IdentityStoreProvisionerDescriptor

public IdentityStoreProvisionerDescriptor(String type,
                                          ConfigurablePlugin plugin,
                                          GuiConfigDescriptorBuilder guiConfigDescBuilder,
                                          Set<String> attributeContractSet,
                                          String version)

Constructor for the IdentityStoreProvisionerDescriptor class.

Parameters:

type - A text label for the Identity Store Provisioner

plugin - The plugin instance

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

attributeContractSet - The attribute contract that this plugin describes.

version - The version of this Identity Store Provisioner

Method Detail

setGroupAttributeContractSet

public void setGroupAttributeContractSet(Set<String> groupAttributeContract)

Sets the group attribute contract that this plugin describes.

Parameters:

groupAttributeContract - A set of strings defining the names of the group attributes.

getGroupAttributeContractSet

public Set<String> getGroupAttributeContractSet()

Gets the group attribute contract of the Identity Store Provisioner plugin that this object describes.

Returns:

The plugin's group attribute contract as a Set of Strings.

isSupportsExtendedGroupContract

public boolean isSupportsExtendedGroupContract()

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

Returns:

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

setSupportsExtendedGroupContract

public void setSupportsExtendedGroupContract(boolean supportsExtendedGroupContract)

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

Parameters:

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

getGroupMembersAttributeName

public String getGroupMembersAttributeName()

Returns the name of the attribute that will store the MemberAttribute values.

If not set, it will return DEFAULT_MEMBERS_ATTR_NAME

Returns:

The name of the attribute containing the groups' members.

See Also:

CreateGroupRequestContext.getGroupAttributes(), UpdateGroupRequestContext.getGroupAttributes()

setGroupMembersAttributeName

public void setGroupMembersAttributeName(String groupMembersAttributeName)

Sets the name of the attribute that will store the MemberAttribute values.

If not set, it will default to DEFAULT_MEMBERS_ATTR_NAME

Parameters:

groupMembersAttributeName - The name of the attribute containing the groups' members.

See Also:

CreateGroupRequestContext.getGroupAttributes(), UpdateGroupRequestContext.getGroupAttributes()