org.ldaptive

Class LdapURL

java.lang.Object

org.ldaptive.LdapURL

public class LdapURL
extends java.lang.Object

Utility class for parsing LDAP URLs. See RFC 4516. Supports a space delimited format for representing multiple URLs. Expects URLs of the form scheme://hostname:port/baseDn?attrs?scope?filter. This implementation does not support URL extensions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LdapURL.Entry Represents a single LDAP URL entry.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DEFAULT_DELIMITER Default delimiter for ldap urls.
private java.util.List<LdapURL.Entry>	ldapEntries URL entries.
static java.lang.String	NO_DELIMITER Do not split URL.
private static java.util.regex.Pattern	URL_PATTERN Pattern to match LDAP URLs.

Constructor Summary

Constructors

Constructor and Description
LdapURL(java.lang.String url) Creates a new ldap url.
LdapURL(java.lang.String url, java.lang.String delimiter) Creates a new ldap url.

Method Summary

Modifier and Type	Method and Description
java.util.List<LdapURL.Entry>	getEntries() Returns a list of all the ldap url entries in this ldap url.
LdapURL.Entry	getEntry() Returns the first entry of this ldap url.
java.lang.String[]	getHostnames() Returns a list of all the hostnames in this ldap url.
java.lang.String[]	getHostnamesWithSchemeAndPort() Returns a list of all the hostnames including their scheme and port in this ldap url.
LdapURL.Entry	getLastEntry() Returns the last entry of this ldap url.
java.lang.String[]	getUrls() Returns a list of all the URLs in this ldap url.
protected LdapURL.Entry	parseEntry(java.lang.String url) Matches the supplied url against a pattern and reads it's components.
int	size() Returns the number of entries in this ldap url.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_DELIMITER

public static final java.lang.String NO_DELIMITER

Do not split URL.

See Also:

Constant Field Values

DEFAULT_DELIMITER

private static final java.lang.String DEFAULT_DELIMITER

Default delimiter for ldap urls.

See Also:

Constant Field Values

URL_PATTERN

private static final java.util.regex.Pattern URL_PATTERN

Pattern to match LDAP URLs.

ldapEntries

private final java.util.List<LdapURL.Entry> ldapEntries

URL entries.

Constructor Detail

LdapURL

public LdapURL(java.lang.String url)

Creates a new ldap url.

Parameters:

url - space delimited list of ldap urls

LdapURL

public LdapURL(java.lang.String url,
               java.lang.String delimiter)

Creates a new ldap url.

Parameters:

url - space delimited list of ldap urls

delimiter - to split url with

Method Detail

parseEntry

protected LdapURL.Entry parseEntry(java.lang.String url)

Matches the supplied url against a pattern and reads it's components.

Parameters:

url - to parse

Returns:

entry

getEntry

public LdapURL.Entry getEntry()

Returns the first entry of this ldap url.

Returns:

first entry

getLastEntry

public LdapURL.Entry getLastEntry()

Returns the last entry of this ldap url.

Returns:

last entry

getEntries

public java.util.List<LdapURL.Entry> getEntries()

Returns a list of all the ldap url entries in this ldap url.

Returns:

ldap url entries

getUrls

public java.lang.String[] getUrls()

Returns a list of all the URLs in this ldap url.

Returns:

ldap urls

getHostnamesWithSchemeAndPort

public java.lang.String[] getHostnamesWithSchemeAndPort()

Returns a list of all the hostnames including their scheme and port in this ldap url.

Returns:

ldap url hostnames with scheme and port

getHostnames

public java.lang.String[] getHostnames()

Returns a list of all the hostnames in this ldap url.

Returns:

ldap url hostnames

size

public int size()

Returns the number of entries in this ldap url.

Returns:

number of entries in this ldap url

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object