Package com.pingidentity.sdk
Class IdentityStoreProvisionerDescriptor
java.lang.Object
com.pingidentity.sdk.PluginDescriptor
com.pingidentity.sdk.IdentityStoreProvisionerDescriptor
This class is used to describe an Identity Store Provisioner implementation to the PingFederate server.
- Since:
- 7.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe default name of the groups' members attributeFields inherited from class com.pingidentity.sdk.PluginDescriptor
UNDEFINED -
Constructor Summary
ConstructorsConstructorDescriptionIdentityStoreProvisionerDescriptor(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 TypeMethodDescriptionGets the group attribute contract of the Identity Store Provisioner plugin that this object describes.Returns the name of the attribute that will store theMemberAttributevalues.booleanReturns whether or not the implementing plugin allows for group attributes in addition to those in its group attribute contract.voidsetGroupAttributeContractSet(Set<String> groupAttributeContract) Sets the group attribute contract that this plugin describes.voidsetGroupMembersAttributeName(String groupMembersAttributeName) Sets the name of the attribute that will store theMemberAttributevalues.voidsetSupportsExtendedGroupContract(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
-
Field Details
-
DEFAULT_MEMBERS_ATTR_NAME
The default name of the groups' members attribute- See Also:
-
-
Constructor Details
-
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 Provisionerplugin- The plugin instanceguiConfigDesc- The graphical user interface descriptor used for expressing the configurable fields of the Identity Store ProvisionerattributeContractSet- 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 Provisionerplugin- The plugin instanceguiConfigDesc- The graphical user interface descriptor used for expressing the configurable fields of the Identity Store ProvisionerattributeContractSet- 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 Provisionerplugin- The plugin instanceguiConfigDescBuilder- 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 Provisionerplugin- The plugin instanceguiConfigDescBuilder- 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 Details
-
setGroupAttributeContractSet
Sets the group attribute contract that this plugin describes.- Parameters:
groupAttributeContract- A set of strings defining the names of the group attributes.
-
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
Returns the name of the attribute that will store theMemberAttributevalues.If not set, it will return
DEFAULT_MEMBERS_ATTR_NAME- Returns:
- The name of the attribute containing the groups' members.
- See Also:
-
setGroupMembersAttributeName
Sets the name of the attribute that will store theMemberAttributevalues.If not set, it will default to
DEFAULT_MEMBERS_ATTR_NAME- Parameters:
groupMembersAttributeName- The name of the attribute containing the groups' members.- See Also:
-