Package org.opends.guitools.controlpanel.browser

Class ConnectionWithControls

java.lang.Object

org.opends.guitools.controlpanel.browser.ConnectionWithControls

All Implemented Interfaces:

Closeable, AutoCloseable

public final class ConnectionWithControls
extends Object
implements Closeable

Associates a ConnectionWrapper with the LDAP Controls it should use when performing operation.

The relevant controls are automatically added to the request when calling add(AddRequest), delete(DeleteRequest), modify(ModifyRequest), modifyDN(ModifyDNRequest), search(SearchRequest) or searchSingleEntry(SearchRequest).

Constructor Summary

Constructors

Constructor	Description
ConnectionWithControls(ConnectionWrapper conn, ServerSideSortRequestControl sortControl, ManageDsaITRequestControl followReferralsControl)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	add(AddRequest request)	Adds with the provided request.
void	close()
void	delete(DeleteRequest request)	Deletes with the provided request.
ConnectionWrapper	getConnectionWrapper()	Returns the connection wrapper.
void	modify(ModifyRequest request)	Modifies with the provided request.
void	modifyDN(ModifyDNRequest request)	modifies a DN with the provided request.
ConnectionEntryReader	search(SearchRequest request)	Searches using the provided request.
SearchResultEntry	searchSingleEntry(SearchRequest request)	Searches a single entry.
void	setRequestControls(ServerSideSortRequestControl sortControl, ManageDsaITRequestControl followReferralsControl)	Sets the sort and manage dsa it controls to use when making LDAP operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionWithControls

public ConnectionWithControls(ConnectionWrapper conn,
                              ServerSideSortRequestControl sortControl,
                              ManageDsaITRequestControl followReferralsControl)

Constructor.

Parameters:

conn - the connection wrapper

sortControl - the sort control, may be null

followReferralsControl - the manage dsa IT control, may be null

Method Detail

getConnectionWrapper

public ConnectionWrapper getConnectionWrapper()

Returns the connection wrapper.

DO NOT USE TO PERFORM LDAP OPERATIONS!

This getter is only used to allow to query its state.

Returns:

the read-only connection wrapper.

setRequestControls

public void setRequestControls(ServerSideSortRequestControl sortControl,
                               ManageDsaITRequestControl followReferralsControl)

Sets the sort and manage dsa it controls to use when making LDAP operations.

Parameters:

sortControl - the sort control, may be null

followReferralsControl - the manage dsa IT control, may be null

searchSingleEntry

public SearchResultEntry searchSingleEntry(SearchRequest request)
                                    throws LdapException

Searches a single entry.

Parameters:

request - the request

Returns:

the non-null single SearchResultEntry

Throws:

LdapException - if an error occurred.

See Also:

Connection.searchSingleEntry(SearchRequest)

search

public ConnectionEntryReader search(SearchRequest request)

Searches using the provided request.

Parameters:

request - the request

Returns:

a non-null ConnectionEntryReader

See Also:

Connection.search(SearchRequest)

add

public void add(AddRequest request)
         throws LdapException

Adds with the provided request.

Parameters:

request - the request

Throws:

LdapException - if an error occurred.

See Also:

Connection.add(AddRequest)

delete

public void delete(DeleteRequest request)
            throws LdapException

Deletes with the provided request.

Parameters:

request - the request

Throws:

LdapException - if an error occurred.

See Also:

Connection.delete(DeleteRequest)

modify

public void modify(ModifyRequest request)
            throws LdapException

Modifies with the provided request.

Parameters:

request - the request

Throws:

LdapException - if an error occurred.

See Also:

Connection.modify(ModifyRequest)

modifyDN

public void modifyDN(ModifyDNRequest request)
              throws LdapException

modifies a DN with the provided request.

Parameters:

request - the request

Throws:

LdapException - if an error occurred.

See Also:

Connection.modifyDN(ModifyDNRequest)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable