org.apache.directory.shared.ldap.message
Class ReferralImpl

java.lang.Object
  org.apache.directory.shared.ldap.message.ReferralImpl

All Implemented Interfaces:

InternalReferral

public class ReferralImpl
extends java.lang.Object
implements InternalReferral

A Referral implementation. For the time being this implementation uses a String representation for LDAPURLs. In the future an LdapUrl interface with default implementations will be used once a parser for an LdapUrl is created.

Version:

$Rev: 764131 $

Author:

Apache Directory Project

Constructor Summary

ReferralImpl()

Method Summary

void	addLdapUrl(java.lang.String url) Adds an LDAPv3 URL to this Referral.
boolean	equals(java.lang.Object obj) Compares this Referral implementation to see if it is the same as another.
java.util.Collection<java.lang.String>	getLdapUrls() Gets an unmodifiable set of alternative referral urls.
void	removeLdapUrl(java.lang.String url) Removes an LDAPv3 URL to this Referral.
java.lang.String	toString() Get a String representation of a Referral

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferralImpl

public ReferralImpl()

Method Detail

getLdapUrls

public java.util.Collection<java.lang.String> getLdapUrls()

Gets an unmodifiable set of alternative referral urls.

Specified by:

getLdapUrls in interface InternalReferral

Returns:

the alternative url objects.

addLdapUrl

public void addLdapUrl(java.lang.String url)

Adds an LDAPv3 URL to this Referral.

Specified by:

addLdapUrl in interface InternalReferral

Parameters:

url - the LDAPv3 URL to add

removeLdapUrl

public void removeLdapUrl(java.lang.String url)

Removes an LDAPv3 URL to this Referral.

Specified by:

removeLdapUrl in interface InternalReferral

Parameters:

url - the LDAPv3 URL to remove

equals

public boolean equals(java.lang.Object obj)

Compares this Referral implementation to see if it is the same as another. The classes do not have to be the same implementation to return true. Both this and the compared Referral must have the same entries exactly. The order of Referral URLs does not matter.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare this ReferralImpl to

Returns:

true if both implementations contain exactly the same URLs

toString

public java.lang.String toString()

Get a String representation of a Referral

Overrides:

toString in class java.lang.Object

Returns:

A Referral String