net.datenwerke.rs.ldap.service.ldap

Interface LdapService

public interface LdapService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_FILE
static java.lang.String	DN
static java.util.List<java.lang.String>	GUID_CANDIDATES
static java.lang.String	MEMBERS
static java.lang.String	PARENT
static java.util.List<java.lang.String>	PROPERTY_BASE
static java.util.List<java.lang.String>	PROPERTY_CREDENTIALS
static java.util.List<java.lang.String>	PROPERTY_ENCRYPTION_PROTOCOL
static java.util.List<java.lang.String>	PROPERTY_EXTERNAL_DIR
static java.util.List<java.lang.String>	PROPERTY_FILTER
static java.util.List<java.lang.Object>	PROPERTY_FLATTEN_TREE
static java.util.List<java.lang.String>	PROPERTY_GROUP_MEMBER
static java.util.List<java.lang.String>	PROPERTY_GROUP_NAME
static java.util.List<java.lang.String>	PROPERTY_GROUP_OBJECT_CLASS
static java.util.List<java.lang.String>	PROPERTY_GUID
static java.util.List<java.lang.String>	PROPERTY_HOST
static java.util.List<java.lang.Object>	PROPERTY_LOG_RESULTING_TREE
static java.util.List<java.lang.String>	PROPERTY_OBJECT_CLASS
static java.util.List<java.lang.String>	PROPERTY_OU_NAME
static java.util.List<java.lang.String>	PROPERTY_OU_OBJECT_CLASS
static java.util.List<java.lang.Object>	PROPERTY_PORT
static java.util.List<java.lang.String>	PROPERTY_PRINCIPAL
static java.util.List<java.lang.String>	PROPERTY_USER_FIRSTNAME
static java.util.List<java.lang.String>	PROPERTY_USER_LASTNAME
static java.util.List<java.lang.String>	PROPERTY_USER_MAIL
static java.util.List<java.lang.String>	PROPERTY_USER_OBJECT_CLASS
static java.util.List<java.lang.String>	PROPERTY_USER_USERNAME
static java.util.List<java.lang.Object>	PROPERTY_WRITE_PROTECTION
static java.lang.String	VENDOR_NAME
static java.lang.String	VENDOR_VERSION

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	attribute(java.lang.String attribute) Queries the attribute definition of the given attribute.
BindResult	authenticate(User user, java.lang.String password) Authenticates the given user with the given password against the LDAP origin.
java.lang.String	filter(int indentation, boolean simplify) Parses the installed filter and displays it in a multi-line form that makes it easier to understand its hierarchy and embedded components.
java.lang.String	getAllNames(AttributeTypeDefinition attribute) Returns a string containing all names of the given attribute joined with a comma.
java.lang.String	getAllNames(MatchingRuleDefinition matchingRule) Returns a string containing all names of the given matching rule joined with a comma.
java.lang.String	getAllNames(ObjectClassDefinition objectClass) Returns a string containing all names of the given object class joined with a comma.
AttributeTypeDefinition	getAttributeDefinition(java.lang.String attribute, Schema schema) Queries the attribute definition of the given attribute.
java.util.List<AttributeTypeDefinition>	getAttributeTypes() Queries the schema for the existing attributes.
java.util.List<AttributeTypeDefinition>	getAttributeTypes(Schema schema) Queries the schema for the existing attributes.
java.lang.String	getEntry() Returns a string representation of the schema entry
MatchingRuleDefinition	getMatchingRuleDefinition(java.lang.String matchingRule, Schema schema) Queries the matching rule definition of the given matching rule.
java.util.List<MatchingRuleDefinition>	getMatchingRules() Queries the schema for the existing matching rules.
java.util.List<MatchingRuleDefinition>	getMatchingRules(Schema schema) Queries the schema for the existing matching rules.
ObjectClassDefinition	getObjectClassDefinition(java.lang.String objectClassName, Schema schema) Queries the object class definition of the given object class.
java.util.List<ObjectClassDefinition>	getObjectClasses() Queries the schema for the existing object classes.
java.util.List<ObjectClassDefinition>	getObjectClasses(Schema schema) Queries the schema for the existing object classes.
Schema	getSchema() Reads the LDAP schema
java.util.List<AttributeTypeDefinition>	getSubAttributes(AttributeTypeDefinition attributeDef, Schema schema) Fetches the direct attributes of the given attribute definition.
java.util.List<ObjectClassDefinition>	getSubClasses(ObjectClassDefinition objectClassDef, Schema schema) Fetches the direct subclasses of the given objectClass definition.
AttributeSyntaxDefinition	getSyntaxRuleDefinition(java.lang.String oid, Schema schema) Queries the syntax rule definition of the given syntax rule OID.
java.util.List<AttributeSyntaxDefinition>	getSyntaxRules() Queries the schema for the existing syntax rules.
java.util.List<AttributeSyntaxDefinition>	getSyntaxRules(Schema schema) Queries the schema for the existing syntax rules.
java.util.List<ObjectClassDefinition>	getUsedAsOptional(AttributeTypeDefinition attributeDef, Schema schema) Gets all object class definitions using the given attribute type definition as an optional attribute.
java.util.List<ObjectClassDefinition>	getUsedAsRequired(AttributeTypeDefinition attributeDef, Schema schema) Gets all object class definitions using the given attribute type definition as an optional attribute.
java.util.List<AttributeTypeDefinition>	getUsedBy(AttributeSyntaxDefinition syntaxRule, Schema schema) Gets all attributes that are used by the given syntax rule.
java.util.List<AttributeTypeDefinition>	getUsedBy(MatchingRuleDefinition matchingRule, Schema schema) Gets all attributes that are used by the given matching rule.
java.lang.String	guessGuid() Tries to guess the appropriate GUID for the current LDAP server.
void	importUsers() Imports LDAP users as configured in sso/ldap.cf
java.util.Map<java.lang.String,java.lang.String>	info() Returns a list of useful information about the LDAP server.
boolean	isEnabled() Returns true if LDAP is enabled, else otherwise
java.util.Map<java.lang.String,java.lang.Object>	matchingRule(java.lang.String matchingRule) Queries the matching rule definition of the given matching rule.
java.lang.String	normalizeFilter(java.lang.String filter) Removes all new lines and blank spaces from the given filter.
java.util.Map<java.lang.String,java.lang.Object>	objectClass(java.lang.String objectClass) Queries the schema definition of the given object class.
java.lang.String	readCurrentFilter() Reads the installed filter from the configuration file.
java.lang.String	readCurrentGuid() Gets the currently installed GUID.
java.util.Map<java.lang.String,java.lang.Object>	schemaGroups() Queries the schema of the installed groups' object class.
java.util.Map<java.lang.String,java.lang.Object>	schemaOrganizationalUnits() Queries the schema of the installed organizational units' object class.
java.util.Map<java.lang.String,java.lang.Object>	schemaUsers() Queries the LDAP schema of the installed users' object class.
java.util.Map<java.lang.String,java.lang.Object>	syntaxRule(java.lang.String oid) Queries the syntax rule definition of the given OID.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	testFilter(java.util.List<java.lang.String> additionalAttributes) Returns a map with the nodes found using the LDAP filter installed including all additional attributes requested.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	testGroups(java.util.List<java.lang.String> additionalAttributes) Returns a list with the LDAP groups found.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	testGuid(java.util.List<java.lang.String> additionalAttributes) Returns a list with the nodes found with the LDAP filter installed including the GUID attributes of the nodes.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	testOrganizationalUnits(java.util.List<java.lang.String> additionalAttributes) Returns a list with the LDAP organizational units found.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	testOrphans(java.util.List<java.lang.String> additionalAttributes) Returns a map containing all LDAP orphans.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	testUsers(java.util.List<java.lang.String> additionalAttributes) Returns a list with the LDAP users found.

