@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class LDAPUrl extends java.lang.Object implements java.io.Serializable
LDAPURL
class should
be used instead.Constructor and Description |
---|
LDAPUrl(LDAPURL ldapURL)
Creates a new
LDAPUrl object from the provided LDAPURL
object. |
LDAPUrl(java.lang.String url)
Creates a new
LDAPUrl object from the provided string
representation. |
LDAPUrl(java.lang.String host,
int port,
java.lang.String dn)
Creates a new
LDAPUrl object with the provided information. |
LDAPUrl(java.lang.String host,
int port,
java.lang.String dn,
java.util.Enumeration<java.lang.String> attributes,
int scope,
java.lang.String filter)
Creates a new
LDAPUrl object with the provided information. |
LDAPUrl(java.lang.String host,
int port,
java.lang.String dn,
java.lang.String[] attributes,
int scope,
java.lang.String filter)
Creates a new
LDAPUrl object with the provided information. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this LDAP URL.
|
java.lang.String[] |
getAttributeArray()
Retrieves an array of the names of the requested attributes for this LDAP
URL, if available.
|
java.util.Enumeration<java.lang.String> |
getAttributes()
Retrieves an enumeration of the names of the requested attributes for this
LDAP URL, if available.
|
java.lang.String |
getDN()
Retrieves the DN for this LDAP URL, if available.
|
java.lang.String |
getFilter()
Retrieves the filter for this LDAP URL.
|
java.lang.String |
getHost()
Retrieves the address for this LDAP URL, if available.
|
int |
getPort()
Retrieves the port number for this LDAP URL.
|
int |
getScope()
Retrieves the search scope for the LDAP URL.
|
java.lang.String |
getUrl()
Retrieves a string representation of this LDAP URL.
|
int |
hashCode()
Retrieves a hash code for this LDAP URL.
|
LDAPURL |
toLDAPURL()
Retrieves an
LDAPURL object that is the equivalent of this LDAP
URL. |
java.lang.String |
toString()
Retrieves a string representation of this LDAP URL.
|
public LDAPUrl(java.lang.String url) throws java.net.MalformedURLException
LDAPUrl
object from the provided string
representation.url
- The string representation of the LDAP URL to create.java.net.MalformedURLException
- If the provided string cannot be parsed as
a valid LDAP URL.public LDAPUrl(java.lang.String host, int port, java.lang.String dn) throws java.lang.RuntimeException
LDAPUrl
object with the provided information.host
- The address of the directory server, or null
if there
should not be an address.port
- The port of the directory server.dn
- The DN for the URL.java.lang.RuntimeException
- If any of the provided information cannot be
used to create a valid LDAP URL.public LDAPUrl(java.lang.String host, int port, java.lang.String dn, java.lang.String[] attributes, int scope, java.lang.String filter) throws java.lang.RuntimeException
LDAPUrl
object with the provided information.host
- The address of the directory server, or null
if
there should not be an address.port
- The port of the directory server.dn
- The DN for the URL.attributes
- The set of requested attributes.scope
- The scope to use for the LDAP URL.filter
- The filter to use for the LDAP URL.java.lang.RuntimeException
- If any of the provided information cannot be
used to create a valid LDAP URL.public LDAPUrl(java.lang.String host, int port, java.lang.String dn, java.util.Enumeration<java.lang.String> attributes, int scope, java.lang.String filter) throws java.lang.RuntimeException
LDAPUrl
object with the provided information.host
- The address of the directory server, or null
if
there should not be an address.port
- The port of the directory server.dn
- The DN for the URL.attributes
- The set of requested attributes.scope
- The scope to use for the LDAP URL.filter
- The filter to use for the LDAP URL.java.lang.RuntimeException
- If any of the provided information cannot be
used to create a valid LDAP URL.public java.lang.String getHost()
null
if it is not
available.public int getPort()
public java.lang.String getDN()
null
if it is not available.public java.util.Enumeration<java.lang.String> getAttributes()
null
if there are none.public java.lang.String[] getAttributeArray()
null
if there are none.public int getScope()
public java.lang.String getFilter()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.true
if the provided object is equal to this LDAP URL, or
false
if not.public java.lang.String getUrl()
public final LDAPURL toLDAPURL()
LDAPURL
object that is the equivalent of this LDAP
URL.LDAPURL
object that is the equivalent of this LDAP URL.public java.lang.String toString()
toString
in class java.lang.Object