oracle.oud.types

Interface LDAPUrl

public interface LDAPUrl

An LDAP URL as defined in RFC 4516. In addition, the secure ldap (ldaps://) is also supported. LDAP URLs have the following format:

 "ldap[s]://" [ hostName [":" portNumber] ]
          "/" distinguishedName
          ["?" attributeList
              ["?" scope "?" filterString ] ]
 

Where:

• all text within double-quotes are literal
• hostName and portNumber identify the location of the LDAP server.
• distinguishedName is the name of an entry within the given directory (the entry represents the starting point of the search).
• attributeList contains a list of attributes to retrieve (if null, fetch all attributes). This is a comma-delimited list of attribute names.
• scope is one of the following:
  • base indicates that this is a search only for the specified entry
  • one indicates that this is a search for matching entries one level under the specified entry (and not including the entry itself)
  • sub indicates that this is a search for matching entries at all levels under the specified entry (including the entry itself)
  • subordinates indicates that this is a search for matching entries all levels under the specified entry (excluding the entry itself)
  If not specified, scope is base by default.
• filterString is a human-readable representation of the search criteria. If no filter is provided, then a default of "(objectClass=*)" should be assumed.

The same encoding rules for other URLs (e.g. HTTP) apply for LDAP URLs. Specifically, any "illegal" characters are escaped with %HH, where HH represent the two hex digits which correspond to the ASCII value of the character. This encoding is only legal (or necessary) on the DN and filter portions of the URL.

Note that this class does not implement extensions.

Creation of LDAPUrl is provided by newLDAPUrl(String)

See Also:

RFC 4516 - Lightweight Directory Access Protocol (LDAP): Uniform Resource Locator

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAttributes() Returns a list containing the attributes to be included with each entry that matches the search criteria.
Filter	getFilter() Returns the search filter associated with this LDAP URL.
java.lang.String	getHost() Returns the name or IP address in dotted format of the LDAP server referenced by this LDAP URL.
DN	getName() Returns the distinguished name of the base entry relative to which the search is to be performed.
int	getPort() Returns the port number of the LDAP server referenced by this LDAP URL.
SearchScope	getScope() Returns the search scope associated with this LDAP URL.
boolean	isSecure() Returns true if this LDAP URL should use LDAPS or false if it should use LDAP.
void	setFilter(Filter filter) Sets the search filter associated with this LDAP URL.
void	setHost(java.lang.String host) Sets the host associated with this LDAP URL.
void	setName(DN name) Sets the distinguished name of the base entry relative to which the search is to be performed.
void	setPort(int port) Sets the port number of the LDAP server referenced by this LDAP URL.
void	setScope(SearchScope searchScope) Sets the search scope of the LDAP server referenced by this LDAP URL.

Method Detail

getAttributes

java.util.Set<java.lang.String> getAttributes()

Returns a list containing the attributes to be included with each entry that matches the search criteria. Attributes that are sub-types of listed attributes are implicitly included. If the returned list is empty then all user attributes will be included by default.

Returns:

A list containing the attributes to be included with each entry that matches the search criteria.

getFilter

Filter getFilter()

Returns the search filter associated with this LDAP URL.

Returns:

The search filter associated with this LDAP URL.

setFilter

void setFilter(Filter filter)
        throws java.lang.IllegalArgumentException

Sets the search filter associated with this LDAP URL.

Parameters:

filter - the search filter

Throws:

java.lang.IllegalArgumentException - if the provided filter is invalid.

getHost

java.lang.String getHost()

Returns the name or IP address in dotted format of the LDAP server referenced by this LDAP URL. For example, ldap.server1.com or 192.202.185.90. Use null for the local host.

Returns:

A name or IP address in dotted format of the LDAP server referenced by this LDAP URL.

setHost

void setHost(java.lang.String host)

Sets the host associated with this LDAP URL. Use null for the local host.

Parameters:

host - the host associated with this LDAP URL.

getName

DN getName()

Returns the distinguished name of the base entry relative to which the search is to be performed.

Returns:

The distinguished name of the base entry relative to which the search is to be performed.

setName

void setName(DN name)
      throws java.lang.IllegalArgumentException

Sets the distinguished name of the base entry relative to which the search is to be performed.

Parameters:

name - the distinguished name

Throws:

java.lang.IllegalArgumentException - if the provided Dn is invalid.

getPort

int getPort()

Returns the port number of the LDAP server referenced by this LDAP URL.

Returns:

The port number of the LDAP server referenced by this LDAP URL.

setPort

void setPort(int port)

Sets the port number of the LDAP server referenced by this LDAP URL.

Parameters:

port - the port number

getScope

SearchScope getScope()

Returns the search scope associated with this LDAP URL.

Returns:

The search scope associated with this LDAP URL.

setScope

void setScope(SearchScope searchScope)

Sets the search scope of the LDAP server referenced by this LDAP URL.

Parameters:

searchScope - the search scope

isSecure

boolean isSecure()

Returns true if this LDAP URL should use LDAPS or false if it should use LDAP.

Returns:

true if this LDAP URL should use LDAPS or false if it should use LDAP.