Field Detail

CONFIG_FILE

static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

PROPERTY_HOST

static final java.util.List<java.lang.String> PROPERTY_HOST

PROPERTY_PORT

static final java.util.List<java.lang.Object> PROPERTY_PORT

PROPERTY_ENCRYPTION_PROTOCOL

static final java.util.List<java.lang.String> PROPERTY_ENCRYPTION_PROTOCOL

PROPERTY_PRINCIPAL

static final java.util.List<java.lang.String> PROPERTY_PRINCIPAL

PROPERTY_CREDENTIALS

static final java.util.List<java.lang.String> PROPERTY_CREDENTIALS

PROPERTY_BASE

static final java.util.List<java.lang.String> PROPERTY_BASE

PROPERTY_FILTER

static final java.util.List<java.lang.String> PROPERTY_FILTER

PROPERTY_EXTERNAL_DIR

static final java.util.List<java.lang.String> PROPERTY_EXTERNAL_DIR

PROPERTY_WRITE_PROTECTION

static final java.util.List<java.lang.Object> PROPERTY_WRITE_PROTECTION

PROPERTY_LOG_RESULTING_TREE

static final java.util.List<java.lang.Object> PROPERTY_LOG_RESULTING_TREE

PROPERTY_FLATTEN_TREE

static final java.util.List<java.lang.Object> PROPERTY_FLATTEN_TREE

