org.datanucleus.store.ldap

Class LDAPUtils

java.lang.Object

org.datanucleus.store.ldap.LDAPUtils

public class LDAPUtils
extends Object

Convenience methods for LDAP datastores.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDAPUtils.LocationInfo Information where an object is located in the LDAP tree.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	NO_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
LDAPUtils()

Method Summary

Modifier and Type	Method and Description
static LdapName	composeDistinguishedName(LdapName parentDn, Rdn rdn, LdapName suffix) Composes the distinguished name.
static void	deleteRecursive(LdapName dn, DirContext ctx)
static void	deleteRecursive(org.datanucleus.store.StoreManager storeMgr, LdapName dn, org.datanucleus.ExecutionContext ec)
protected static Object	findObjectUsingAID(org.datanucleus.ExecutionContext ec, Class pcCls, org.datanucleus.store.FieldValues fv, boolean ignoreCache, boolean checkInheritance) Accessor for the ObjectProvider of an object given the object AID.
static List<org.datanucleus.metadata.AbstractMemberMetaData>	getAllMemberMetaData(org.datanucleus.metadata.AbstractClassMetaData cmd)
static String	getAttributeNameForField(org.datanucleus.metadata.AbstractMemberMetaData mmd) Accessor for the (LDAP) attribute name for the specified field.
static Object	getAttributeValue(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.state.ObjectProvider op, String attributeName) Gets the attribute value of an specific attribute name from the ObjectProvider.
static Collection<Object>	getAttributeValuesFromLDAP(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.state.ObjectProvider op, String attributeName) Gets the attribute value of an specific attribute name from LDAP.
static LdapName	getDistinguishedNameForObject(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.state.ObjectProvider op) Convenience method to return the distinguished name for the object being managed.
static LdapName	getDistinguishedNameForObject(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.state.ObjectProvider op, boolean forceFetchHierarchicalMappedDn) Convenience method to return the distinguished name for the object being managed.
static org.datanucleus.metadata.AbstractClassMetaData	getEffectiveClassMetaData(org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.metadata.MetaDataManager mmgr) Gets the effective class meta data for the given field meta data.
static String	getEmptyValue(org.datanucleus.metadata.AbstractMemberMetaData mmd) Convenience method to return value defined in extension "empty-value" of the given field meta data, null if not specified.
static Map<LdapName,Attributes>	getEntries(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.ExecutionContext ec, org.datanucleus.metadata.AbstractClassMetaData candidateCmd, LdapName base, String additionalFilter, boolean subclasses, boolean ignoreCache)
static LDAPUtils.LocationInfo	getLocationInfo(org.datanucleus.metadata.AbstractClassMetaData cmd) Convenience method to return the distinguished name pattern for the metadata being managed.
static List<org.datanucleus.metadata.AbstractMemberMetaData>	getMemberMetaData(int[] fieldNumbers, org.datanucleus.metadata.AbstractClassMetaData cmd)
static org.datanucleus.metadata.AbstractMemberMetaData	getMemberMetadataForAttributeName(org.datanucleus.metadata.AbstractClassMetaData cmd, String attributeName) Gets the member metadata from the given class metadata which attribute name matches the given LDAP attribute name.
static Object	getObjectByAttribute(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.ExecutionContext ec, Class type, String attributeName, String attributeValue, org.datanucleus.metadata.MetaDataManager mmgr) Gets an object by type and attribute.
static Object	getObjectByDN(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.ExecutionContext om, Class type, String dnAsString)
static Set<String>	getObjectClassesForClass(org.datanucleus.metadata.AbstractClassMetaData cmd) Accessor for the (LDAP) object classes for the specified class.
static List<Object>	getObjectsOfCandidateType(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.ExecutionContext ec, org.datanucleus.metadata.AbstractClassMetaData candidateCmd, LdapName base, String additionalFilter, boolean subclasses, boolean ignoreCache)
static List<Object>	getObjectsOfCandidateType(org.datanucleus.store.StoreManager storeMgr, org.datanucleus.ExecutionContext ec, org.datanucleus.query.compiler.QueryCompilation compilation, Map parameters, Class candidateClass, boolean subclasses, boolean ignoreCache, boolean inMemory) Convenience method to get all objects of the candidate type (and optional subclasses).
static LdapName	getParentDistingueshedName(LdapName dn, LdapName suffix) Gets the distinguished name of the parent object
static LdapName	getSearchBase(org.datanucleus.metadata.AbstractClassMetaData cmd, org.datanucleus.metadata.MetaDataManager mmgr)
static SearchControls	getSearchControls(org.datanucleus.metadata.AbstractClassMetaData cmd) Gets the search controls.
static String	getSearchFilter(org.datanucleus.metadata.AbstractClassMetaData cmd) Convenience method to get the LDAP filter for the specified class.
static void	insert(org.datanucleus.store.StoreManager storeMgr, LdapName dn, Attributes attributes, org.datanucleus.ExecutionContext ec)
static boolean	isEmbeddedField(org.datanucleus.metadata.AbstractMemberMetaData mmd)
static boolean	isHierarchicalMappedAtChild(org.datanucleus.state.ObjectProvider sm) Convenience method to check if the given object is mapped hierarchical.
static void	markForDeletion(Object pc, org.datanucleus.ExecutionContext ec)
static void	markForPersisting(Object pc, org.datanucleus.ExecutionContext ec)
static void	markForRename(org.datanucleus.store.StoreManager storeMgr, Object pc, org.datanucleus.ExecutionContext ec, LdapName oldDn, LdapName newDn)
static void	unmarkForDeletion(Object pc, org.datanucleus.ExecutionContext ec)
static void	update(org.datanucleus.store.StoreManager storeMgr, LdapName dn, Attributes attributes, org.datanucleus.ExecutionContext ec)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_ATTRIBUTES

public static final String[] NO_ATTRIBUTES

Constructor Detail

LDAPUtils

public LDAPUtils()

Method Detail

getEffectiveClassMetaData

public static org.datanucleus.metadata.AbstractClassMetaData getEffectiveClassMetaData(org.datanucleus.metadata.AbstractMemberMetaData mmd,
                                                                                       org.datanucleus.metadata.MetaDataManager mmgr)

Gets the effective class meta data for the given field meta data. This is either the class meta data of field itself or, if the field is a collection type, the class meta data of the collection's elements.

Parameters:

mmd - the field meta data

mmgr - Metadata manager

Returns:

the effective class meta data, null if none found

getMemberMetadataForAttributeName

public static org.datanucleus.metadata.AbstractMemberMetaData getMemberMetadataForAttributeName(org.datanucleus.metadata.AbstractClassMetaData cmd,
                                                                                                String attributeName)

Gets the member metadata from the given class metadata which attribute name matches the given LDAP attribute name.

Parameters:

cmd - the class metadata

attributeName - the LDAP attribute name

Returns:

the member metadata which attribute name matches, null if not found

getAllMemberMetaData

public static List<org.datanucleus.metadata.AbstractMemberMetaData> getAllMemberMetaData(org.datanucleus.metadata.AbstractClassMetaData cmd)

getMemberMetaData

public static List<org.datanucleus.metadata.AbstractMemberMetaData> getMemberMetaData(int[] fieldNumbers,
                                                                                      org.datanucleus.metadata.AbstractClassMetaData cmd)

isEmbeddedField

public static boolean isEmbeddedField(org.datanucleus.metadata.AbstractMemberMetaData mmd)

isHierarchicalMappedAtChild

public static boolean isHierarchicalMappedAtChild(org.datanucleus.state.ObjectProvider sm)

Convenience method to check if the given object is mapped hierarchical.

Parameters:

sm - ObjectProvider

Returns:

true if is hierarchical mapped

getParentDistingueshedName

public static LdapName getParentDistingueshedName(LdapName dn,
                                                  LdapName suffix)

Gets the distinguished name of the parent object

Parameters:

dn - The distinguished name

suffix - the suffix defined in "dn" extension

Returns:

the distinguished name of the parent object

getDistinguishedNameForObject

public static LdapName getDistinguishedNameForObject(org.datanucleus.store.StoreManager storeMgr,
                                                     org.datanucleus.state.ObjectProvider op)

Convenience method to return the distinguished name for the object being managed. Uses the extension "dn" if specified, else the "table" if specified as parent container. Uses the PK name and value as RDN.

Parameters:

storeMgr - Store Manager

op - ObjectProvider

Returns:

Distinguished name

getDistinguishedNameForObject

