com.pingidentity.sources
Class SourceDescriptor

java.lang.Object
  extended by com.pingidentity.sources.SourceDescriptor
Direct Known Subclasses:
CustomDataSourceDriverDescriptor

public class SourceDescriptor
extends java.lang.Object

This class returns metadata describing a ConfigurableDriver to the PingFederate server. The metadata is used by PingFederate to generate a dynamic UI that allows the user to interact with the driver.

See Also:
ConfigurableDriver.getSourceDescriptor()

Constructor Summary
SourceDescriptor(ConfigurableDriver driver, java.lang.String type)
          Creates a new SourceDescriptor with no custom GUI configuration screen.
SourceDescriptor(ConfigurableDriver driver, java.lang.String type, AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc)
          Creates a new SourceDescriptor with a custom GUI configuration screen.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 AdapterConfigurationGuiDescriptor getConfigurationGuiDescriptor()
          Gets the AdapterConfigurationGuiDescriptor for the driver that this object describes.
 java.lang.String getDriverClassName()
          Gets the classname of driver associated with this SourceDescriptor.
 java.lang.String getType()
          Gets the the type (or name) of the driver that this object describes.
 boolean hasActions()
          Checks if the AdapterConfigurationGuiDescriptor has actions.
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SourceDescriptor

public SourceDescriptor(ConfigurableDriver driver,
                        java.lang.String type)
Creates a new SourceDescriptor with no custom GUI configuration screen.

Parameters:
driver - Driver implementation this descriptor describes.
type - the type of the adapter is the 'friendly' name that will show up in the PF GUI - usually in the context of selecting from a number of available adapters. A relatively descriptive and unique name should be used.

SourceDescriptor

public SourceDescriptor(ConfigurableDriver driver,
                        java.lang.String type,
                        AdapterConfigurationGuiDescriptor adapterConfigurationGuiDesc)
Creates a new SourceDescriptor with a custom GUI configuration screen.

Parameters:
driver - the driver implementation this descriptor describes.
type - the type of the driver is the 'friendly' name that will show up in the PF GUI - usually in the context of selecting from a number of available drivers. A relatively descriptive and unique name should be used.
adapterConfigurationGuiDesc - a descriptor object that tells PingFederate how to render the configuration screen(s) for the driver this object describes as well as how to validate the input from the front end.
Method Detail

getType

public java.lang.String getType()
Gets the the type (or name) of the driver that this object describes.

Returns:
the type as a String.

getDriverClassName

public java.lang.String getDriverClassName()
Gets the classname of driver associated with this SourceDescriptor.

Returns:
the classname as a String.

getConfigurationGuiDescriptor

public AdapterConfigurationGuiDescriptor getConfigurationGuiDescriptor()
Gets the AdapterConfigurationGuiDescriptor for the driver that this object describes.

Returns:
the GUI descriptor of the driver that this object describes.

hasActions

public boolean hasActions()
Checks if the AdapterConfigurationGuiDescriptor has actions.

Returns:
true if the driver has actions

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright 2007 Ping Identity Corp. All rights reserved.