PROPERTY_OBJECT_CLASS

static final java.util.List<java.lang.String> PROPERTY_OBJECT_CLASS

PROPERTY_GUID

static final java.util.List<java.lang.String> PROPERTY_GUID

PROPERTY_OU_OBJECT_CLASS

static final java.util.List<java.lang.String> PROPERTY_OU_OBJECT_CLASS

PROPERTY_OU_NAME

static final java.util.List<java.lang.String> PROPERTY_OU_NAME

PROPERTY_GROUP_OBJECT_CLASS

static final java.util.List<java.lang.String> PROPERTY_GROUP_OBJECT_CLASS

PROPERTY_GROUP_NAME

static final java.util.List<java.lang.String> PROPERTY_GROUP_NAME

PROPERTY_GROUP_MEMBER

static final java.util.List<java.lang.String> PROPERTY_GROUP_MEMBER

PROPERTY_USER_OBJECT_CLASS

static final java.util.List<java.lang.String> PROPERTY_USER_OBJECT_CLASS

PROPERTY_USER_FIRSTNAME

static final java.util.List<java.lang.String> PROPERTY_USER_FIRSTNAME

PROPERTY_USER_LASTNAME

static final java.util.List<java.lang.String> PROPERTY_USER_LASTNAME

PROPERTY_USER_USERNAME

static final java.util.List<java.lang.String> PROPERTY_USER_USERNAME

PROPERTY_USER_MAIL

static final java.util.List<java.lang.String> PROPERTY_USER_MAIL

DN

static final java.lang.String DN

See Also:

Constant Field Values

PARENT

static final java.lang.String PARENT

See Also:

Constant Field Values

MEMBERS

static final java.lang.String MEMBERS

See Also:

Constant Field Values

VENDOR_NAME

static final java.lang.String VENDOR_NAME

See Also:

Constant Field Values

VENDOR_VERSION

static final java.lang.String VENDOR_VERSION

See Also:

Constant Field Values

GUID_CANDIDATES

static final java.util.List<java.lang.String> GUID_CANDIDATES

Method Detail

importUsers

void importUsers()
          throws LdapException

Imports LDAP users as configured in sso/ldap.cf

Throws:

LdapException - if the LDAP users cannot be imported

authenticate

BindResult authenticate(User user,
                        java.lang.String password)
                 throws LdapException

Authenticates the given user with the given password against the LDAP origin. Note that user.origin and user.guid must be set for the given user.

Parameters:

user - the user

password - the clear-text password

Returns:

the result of the authentication

Throws:

LdapException - if something goes wrong during authentication

testFilter

java.util.List<java.util.Map<java.lang.String,java.lang.String>> testFilter(java.util.List<java.lang.String> additionalAttributes)
                                                                     throws LdapException

Returns a map with the nodes found using the LDAP filter installed including all additional attributes requested.

Parameters:

additionalAttributes - the additional attributes to request from the LDAP server

Returns:

the nodes found

Throws:

LdapException - if an error happens during node retrieval

testOrphans

java.util.List<java.util.Map<java.lang.String,java.lang.String>> testOrphans(java.util.List<java.lang.String> additionalAttributes)
                                                                      throws LdapException

Returns a map containing all LDAP orphans. These are the nodes that are not a user, a group or an organizational unit.

Parameters:

additionalAttributes - the additional attributes to request from the LDAP server

Returns:

the LDAP orphans found

Throws:

LdapException - if an error happens during node retrieval

testGuid

java.util.List<java.util.Map<java.lang.String,java.lang.String>> testGuid(java.util.List<java.lang.String> additionalAttributes)
                                                                   throws LdapException

Returns a list with the nodes found with the LDAP filter installed including the GUID attributes of the nodes.

Parameters:

additionalAttributes - the additional attributes to request from the LDAP server

Returns:

the nodes found including the GUIDs

Throws:

LdapException - if an error happens during node retrieval

testUsers

