com.entrust.toolkit.util

Class LdapURL

java.lang.Object

com.entrust.toolkit.util.LdapURL

public class LdapURL
extends java.lang.Object

This class represents an LDAP URL, as specified in RFC 2255.

The RFC2255 representation of an LDAP URL is defined using the following grammar:

     ldapurl    = scheme "://" [hostport] ["/"
                  [dn ["?" [attributes] ["?" [scope]
                  ["?" [filter] ["?" extensions]]]]]]
     scheme     = "ldap"
     attributes = attrdesc *("," attrdesc)
     scope      = "base" / "one" / "sub"
     dn         = distinguishedName
     hostport   = hostport
     attrdesc   = AttributeDescription
     filter     = filter
     extensions = extension *("," extension)
     extension  = ["!"] extype ["=" exvalue]
     extype     = token / xtoken
     exvalue    = LDAPString
     token      = oid
     xtoken     = ("X-" / "x-") token
 

Refer to RFC 2255 for the complete definition of an LDAP URL.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	attributes The attributes component of an LDAP URL.
protected Name	dn The dn component of an LDAP URL.
protected java.lang.String	extensions The extensions component of an LDAP URL.
protected java.lang.String	filter The filter component of an LDAP URL.
protected java.lang.String	host The host component of an LDAP URL.
protected int	port The port component of an LDAP URL.
protected java.lang.String	scheme The scheme component of an LDAP URL.
protected int	scope The scope component of an LDAP URL.
static int	SCOPE_BASE Scope mode base.
static int	SCOPE_ONE Scope mode one.
static int	SCOPE_SUB Scope mode sub.

Constructor Summary

Constructors

Constructor and Description
LdapURL(java.lang.String url) Creates an LdapURL object by parsing the given String representing an LDAP URL, and extracting its components.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAttributes() Retrieves the attributes component of the LDAP URL.
Name	getDN() Retrieves the DN component of the LDAP URL.
java.lang.String	getExtensions() Retrieves the extensions component of the LDAP URL.
java.lang.String	getFilter() Retrieves the filter component of the LDAP URL.
java.lang.String	getHost() Retrieves the host component of the LDAP URL.
int	getPort() Retrieves the port component of the LDAP URL.
java.lang.String	getScheme() Retrieves the scheme component of the LDAP URL.
int	getScope() Retrieves the scope component of the LDAP URL.
boolean	isEmpty() Determines whether this LdapURL object is empty.
boolean	isLdapURL() Determines whether the String contained in this object is an LDAP URL.
static boolean	isLdapURL(java.lang.String url) Determines whether the input String is an LDAP URL.
java.lang.String	toString() Provides the String representation of an LDAP URL.

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_BASE

public static final int SCOPE_BASE

Scope mode base.

See Also:

Constant Field Values

SCOPE_ONE

public static final int SCOPE_ONE

Scope mode one.

See Also:

Constant Field Values

SCOPE_SUB

public static final int SCOPE_SUB

Scope mode sub.

See Also:

Constant Field Values

scheme

protected java.lang.String scheme

The scheme component of an LDAP URL.

host

protected java.lang.String host

The host component of an LDAP URL.

port

protected int port

The port component of an LDAP URL.

dn

protected Name dn

The dn component of an LDAP URL.

attributes

protected java.lang.String attributes

The attributes component of an LDAP URL.

scope

protected int scope

The scope component of an LDAP URL.

filter

protected java.lang.String filter

The filter component of an LDAP URL.

extensions

protected java.lang.String extensions

The extensions component of an LDAP URL.

Constructor Detail

LdapURL

public LdapURL(java.lang.String url)
        throws java.lang.Exception

Creates an LdapURL object by parsing the given String representing an LDAP URL, and extracting its components.

Parameters:

url - a String representing an LDAP URL according to RFC 2255. Must not be null.

Throws:

java.lang.Exception - if a parsing error occurs

Method Detail

getScheme

public java.lang.String getScheme()

Retrieves the scheme component of the LDAP URL.

Returns:

The LDAP URL's scheme component or null if the scheme component does not exist.

getHost

public java.lang.String getHost()

Retrieves the host component of the LDAP URL.

Returns:

The LDAP URL's host component or null if the host component does not exist.

getPort

public int getPort()

Retrieves the port component of the LDAP URL.

Returns:

The LDAP URL's port component or the default port number if no port number is specified.

getDN

public Name getDN()

Retrieves the DN component of the LDAP URL.

Returns:

The LDAP URL's DN component or null if the DN component does not exist.

getAttributes

public java.lang.String getAttributes()

Retrieves the attributes component of the LDAP URL.

Returns:

The LDAP URL's attributes component or null if the attributes component does not exist.

getScope

public int getScope()

Retrieves the scope component of the LDAP URL.

Returns:

The LDAP URL's scope component, or the default value base if no scope value is specified.

getFilter

public java.lang.String getFilter()

Retrieves the filter component of the LDAP URL.

Returns:

The LDAP URL's filter component, or (objectclass=*) if no filter value is specified.

getExtensions

public java.lang.String getExtensions()

Retrieves the extensions component of the LDAP URL.

Returns:

The LDAP URL's extensions component, or null if the extensions component does not exist.

isLdapURL

public static boolean isLdapURL(java.lang.String url)

Determines whether the input String is an LDAP URL.

According to RFC 2255 an LDAP URL must start with "ldap://". However, the toolkit will also allow the scheme to be case insensitive as recommended by RFC 1738:

 'For resiliency, programs interpreting URLs should treat upper case letters
  as equivalent to lower case in scheme names (e.g., allow "HTTP" as well as "http")'.
 

Parameters:

url - the string to be tested — must not be null

Returns:

Returns true if the String is an LDAP URL, false otherwise.

isLdapURL

public boolean isLdapURL()

Determines whether the String contained in this object is an LDAP URL.

According to RFC 2255 an LDAP URL must start with "ldap://".

Returns:

Returns true if this object contains an LDAP URL, false otherwise.

toString

public java.lang.String toString()

Provides the String representation of an LDAP URL.

Overrides:

toString in class java.lang.Object

Returns:

The LDAP URL as a String.

isEmpty

public boolean isEmpty()

Determines whether this LdapURL object is empty.

An LDAP URL is empty if its host and DN components are both null.

Returns:

Returns true if the LDAP URL is empty, false otherwise.