public static LdapName getDistinguishedNameForObject(org.datanucleus.store.StoreManager storeMgr,
                                                     org.datanucleus.state.ObjectProvider op,
                                                     boolean forceFetchHierarchicalMappedDn)

Convenience method to return the distinguished name for the object being managed. Uses the extension "dn" if specified, else the "table" if specified as parent container. Uses the PK name and value as RDN.

Parameters:

storeMgr - Store Manager

op - ObjectProvider

forceFetchHierarchicalMappedDn - true to fetch the name from directory server

Returns:

Distinguished name

getSearchBase

public static LdapName getSearchBase(org.datanucleus.metadata.AbstractClassMetaData cmd,
                                     org.datanucleus.metadata.MetaDataManager mmgr)

getSearchControls

public static SearchControls getSearchControls(org.datanucleus.metadata.AbstractClassMetaData cmd)

Gets the search controls. Contains scope SUBTREE_SCOPE in case hierarchical mapping is used, scope ONELEVEL_SCOPE otherwise.

Parameters:

cmd - the class meta data

Returns:

the search controls

getSearchFilter

public static String getSearchFilter(org.datanucleus.metadata.AbstractClassMetaData cmd)

Convenience method to get the LDAP filter for the specified class.

Parameters:

cmd - the class meta data

Returns:

the object classes filter the specified class, null if no object class

getLocationInfo

public static LDAPUtils.LocationInfo getLocationInfo(org.datanucleus.metadata.AbstractClassMetaData cmd)

Convenience method to return the distinguished name pattern for the metadata being managed. Uses the extension "dn" if specified, else the "table" if specified.

Parameters:

cmd - the class meta data

Returns:

the DN as String

getEmptyValue

public static String getEmptyValue(org.datanucleus.metadata.AbstractMemberMetaData mmd)

Convenience method to return value defined in extension "empty-value" of the given field meta data, null if not specified. Used as workaround for attributes member (object class groupOfNames) and uniqueMemeber (object classgroupOfUniqueNames) which must contain at least one value

Parameters:

mmd - the member meta data

Returns:

the value

getAttributeValue

public static Object getAttributeValue(org.datanucleus.store.StoreManager storeMgr,
                                       org.datanucleus.state.ObjectProvider op,
                                       String attributeName)

Gets the attribute value of an specific attribute name from the ObjectProvider.

Parameters:

storeMgr - Store Manager

op - ObjectProvider

attributeName - the attribute name

Returns:

the attribute value

getAttributeValuesFromLDAP

public static Collection<Object> getAttributeValuesFromLDAP(org.datanucleus.store.StoreManager storeMgr,
                                                            org.datanucleus.state.ObjectProvider op,
                                                            String attributeName)

Gets the attribute value of an specific attribute name from LDAP.

Parameters:

storeMgr - Store Manager

op - ObjectProvider

attributeName - the attribute name

Returns:

the attribute value

getAttributeNameForField

public static String getAttributeNameForField(org.datanucleus.metadata.AbstractMemberMetaData mmd)

Accessor for the (LDAP) attribute name for the specified field. Uses the extension "dn" if specified (deprecated), else the extension "attribute" if specified, else the "column" if specified, else uses the field name.

Parameters:

mmd - MetaData for the field

Returns:

The attribute

getObjectClassesForClass

public static Set<String> getObjectClassesForClass(org.datanucleus.metadata.AbstractClassMetaData cmd)

Accessor for the (LDAP) object classes for the specified class. Uses the extension "objectClass" if specified, else the "schema" if specified. name.

Parameters:

cmd - Metadata for the class

Returns:

The object classes

composeDistinguishedName

public static LdapName composeDistinguishedName(LdapName parentDn,
                                                Rdn rdn,
                                                LdapName suffix)
                                         throws InvalidNameException

Composes the distinguished name.

Parameters:

parentDn - the parent dn

rdn - the rdn

suffix - the suffix

Returns:

the ldap name

Throws:

InvalidNameException - if error occurs

getObjectByDN

public static Object getObjectByDN(org.datanucleus.store.StoreManager storeMgr,
                                   org.datanucleus.ExecutionContext om,
                                   Class type,
                                   String dnAsString)

getObjectByAttribute

public static Object getObjectByAttribute(org.datanucleus.store.StoreManager storeMgr,
                                          org.datanucleus.ExecutionContext ec,
                                          Class type,
                                          String attributeName,
                                          String attributeValue,
                                          org.datanucleus.metadata.MetaDataManager mmgr)