java.util.List<java.util.Map<java.lang.String,java.lang.String>> testUsers(java.util.List<java.lang.String> additionalAttributes)
                                                                    throws LdapException

Returns a list with the LDAP users found.

Parameters:

additionalAttributes - the additional attributes to request from the LDAP server

Returns:

the users found

Throws:

LdapException - if an error happens during node retrieval

schemaUsers

java.util.Map<java.lang.String,java.lang.Object> schemaUsers()
                                                      throws LdapException

Queries the LDAP schema of the installed users' object class. This object class is defined in ldap.cf (attributes.user.objectClass).

Returns:

LDAP schema of the users. Can contain Strings or Lists of Strings.

Throws:

LdapException - if an error happens during schema retrieval

filter

java.lang.String filter(int indentation,
                        boolean simplify)
                 throws LdapException

Parses the installed filter and displays it in a multi-line form that makes it easier to understand its hierarchy and embedded components.

Parameters:

indentation - Number of spaces for indentation.

simplify - indicates if to simplify the filter in certain ways (for example, by removing unnecessary levels of hierarchy, like an AND embedded in another AND).

Returns:

multi-line representation of the installed filter

Throws:

LdapException - if an error happens during parsing

getObjectClasses

java.util.List<ObjectClassDefinition> getObjectClasses()
                                                throws LdapException

Queries the schema for the existing object classes.

Returns:

a list containing the schema's object classes sorted by name

Throws:

LdapException - if an error happens during retrieval

getObjectClasses

java.util.List<ObjectClassDefinition> getObjectClasses(Schema schema)
                                                throws LdapException

Queries the schema for the existing object classes.

Parameters:

schema - the schema

Returns:

a list containing the schema's object classes sorted by name

Throws:

LdapException - if an error happens during retrieval

getAttributeTypes

java.util.List<AttributeTypeDefinition> getAttributeTypes()
                                                   throws LdapException

Queries the schema for the existing attributes.

Returns:

a list containing the schema's attributes sorted by name

Throws:

LdapException - if an error happens during retrieval

getAttributeTypes

java.util.List<AttributeTypeDefinition> getAttributeTypes(Schema schema)
                                                   throws LdapException

Queries the schema for the existing attributes.

Parameters:

schema - the schema

Returns:

a list containing the schema's attributes sorted by name

Throws:

LdapException - if an error happens during retrieval

getMatchingRules

java.util.List<MatchingRuleDefinition> getMatchingRules()
                                                 throws LdapException

Queries the schema for the existing matching rules.

Returns:

a list containing the schema's matching rules sorted by name

Throws:

LdapException - if an error happens during retrieval

getMatchingRules

java.util.List<MatchingRuleDefinition> getMatchingRules(Schema schema)
                                                 throws LdapException

Queries the schema for the existing matching rules.

Parameters:

schema - the schema

Returns:

a list containing the schema's matching rules sorted by name

Throws:

LdapException - if an error happens during retrieval

getSyntaxRules

java.util.List<AttributeSyntaxDefinition> getSyntaxRules()
                                                  throws LdapException

Queries the schema for the existing syntax rules.

Returns:

a list containing the schema's syntax rules sorted by description

Throws:

LdapException - if an error happens during retrieval

getSyntaxRules

java.util.List<AttributeSyntaxDefinition> getSyntaxRules(Schema schema)
                                                  throws LdapException

Queries the schema for the existing syntax rules.

Parameters:

schema - the schema

Returns:

a list containing the schema's syntax rules sorted by description

Throws:

LdapException - if an error happens during retrieval

schemaGroups

java.util.Map<java.lang.String,java.lang.Object> schemaGroups()
                                                       throws LdapException

Queries the schema of the installed groups' object class. This object class is defined in ldap.cf (attributes.group.objectClass).

Returns:

LDAP schema of the groups. Can contain Strings or Lists of Strings.

Throws:

LdapException - if an error happens during schema retrieval

schemaOrganizationalUnits

java.util.Map<java.lang.String,java.lang.Object> schemaOrganizationalUnits()
                                                                    throws LdapException

Queries the schema of the installed organizational units' object class. This object class is defined in ldap.cf (attributes.organizationalUnit.objectClass).

Returns:

LDAP schema of the organizational units. Can contain Strings or Lists of Strings.

Throws:

LdapException - if an error happens during schema retrieval

objectClass

java.util.Map<java.lang.String,java.lang.Object> objectClass(java.lang.String objectClass)
                                                      throws LdapException

