org.apache.directory.shared.ldap.url
Interface LdapUrl

public interface LdapUrl

A parsed LDAP URL.

Version:

$Revision: 434411 $

Author:

Apache Directory Project

Method Summary

java.util.List	getAttributes() Gets the attributes component of this LdapUrl.
java.util.List	getExtensions() Gets the extensions component of this LdapUrl.
ExprNode	getFilter() Gets the filter component of this LdapUrl as a filter expression tree.
java.lang.String	getHostName() Gets the hostname component of this LdapUrl.
javax.naming.Name	getName() Gets the distinguished name of this LdapUrl.
int	getPort() Gets the port component of this LdapUrl.
int	getScope() Gets the scope of the search if this LdapUrl represents a search URL.
boolean	isSecure() Gets whether or not secure ldaps scheme with SSL is used or normal ldap scheme is used.

Method Detail

getName

javax.naming.Name getName()

Gets the distinguished name of this LdapUrl.

Returns:

the non-normalized Dn

getHostName

java.lang.String getHostName()

Gets the hostname component of this LdapUrl.

Returns:

the hostname of the server.

getPort

int getPort()

Gets the port component of this LdapUrl.

Returns:

the port number component of the LdapUrl.

getFilter

ExprNode getFilter()

Gets the filter component of this LdapUrl as a filter expression tree.

Returns:

the filter expression tree's root node.

getAttributes

java.util.List getAttributes()

Gets the attributes component of this LdapUrl.

Returns:

a List containing the attribute names as Strings to return in the search results if this LdapUrl represents a search. If attributes are not specified the list will be empty.

getExtensions

java.util.List getExtensions()

Gets the extensions component of this LdapUrl. TODO can't say I know what this is at the moment

Returns:

a List containing the extensions

getScope

int getScope()

Gets the scope of the search if this LdapUrl represents a search URL. The values returned are defined within the JNDI SearchControls class.

Returns:

the scope of the search.

See Also:

SearchControls.OBJECT_SCOPE, SearchControls.ONELEVEL_SCOPE, SearchControls.SUBTREE_SCOPE

isSecure

boolean isSecure()

Gets whether or not secure ldaps scheme with SSL is used or normal ldap scheme is used.

Returns:

true if ldaps is the scheme, false if it is ldap