org.ldaptive

Class LdapURL.Entry

java.lang.Object

org.ldaptive.LdapURL.Entry

Enclosing class:

LdapURL

public static class LdapURL.Entry
extends java.lang.Object

Represents a single LDAP URL entry.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String[]	DEFAULT_ATTRIBUTES Default return attributes, value is none.
protected static java.lang.String	DEFAULT_BASE_DN Default base DN, value is "".
protected static SearchFilter	DEFAULT_FILTER Default search filter value is '(objectClass=*)'.
protected static int	DEFAULT_LDAP_PORT Default LDAP port, value is 389.
protected static int	DEFAULT_LDAPS_PORT Default LDAPS port, value is 636.
protected static SearchScope	DEFAULT_SCOPE Default scope, value is SearchScope.OBJECT.
private java.lang.String[]	urlAttributes Attributes of the ldap url.
private java.lang.String	urlBaseDn Base DN of the ldap url.
private SearchFilter	urlFilter Search filter of the ldap url.
private java.lang.String	urlHostname Hostname of the ldap url.
private int	urlPort Port of the ldap url.
private java.lang.String	urlScheme Scheme of the ldap url.
private SearchScope	urlScope Search scope of the ldap url.

Constructor Summary

Constructors

Constructor and Description
Entry(java.lang.String scheme, java.lang.String hostname, int port, java.lang.String baseDn, java.lang.String[] attributes, SearchScope scope, SearchFilter filter) Creates a new entry.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAttributes() Returns the attributes.
java.lang.String	getBaseDn() Returns the base DN.
SearchFilter	getFilter() Returns the filter.
java.lang.String	getHostname() Returns the entryHostname.
java.lang.String	getHostnameWithPort() Returns the hostname:port.
java.lang.String	getHostnameWithSchemeAndPort() Returns the scheme://hostname:port.
int	getPort() Returns the entryPort.
java.lang.String	getScheme() Returns the entryScheme.
SearchScope	getScope() Returns the scope.
java.lang.String	getUrl() Returns the formatted URL as scheme://hostname:port/baseDn?attrs?scope?filter.
boolean	isDefaultAttributes() Returns whether attributes were supplied in this entry.
boolean	isDefaultBaseDn() Returns whether a base DN was supplied in this entry.
boolean	isDefaultFilter() Returns whether a filter was supplied in this entry.
boolean	isDefaultPort() Returns whether a port was supplied in this entry.
boolean	isDefaultScope() Returns whether a scope was supplied in this entry.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LDAP_PORT

protected static final int DEFAULT_LDAP_PORT

Default LDAP port, value is 389.

See Also:

Constant Field Values

DEFAULT_LDAPS_PORT

protected static final int DEFAULT_LDAPS_PORT

Default LDAPS port, value is 636.

See Also:

Constant Field Values

DEFAULT_BASE_DN

protected static final java.lang.String DEFAULT_BASE_DN

Default base DN, value is "".

See Also:

Constant Field Values

DEFAULT_FILTER

protected static final SearchFilter DEFAULT_FILTER

Default search filter value is '(objectClass=*)'.

DEFAULT_SCOPE

protected static final SearchScope DEFAULT_SCOPE

Default scope, value is SearchScope.OBJECT.

DEFAULT_ATTRIBUTES

protected static final java.lang.String[] DEFAULT_ATTRIBUTES

Default return attributes, value is none.

urlScheme

private final java.lang.String urlScheme

Scheme of the ldap url.

urlHostname

private final java.lang.String urlHostname

Hostname of the ldap url.

urlPort

private final int urlPort

Port of the ldap url.

urlBaseDn

private final java.lang.String urlBaseDn

Base DN of the ldap url.

urlAttributes

private final java.lang.String[] urlAttributes

Attributes of the ldap url.

urlScope

private final SearchScope urlScope

Search scope of the ldap url.

urlFilter

private final SearchFilter urlFilter

Search filter of the ldap url.

Constructor Detail

Entry

public Entry(java.lang.String scheme,
             java.lang.String hostname,
             int port,
             java.lang.String baseDn,
             java.lang.String[] attributes,
             SearchScope scope,
             SearchFilter filter)

Creates a new entry.

Parameters:

scheme - entryScheme

hostname - entryHostname

port - entryPort

baseDn - base DN

attributes - attributes

scope - search scope

filter - search filter

Method Detail

getScheme

public java.lang.String getScheme()

Returns the entryScheme.

Returns:

entryScheme

getHostname

public java.lang.String getHostname()

Returns the entryHostname.

Returns:

entryHostname

getPort

public int getPort()

Returns the entryPort.

Returns:

entryPort

isDefaultPort

public boolean isDefaultPort()

Returns whether a port was supplied in this entry.

Returns:

whether a port was supplied in this entry

getBaseDn

public java.lang.String getBaseDn()

Returns the base DN.

Returns:

baseDn

isDefaultBaseDn

public boolean isDefaultBaseDn()

Returns whether a base DN was supplied in this entry.

Returns:

whether a base DN was supplied in this entry

getAttributes

public java.lang.String[] getAttributes()

Returns the attributes.

Returns:

attributes

isDefaultAttributes

public boolean isDefaultAttributes()

Returns whether attributes were supplied in this entry.

Returns:

whether a attributes were supplied in this entry

getScope

public SearchScope getScope()

Returns the scope.

Returns:

scope

isDefaultScope

public boolean isDefaultScope()

Returns whether a scope was supplied in this entry.

Returns:

whether a scope was supplied in this entry

getFilter

public SearchFilter getFilter()

Returns the filter.

Returns:

filter

isDefaultFilter

public boolean isDefaultFilter()

Returns whether a filter was supplied in this entry.

Returns:

whether a filter was supplied in this entry

getUrl

public java.lang.String getUrl()

Returns the formatted URL as scheme://hostname:port/baseDn?attrs?scope?filter.

Returns:

url

getHostnameWithPort

public java.lang.String getHostnameWithPort()

Returns the hostname:port.

Returns:

hostname:port

getHostnameWithSchemeAndPort

public java.lang.String getHostnameWithSchemeAndPort()

Returns the scheme://hostname:port.

Returns:

scheme://hostname:port

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object