Queries the schema definition of the given object class.

Parameters:

objectClass - the object class

Returns:

LDAP schema of the given object class. Can contain Strings or Lists of Strings.

Throws:

LdapException - if an error happens during schema retrieval

attribute

java.util.Map<java.lang.String,java.lang.Object> attribute(java.lang.String attribute)
                                                    throws LdapException

Queries the attribute definition of the given attribute.

Parameters:

attribute - the attribute

Returns:

LDAP schema definition of the given attribute. Can contain Strings or Lists of Strings.

Throws:

LdapException - if an error happens during schema retrieval

matchingRule

java.util.Map<java.lang.String,java.lang.Object> matchingRule(java.lang.String matchingRule)
                                                       throws LdapException

Queries the matching rule definition of the given matching rule.

Parameters:

matchingRule - the matching rule

Returns:

LDAP schema definition of the given matching rule. Can contain Strings or Lists of Strings.

Throws:

LdapException - if an error happens during schema retrieval

syntaxRule

java.util.Map<java.lang.String,java.lang.Object> syntaxRule(java.lang.String oid)
                                                     throws LdapException

Queries the syntax rule definition of the given OID.

Parameters:

oid - the OID of the syntax rule to query

Returns:

LDAP schema definition of the given syntax rule. Can contain Strings or Lists of Strings.

Throws:

LdapException - if an error happens during schema retrieval

getSchema

Schema getSchema()
          throws LdapException

Reads the LDAP schema

Returns:

the schema

Throws:

LdapException - if an error happens during schema retrieval

getObjectClassDefinition

ObjectClassDefinition getObjectClassDefinition(java.lang.String objectClassName,
                                               Schema schema)
                                        throws LdapException

Queries the object class definition of the given object class.

Parameters:

objectClassName - the object class

schema - the schema definition

Returns:

the object class definition

Throws:

LdapException - if an error happens during retrieval

getAttributeDefinition

AttributeTypeDefinition getAttributeDefinition(java.lang.String attribute,
                                               Schema schema)
                                        throws LdapException

Queries the attribute definition of the given attribute.

Parameters:

attribute - the attribute

schema - the schema definition

Returns:

the attribute definition

Throws:

LdapException - if an error happens during retrieval

getMatchingRuleDefinition

MatchingRuleDefinition getMatchingRuleDefinition(java.lang.String matchingRule,
                                                 Schema schema)
                                          throws LdapException

Queries the matching rule definition of the given matching rule.

Parameters:

matchingRule - the matching rule

schema - the schema definition

Returns:

the matching rule definition

Throws:

LdapException - if an error happens during retrieval

getSyntaxRuleDefinition

AttributeSyntaxDefinition getSyntaxRuleDefinition(java.lang.String oid,
                                                  Schema schema)
                                           throws LdapException

Queries the syntax rule definition of the given syntax rule OID.

Parameters:

oid - the OID of the syntax rule to query

schema - the schema definition

Returns:

the syntax rule definition

Throws:

LdapException - if an error happens during retrieval

testGroups

java.util.List<java.util.Map<java.lang.String,java.lang.String>> testGroups(java.util.List<java.lang.String> additionalAttributes)
                                                                     throws LdapException

Returns a list with the LDAP groups found.

Parameters:

additionalAttributes - the additional attributes to request from the LDAP server

Returns:

the groups found

Throws:

LdapException - if an error happens during node retrieval

testOrganizationalUnits

java.util.List<java.util.Map<java.lang.String,java.lang.String>> testOrganizationalUnits(java.util.List<java.lang.String> additionalAttributes)
                                                                                  throws LdapException

Returns a list with the LDAP organizational units found.

Parameters:

additionalAttributes - the additional attributes to request from the LDAP server

Returns:

the organizational units found

Throws:

LdapException - if an error happens during node retrieval

info

java.util.Map<java.lang.String,java.lang.String> info()
                                               throws LdapException

Returns a list of useful information about the LDAP server.

Returns:

information about the LDAP server

Throws:

LdapException - if an error happens during information retrieval

readCurrentFilter

java.lang.String readCurrentFilter()
                            throws LdapException

Reads the installed filter from the configuration file.

Returns:

the installed filter

Throws:

LdapException - if an error happens during the retrieval.

normalizeFilter

java.lang.String normalizeFilter(java.lang.String filter)
                          throws LdapException

