Package com.unboundid.ldap.sdk
Interface ReusableReferralConnector
-
- All Superinterfaces:
ReferralConnector
- All Known Implementing Classes:
PooledReferralConnector
@Extensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface ReusableReferralConnector extends ReferralConnector
This interface defines an API that may be used to obtain aFullLDAPInterface
(e.g., a connection pool) that may be used for the purpose of following a referral. When configured with aReusableReferralConnector
rather than a baseReferralConnector
, one of the methods in this class will be used in preference to theReferralConnector.getReferralConnection(com.unboundid.ldap.sdk.LDAPURL, com.unboundid.ldap.sdk.LDAPConnection)
method.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FullLDAPInterface
getReferralInterface(LDAPURL referralURL, LDAPConnection connection)
Retrieves aFullLDAPInterface
for use in following a referral returned in the provided result.-
Methods inherited from interface com.unboundid.ldap.sdk.ReferralConnector
getReferralConnection
-
-
-
-
Method Detail
-
getReferralInterface
@NotNull FullLDAPInterface getReferralInterface(@NotNull LDAPURL referralURL, @NotNull LDAPConnection connection) throws LDAPException
Retrieves aFullLDAPInterface
for use in following a referral returned in the provided result. The caller must not do anything to attempt to leave the interface in an unusable state (e.g., closing a connection or connection pool).- Parameters:
referralURL
- The LDAP URL for the referral to follow. It must not benull
.connection
- The connection on which the referral was received. It will not benull
.- Returns:
- A
FullLDAPInterface
for use in following a referral with the given URL. - Throws:
LDAPException
- If a problem occurs while obtaining theFullLDAPInterface
to use for following the referral.
-
-