iiitAccessServer 1.0

de.iiit.access.server.util
Class LdapUtil

java.lang.Object
  |
  +--de.iiit.access.server.util.LdapUtil

public class LdapUtil
extends Object

This class is used for all LDAP requests of the LDAP plug-in.


Constructor Summary
LdapUtil()
          Creates a new instance of LdapPlugin
 
Method Summary
 String getLdapCommonName()
          The LDAP attribute to use for names
 String getLdapExpression()
          The LDAP attribute to use for expressions
 String getLdapFormulaBase()
          Retrieves the configured LDAP search base for expressions
 String getLdapFormulaClass()
          Retrieves the configured LDAP object class to use for expressions
 String getLdapGroupBase()
          Retrieves the configured LDAP search base for groups
 String getLdapGroupClass()
          Retrieves the configured LDAP object class to use for groups
 String getLdapGroupMember()
          The LDAP attribute to use for user IDs of group members
 String getLdapPersonBase()
          Retrieves the configured LDAP search base for persons
 String getLdapPersonClass()
          Retrieves the configured LDAP object class to use for persons
 String getLdapUserId()
          The LDAP attribute to use for user IDs
 void initialize(Configuration config)
          Initialize the current object.
 Vector search(String searchBase, String filter, String[] attrs)
          Retrieves records from the LDAP database.
 void shutdown()
          Stop the refresher thread
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LdapUtil

public LdapUtil()
Creates a new instance of LdapPlugin

Method Detail

initialize

public void initialize(Configuration config)
Initialize the current object. If there is an configuration error, System.exit(1) will be called. These attributes are needed:
LdapPersonClass The LDAP class used for persons
LdapGroupClass The LDAP class used for groups
LdapFormulaClass The LDAP class used for expressions
LdapPersonSearchBase The search base for persons
LdapGroupSearchBase The search base for groups
LdapFormulaSearchBase The search base for expressions
Additionaly there must be one or more entities describing LDAP connections a needed by the LdapConnectionManager

Parameters:
config - The configuration needed for the LDAP requests.

shutdown

public void shutdown()
Stop the refresher thread


getLdapPersonBase

public String getLdapPersonBase()
Retrieves the configured LDAP search base for persons

Returns:
the configured LDAP search base for persons

getLdapPersonClass

public String getLdapPersonClass()
Retrieves the configured LDAP object class to use for persons

Returns:
the configured LDAP object class to use for persons

getLdapFormulaBase

public String getLdapFormulaBase()
Retrieves the configured LDAP search base for expressions

Returns:
the configured LDAP search base for expressions

getLdapFormulaClass

public String getLdapFormulaClass()
Retrieves the configured LDAP object class to use for expressions

Returns:
the configured LDAP object class to use for expressions

getLdapGroupBase

public String getLdapGroupBase()
Retrieves the configured LDAP search base for groups

Returns:
the configured LDAP search base for groups

getLdapGroupClass

public String getLdapGroupClass()
Retrieves the configured LDAP object class to use for groups

Returns:
the configured LDAP object class to use for groups

getLdapExpression

public String getLdapExpression()
The LDAP attribute to use for expressions

Returns:
the configured LDAP field name for expressions

getLdapCommonName

public String getLdapCommonName()
The LDAP attribute to use for names

Returns:
the configured LDAP field name for names

getLdapUserId

public String getLdapUserId()
The LDAP attribute to use for user IDs

Returns:
the configured LDAP field name for user IDs

getLdapGroupMember

public String getLdapGroupMember()
The LDAP attribute to use for user IDs of group members

Returns:
the configured LDAP field name for user IDs of group members

search

public Vector search(String searchBase,
                     String filter,
                     String[] attrs)
              throws NamingException
Retrieves records from the LDAP database.

Parameters:
searchBase - The search base to use for the request.
filter - The search filter to use for the request
attrs - The attributes to retrieve
Returns:
the results encapsulated as LdapGenericObject
Throws:
NamingException - if a LDAP error occured

iiitAccessServer 1.0

Copyright © 2002, 2003 ingeneurbuero fuer innovative informationstechnik, Dipl.-Ing. Joerg Beckmann, Dortmund, Germany. All Rights Reserved.
See Copyright statement