Removes all new lines and blank spaces from the given filter.

Returns:

normalized filter

Throws:

LdapException - if an error happens during the normalization.

guessGuid

java.lang.String guessGuid()
                    throws LdapException

Tries to guess the appropriate GUID for the current LDAP server.

Returns:

a best-try guess of the GUID needed

Throws:

LdapException - if an error happens during the guess

readCurrentGuid

java.lang.String readCurrentGuid()
                          throws LdapException

Gets the currently installed GUID.

Returns:

the currently installed GUID.

Throws:

LdapException - if something goes wrong during reading

getSubClasses

java.util.List<ObjectClassDefinition> getSubClasses(ObjectClassDefinition objectClassDef,
                                                    Schema schema)
                                             throws LdapException

Fetches the direct subclasses of the given objectClass definition.

Parameters:

objectClassDef - the parent object class definition

schema - the schema

Returns:

the parent's direct subclasses

Throws:

LdapException - if something goes wrong during reading

getSubAttributes

java.util.List<AttributeTypeDefinition> getSubAttributes(AttributeTypeDefinition attributeDef,
                                                         Schema schema)
                                                  throws LdapException

Fetches the direct attributes of the given attribute definition.

Parameters:

attributeDef - the parent attribute definition

schema - the schema

Returns:

the parent's direct sub-attributes

Throws:

LdapException - if something goes wrong during reading

getUsedAsOptional

java.util.List<ObjectClassDefinition> getUsedAsOptional(AttributeTypeDefinition attributeDef,
                                                        Schema schema)
                                                 throws LdapException

Gets all object class definitions using the given attribute type definition as an optional attribute.

Parameters:

attributeDef - the attribute definition

schema - the schema

Returns:

the object class definitions using the given attribute type definition as an optional attribute sorted by name

Throws:

LdapException - if something goes wrong during retrieval

getUsedAsRequired

java.util.List<ObjectClassDefinition> getUsedAsRequired(AttributeTypeDefinition attributeDef,
                                                        Schema schema)
                                                 throws LdapException

Gets all object class definitions using the given attribute type definition as an optional attribute.

Parameters:

attributeDef - the attribute definition

schema - the schema

Returns:

the object class definitions using the given attribute type definition as an optional attribute sorted by name

Throws:

LdapException - if something goes wrong during retrieval

getUsedBy

java.util.List<AttributeTypeDefinition> getUsedBy(MatchingRuleDefinition matchingRule,
                                                  Schema schema)
                                           throws LdapException

Gets all attributes that are used by the given matching rule.

Parameters:

matchingRule - the matching rule

schema - the schema

Returns:

all attributes that are used by the given matching rule sorted by name

Throws:

LdapException - if something goes wrong during retrieval

getUsedBy

java.util.List<AttributeTypeDefinition> getUsedBy(AttributeSyntaxDefinition syntaxRule,
                                                  Schema schema)
                                           throws LdapException

Gets all attributes that are used by the given syntax rule.

Parameters:

syntaxRule - the syntax rule

schema - the schema

Returns:

all attributes that are used by the given syntax rule sorted by name

Throws:

LdapException - if something goes wrong during retrieval

getAllNames

java.lang.String getAllNames(ObjectClassDefinition objectClass)
                      throws LdapException

Returns a string containing all names of the given object class joined with a comma.

Parameters:

objectClass - the object class

Returns:

concatenation of all names of the given object class

Throws:

LdapException - if something goes wrong

getAllNames

java.lang.String getAllNames(AttributeTypeDefinition attribute)
                      throws LdapException

Returns a string containing all names of the given attribute joined with a comma.

Parameters:

attribute - the attribute

Returns:

comma concatenation of all names of the given attribute

Throws:

LdapException - if something goes wrong

getAllNames

java.lang.String getAllNames(MatchingRuleDefinition matchingRule)
                      throws LdapException

Returns a string containing all names of the given matching rule joined with a comma.

Parameters:

matchingRule - the matching rule

Returns:

comma concatenation of all names of the given matching rule

Throws:

LdapException - if something goes wrong

getEntry

java.lang.String getEntry()
                   throws LdapException

Returns a string representation of the schema entry

Returns:

a string representation of the schema entry

Throws:

LdapException - if something goes wrong

isEnabled

boolean isEnabled()

Returns true if LDAP is enabled, else otherwise

Returns:

true if LDAP is enabled, else otherwise