senselogic.sitevision.api.security

Interface DirectoryUtil

@Requireable(value="DirectoryUtil")
public interface DirectoryUtil

LDAP directory utility interface.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getDirectoryUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
Property	getAttributeAsProperty(Node aDirectoryObjectNode, String anAttributeName) Gets a directory attribute value for a directory node object as Property.
Node	getNodeByDN(String aDirectoryObjectDN) Gets a directory node object with a specific distinguished name, dn.
List<Node>	search(String aSearchFilter) Searches for objects in all LDAP directories that are accessible in current context (i.e. current page).
List<Node>	search(String aSearchFilter, Node aDirectoryNode) Searches for objects in a specified LDAP directory.
List<Node>	search(String aSearchFilter, Node aDirectoryNode, String aSearchBase) Searches for objects in a specified search base in a specified LDAP directory.
Map<String,Map<String,String>>	simpleSearch(String aSearchFilter, String searchBase, List<String> attributes) Searches for ids in a specified search base in all directories.

Method Detail

search

List<Node> search(String aSearchFilter)

Searches for objects in all LDAP directories that are accessible in current context (i.e. current page).

Some examples of RFC 2254 valid values for aSearchFilter:

• "magnus" - find all magnus, using the search base specified by the directories (usually common name)
• "(cn=magnus)" - find all with common name (cn) magnus
• "(cn=magnus*)" - find all that has a common name (cn) that starts with magnus
• "(&(cn=magnus)(mail=*))" - find all that has a mail address and magnus as common name (cn)
• "(|(cn=magnus)((sn=L*)))" - find all with common name (cn) magnus or a surname (sn) that starts with L

Parameters:

aSearchFilter - LDAP search filter (as specified by RFC 2254)

Returns:

the search result as a List. If there are no hits, an empty List is returned.

See Also:

search(String,Node)

search

List<Node> search(String aSearchFilter,
                  Node aDirectoryNode)

Searches for objects in a specified LDAP directory.

Tip! The repository for all LDAP directory nodes can be located via the getDirectoryRepository() method in ResourceLocatorUtil

Parameters:

aSearchFilter - LDAP search filter (as specified by RFC 2254)

aDirectoryNode - a LDAP directory Node

Returns:

the search result as a List. If there are no hits, an empty List is returned.

See Also:

search(String)

search

List<Node> search(String aSearchFilter,
                  Node aDirectoryNode,
                  String aSearchBase)

Searches for objects in a specified search base in a specified LDAP directory.

Parameters:

aSearchFilter - LDAP search filter (as specified by RFC 2254)

aDirectoryNode - a LDAP directory Node

aSearchBase - a search base that exist in aDirectoryNode

Returns:

the search result as a List. If there are no hits, an empty List is returned.

See Also:

search(String,Node)

getNodeByDN

Node getNodeByDN(String aDirectoryObjectDN)

Gets a directory node object with a specific distinguished name, dn.

Parameters:

aDirectoryObjectDN - the directory dn for a directory object

Returns:

the directory object Node, or null if indeterminate

getAttributeAsProperty

Property getAttributeAsProperty(Node aDirectoryObjectNode,
                                String anAttributeName)

Gets a directory attribute value for a directory node object as Property.

The default properties for a directory node object adheres/corresponds to the attributes defined in the directory scheme. All attributes that are defined in the scheme are exposed as properties in the Sitevision JCR model. This method tries to find the attribute via the Sitevision JCR model but if no property can be found it executes LDAP queries to find the attribute. This makes it possible to find scheme-defined attributes, but also custom-defined ones.

Parameters:

aDirectoryObjectNode - a directory object node that has an attribute

anAttributeName - the attribute name

Returns:

the attribute value as Property, or null if indeterminate (e.g. aDirectoryObjectNode is not a directory object node or aDirectoryObjectNode has no attribute named anAttributeName)

simpleSearch

Map<String,Map<String,String>> simpleSearch(String aSearchFilter,
                                            String searchBase,
                                            List<String> attributes)

Searches for ids in a specified search base in all directories.

Parameters:

aSearchFilter - LDAP search filter (as specified by RFC 2254)

searchBase - search base for the search, if null all directories for current node will be searched

attributes - a List of return attributes

Returns:

the search result as a Map. If there are no hits, an empty Map is returned. The Map contains ids as keys and a Map as values containing the returned attributes.

Since:

Sitevision 2.6.1_02