Package org.forgerock.opendj.server.core
Class DataProviderID
- java.lang.Object
-
- org.forgerock.opendj.server.core.DataProviderID
-
- All Implemented Interfaces:
Comparable<DataProviderID>
public final class DataProviderID extends Object implements Comparable<DataProviderID>
A unique ID which can be used for identifying data providers.There are two types of data provider:
- User configured: these are data providers which have been defined using the server's configuration.
- Internal: these are data providers which have been created internally.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompareTo(DataProviderID o)booleanequals(Object obj)StringgetName()Returns the data provider name associated with this data provider ID.inthashCode()booleanisInternal()Indicating whether this ID represents an internal data provider.static DataProviderIDnewInternalID(String name)Creates a new ID for an internal data provider.static DataProviderIDnewUserID(String name)Creates a new ID for a user configured data provider.StringtoString()
-
-
-
Method Detail
-
newInternalID
public static DataProviderID newInternalID(String name)
Creates a new ID for an internal data provider.- Parameters:
name- The name of the internal data provider.- Returns:
- The new data provider ID.
-
newUserID
public static DataProviderID newUserID(String name)
Creates a new ID for a user configured data provider.- Parameters:
name- The name of the user configured data provider.- Returns:
- The new data provider ID.
-
compareTo
public int compareTo(DataProviderID o)
- Specified by:
compareToin interfaceComparable<DataProviderID>
-
getName
public String getName()
Returns the data provider name associated with this data provider ID.- Returns:
- The data provider name associated with this data provider ID.
-
isInternal
public boolean isInternal()
Indicating whether this ID represents an internal data provider.- Returns:
trueif this ID represents an internal data provider.
-
-