Gets an object by type and attribute.

Parameters:

storeMgr - Store Manager

ec - object manager

type - the object type

attributeName - the attribute name

attributeValue - the attribute value

mmgr - the meta data manager

Returns:

The object

markForPersisting

public static void markForPersisting(Object pc,
                                     org.datanucleus.ExecutionContext ec)

markForRename

public static void markForRename(org.datanucleus.store.StoreManager storeMgr,
                                 Object pc,
                                 org.datanucleus.ExecutionContext ec,
                                 LdapName oldDn,
                                 LdapName newDn)

markForDeletion

public static void markForDeletion(Object pc,
                                   org.datanucleus.ExecutionContext ec)

unmarkForDeletion

public static void unmarkForDeletion(Object pc,
                                     org.datanucleus.ExecutionContext ec)

getObjectsOfCandidateType

public static List<Object> getObjectsOfCandidateType(org.datanucleus.store.StoreManager storeMgr,
                                                     org.datanucleus.ExecutionContext ec,
                                                     org.datanucleus.query.compiler.QueryCompilation compilation,
                                                     Map parameters,
                                                     Class candidateClass,
                                                     boolean subclasses,
                                                     boolean ignoreCache,
                                                     boolean inMemory)

Convenience method to get all objects of the candidate type (and optional subclasses).

Parameters:

storeMgr - Store Manager

ec - The object manager

compilation - The query

parameters - The input parameters

candidateClass - The class of the candidates

subclasses - Include subclasses?

ignoreCache - Whether to ignore the cache

inMemory - Whether to filter in memory or to use native LDAP filters

Returns:

List of objects of the candidate type (or subclass)

getObjectsOfCandidateType

public static List<Object> getObjectsOfCandidateType(org.datanucleus.store.StoreManager storeMgr,
                                                     org.datanucleus.ExecutionContext ec,
                                                     org.datanucleus.metadata.AbstractClassMetaData candidateCmd,
                                                     LdapName base,
                                                     String additionalFilter,
                                                     boolean subclasses,
                                                     boolean ignoreCache)

Parameters:

storeMgr - Store Manager

ec - The object manager

candidateCmd - The class meta data of the candidate

base - the search base, or null to use the base of candidateCmd

additionalFilter - the additional filter, or null to only use the filter of candidateCmd

subclasses - true to include subclasses

ignoreCache - whether to ignore the cache

Returns:

List of objects

findObjectUsingAID

protected static Object findObjectUsingAID(org.datanucleus.ExecutionContext ec,
                                           Class pcCls,
                                           org.datanucleus.store.FieldValues fv,
                                           boolean ignoreCache,
                                           boolean checkInheritance)

Accessor for the ObjectProvider of an object given the object AID. Note that this is moved from ExecutionContextImpl since only LDAP uses it now.

Parameters:

ec - ExecutionContext

pcCls - Type of the PC object

fv - The field values to be loaded

ignoreCache - true if it must ignore the cache

checkInheritance - Whether look to the database to determine which class this object is. This parameter is a hint. Set false, if it's already determined the correct pcClass for this pc "object" in a certain level in the hierarchy. Set to true and it will look to the database.

Returns:

Object

getEntries

public static Map<LdapName,Attributes> getEntries(org.datanucleus.store.StoreManager storeMgr,
                                                  org.datanucleus.ExecutionContext ec,
                                                  org.datanucleus.metadata.AbstractClassMetaData candidateCmd,
                                                  LdapName base,
                                                  String additionalFilter,
                                                  boolean subclasses,
                                                  boolean ignoreCache)

insert

public static void insert(org.datanucleus.store.StoreManager storeMgr,
                          LdapName dn,
                          Attributes attributes,
                          org.datanucleus.ExecutionContext ec)

update

public static void update(org.datanucleus.store.StoreManager storeMgr,
                          LdapName dn,
                          Attributes attributes,
                          org.datanucleus.ExecutionContext ec)

deleteRecursive

public static void deleteRecursive(org.datanucleus.store.StoreManager storeMgr,
                                   LdapName dn,
                                   org.datanucleus.ExecutionContext ec)

deleteRecursive

public static void deleteRecursive(LdapName dn,
                                   DirContext ctx)
                            throws NamingException

Throws:

NamingException