Uses of Class
org.forgerock.opendj.ldap.LdapException

Packages that use LdapException

Package	Description
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.requests	Classes and interfaces for core LDAP requests.
org.forgerock.opendj.ldap.schema	Classes and interfaces for constructing and querying LDAP schemas.
org.forgerock.opendj.ldap.spi	Interfaces and classes for service providers.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.

Uses of LdapException in org.forgerock.opendj.ldap

Subclasses of LdapException in org.forgerock.opendj.ldap

Modifier and Type	Class	Description
class	AssertionFailureException	Thrown when the result code returned in a Result indicates that the Request failed because the filter contained in an assertion control failed to match the target entry.
class	AuthenticationException	Thrown when the result code returned in a Result indicates that the Bind Request failed due to an authentication failure.
class	AuthorizationException	Thrown when the result code returned in a Result indicates that the Request failed due to an authorization failure.
class	CancelledResultException	Thrown when the result code returned in a Result indicates that the Request was cancelled.
class	ConnectionException	Thrown when the result code returned in a Result indicates that the Request was unsuccessful because of a connection failure.
class	ConstraintViolationException	Thrown when the result code returned in a Result indicates that the update Request failed because it would have left the Directory in an inconsistent state.
class	EntryNotFoundException	Thrown when the result code returned in a Result indicates that the Request failed because the target entry was not found by the Directory Server.
class	MultipleEntriesFoundException	Thrown when the result code returned in a Result indicates that the requested single entry search operation or read operation failed because the Directory Server returned multiple matching entries (or search references) when only a single matching entry was expected.
class	ReferralException	Thrown when the result code returned in a Result indicates that the Request could not be processed by the Directory Server because the target entry is located on another server.
class	TimeoutResultException	Thrown when the result code returned in a Result indicates that the Request was aborted because it did not complete in the required time out period.

Methods in org.forgerock.opendj.ldap that return LdapException

Modifier and Type	Method	Description
static LdapException	LdapException.newLdapException(Result result)	Creates a new LDAP exception using the provided result.
static LdapException	LdapException.newLdapException(ResultCode resultCode)	Creates a new LDAP exception with the provided result code and an empty diagnostic message.
static LdapException	LdapException.newLdapException(ResultCode resultCode, CharSequence diagnosticMessage)	Creates a new LDAP exception with the provided result code and diagnostic message.
static LdapException	LdapException.newLdapException(ResultCode resultCode, CharSequence diagnosticMessage, Throwable cause)	Creates a new LDAP exception with the provided result code, diagnostic message, and cause.
static LdapException	LdapException.newLdapException(ResultCode resultCode, Throwable cause)	Creates a new LDAP exception with the provided result code and cause.

Methods in org.forgerock.opendj.ldap that return types with arguments of type LdapException

Modifier and Type	Method	Description
org.forgerock.util.promise.Promise<Connection,LdapException>	ConnectionFactory.getConnectionAsync()	Asynchronously obtains a connection to the Directory Server associated with this connection factory.
org.forgerock.util.promise.Promise<Connection,LdapException>	ConnectionPool.getConnectionAsync()	Asynchronously obtains a connection from this connection pool, potentially opening a new connection if needed.
org.forgerock.util.promise.Promise<Connection,LdapException>	LDAPConnectionFactory.getConnectionAsync()

Methods in org.forgerock.opendj.ldap with parameters of type LdapException

Modifier and Type	Method	Description
void	ConnectionEventListener.handleConnectionError(boolean isDisconnectNotification, LdapException error)	Notifies this connection event listener that a fatal error has occurred and the connection can no longer be used - the server has crashed, for example.
void	LoadBalancerEventListener.handleConnectionFactoryOffline(ConnectionFactory factory, LdapException error)	Invoked when the load-balancer is unable to obtain a connection from the specified connection factory.
void	LdapResultHandler.handleException(LdapException exception)	Invoked when the asynchronous operation has failed.

Method parameters in org.forgerock.opendj.ldap with type arguments of type LdapException

Modifier and Type	Method	Description
<VOUT> LdapPromise<VOUT>	LdapPromise.then(org.forgerock.util.Function<? super S,VOUT,LdapException> onResult)
<VOUT> LdapPromise<VOUT>	LdapPromise.thenAsync(org.forgerock.util.AsyncFunction<? super S,VOUT,LdapException> onResult)
LdapPromise<S>	LdapPromise.thenOnException(org.forgerock.util.promise.ExceptionHandler<? super LdapException> onException)
LdapPromise<S>	LdapPromise.thenOnResultOrException(org.forgerock.util.promise.ResultHandler<? super S> onResult, org.forgerock.util.promise.ExceptionHandler<? super LdapException> onException)

Methods in org.forgerock.opendj.ldap that throw LdapException

Modifier and Type	Method	Description
Result	AbstractAsynchronousConnection.add(AddRequest request)
Result	AbstractConnection.add(String... ldifLines)
Result	AbstractConnection.add(Entry entry)
Result	AbstractConnectionWrapper.add(String... ldifLines)	Adds an entry to the Directory Server using the provided lines of LDIF.
Result	AbstractConnectionWrapper.add(Entry entry)	Adds the provided entry to the Directory Server.
Result	AbstractConnectionWrapper.add(AddRequest request)	Adds an entry to the Directory Server using the provided add request.
Result	Connection.add(String... ldifLines)	Adds an entry to the Directory Server using the provided lines of LDIF.
Result	Connection.add(Entry entry)	Adds the provided entry to the Directory Server.
Result	Connection.add(AddRequest request)	Adds an entry to the Directory Server using the provided add request.
Result	AbstractConnection.applyChange(ChangeRecord request)
Result	AbstractConnectionWrapper.applyChange(ChangeRecord request)	Applies the provided change request to the Directory Server.
Result	Connection.applyChange(ChangeRecord request)	Applies the provided change request to the Directory Server.
BindResult	AbstractAsynchronousConnection.bind(BindRequest request)
BindResult	AbstractConnection.bind(String name, char[] password)
BindResult	AbstractConnectionWrapper.bind(String name, char[] password)	Authenticates to the Directory Server using simple authentication and the provided user name and password.
BindResult	AbstractConnectionWrapper.bind(BindRequest request)	Authenticates to the Directory Server using the provided bind request.
BindResult	Connection.bind(String name, char[] password)	Authenticates to the Directory Server using simple authentication and the provided user name and password.
BindResult	Connection.bind(BindRequest request)	Authenticates to the Directory Server using the provided bind request.
CompareResult	AbstractAsynchronousConnection.compare(CompareRequest request)
CompareResult	AbstractConnection.compare(String name, String attributeDescription, String assertionValue)
CompareResult	AbstractConnectionWrapper.compare(String name, String attributeDescription, String assertionValue)	Compares the named entry in the Directory Server against the provided attribute value assertion.
CompareResult	AbstractConnectionWrapper.compare(CompareRequest request)	Compares an entry in the Directory Server using the provided compare request.
CompareResult	Connection.compare(String name, String attributeDescription, String assertionValue)	Compares the named entry in the Directory Server against the provided attribute value assertion.
CompareResult	Connection.compare(CompareRequest request)	Compares an entry in the Directory Server using the provided compare request.
Result	AbstractAsynchronousConnection.delete(DeleteRequest request)
Result	AbstractConnection.delete(String name)
Result	AbstractConnectionWrapper.delete(String name)	Deletes the named entry from the Directory Server.
Result	AbstractConnectionWrapper.delete(DeleteRequest request)	Deletes an entry from the Directory Server using the provided delete request.
Result	Connection.delete(String name)	Deletes the named entry from the Directory Server.
Result	Connection.delete(DeleteRequest request)	Deletes an entry from the Directory Server using the provided delete request.
Result	AbstractConnection.deleteSubtree(String name)
Result	AbstractConnectionWrapper.deleteSubtree(String name)	Deletes the named entry and all of its subordinates from the Directory Server.
Result	Connection.deleteSubtree(String name)	Deletes the named entry and all of its subordinates from the Directory Server.
<R extends ExtendedResult> R	AbstractAsynchronousConnection.extendedRequest(ExtendedRequest<R> request, IntermediateResponseHandler handler)
GenericExtendedResult	AbstractConnection.extendedRequest(String requestName, ByteString requestValue)
<R extends ExtendedResult> R	AbstractConnection.extendedRequest(ExtendedRequest<R> request)
GenericExtendedResult	AbstractConnectionWrapper.extendedRequest(String requestName, ByteString requestValue)	Requests that the Directory Server performs the provided extended request.
<R extends ExtendedResult> R	AbstractConnectionWrapper.extendedRequest(ExtendedRequest<R> request)	Requests that the Directory Server performs the provided extended request.
<R extends ExtendedResult> R	AbstractConnectionWrapper.extendedRequest(ExtendedRequest<R> request, IntermediateResponseHandler handler)	Requests that the Directory Server performs the provided extended request, optionally listening for any intermediate responses.
GenericExtendedResult	Connection.extendedRequest(String requestName, ByteString requestValue)	Requests that the Directory Server performs the provided extended request.
<R extends ExtendedResult> R	Connection.extendedRequest(ExtendedRequest<R> request)	Requests that the Directory Server performs the provided extended request.
<R extends ExtendedResult> R	Connection.extendedRequest(ExtendedRequest<R> request, IntermediateResponseHandler handler)	Requests that the Directory Server performs the provided extended request, optionally listening for any intermediate responses.
Connection	ConnectionFactory.getConnection()	Returns a connection to the Directory Server associated with this connection factory.
Connection	ConnectionPool.getConnection()	Obtains a connection from this connection pool, potentially opening a new connection if needed.
Connection	LDAPConnectionFactory.getConnection()
RequestHandler<R>	RequestHandlerFactory.handleAccept(C clientContext)	Invoked when a new client connection is accepted by the associated listener.
ServerConnection<R>	ServerConnectionFactory.handleAccept(C clientContext)	Deprecated. Invoked when a new client connection is accepted by the associated listener.
Result	AbstractAsynchronousConnection.modify(ModifyRequest request)
Result	AbstractConnection.modify(String... ldifLines)
Result	AbstractConnectionWrapper.modify(String... ldifLines)	Modifies an entry in the Directory Server using the provided lines of LDIF.
Result	AbstractConnectionWrapper.modify(ModifyRequest request)	Modifies an entry in the Directory Server using the provided modify request.
Result	Connection.modify(String... ldifLines)	Modifies an entry in the Directory Server using the provided lines of LDIF.
Result	Connection.modify(ModifyRequest request)	Modifies an entry in the Directory Server using the provided modify request.
Result	AbstractAsynchronousConnection.modifyDN(ModifyDNRequest request)
Result	AbstractConnection.modifyDN(String name, String newRDN)
Result	AbstractConnectionWrapper.modifyDN(String name, String newRDN)	Renames the named entry in the Directory Server using the provided new RDN.
Result	AbstractConnectionWrapper.modifyDN(ModifyDNRequest request)	Renames an entry in the Directory Server using the provided modify DN request.
Result	Connection.modifyDN(String name, String newRDN)	Renames the named entry in the Directory Server using the provided new RDN.
Result	Connection.modifyDN(ModifyDNRequest request)	Renames an entry in the Directory Server using the provided modify DN request.
static Entry	Entries.modifyEntry(Entry entry, Modification change)	Applies the provided modification to an entry.
static Entry	Entries.modifyEntry(Entry entry, Modification change, Collection<? super ByteString> conflictingValues)	Applies the provided modification to an entry.
static Entry	Entries.modifyEntry(Entry entry, ModifyRequest changes)	Applies the provided modification request to an entry.
static Entry	Entries.modifyEntryPermissive(Entry entry, Collection<Modification> changes)	Applies the provided modifications to an entry using "permissive" modify semantics.
static Entry	Entries.modifyEntryStrict(Entry entry, Collection<Modification> changes)	Applies the provided modifications to an entry using "strict" modify semantics.
SearchResultEntry	AbstractConnection.readEntry(String baseObject, String... attributeDescriptions)
SearchResultEntry	AbstractConnection.readEntry(DN baseObject, String... attributeDescriptions)
SearchResultEntry	AbstractConnectionWrapper.readEntry(String name, String... attributeDescriptions)	Reads the named entry from the Directory Server.
SearchResultEntry	AbstractConnectionWrapper.readEntry(DN name, String... attributeDescriptions)	Reads the named entry from the Directory Server.
SearchResultEntry	Connection.readEntry(String name, String... attributeDescriptions)	Reads the named entry from the Directory Server.
SearchResultEntry	Connection.readEntry(DN name, String... attributeDescriptions)	Reads the named entry from the Directory Server.
static RootDSE	RootDSE.readRootDSE(Connection connection)	Reads the Root DSE from the Directory Server using the provided connection.
Result	AbstractAsynchronousConnection.search(SearchRequest request, SearchResultHandler handler)
Result	AbstractConnection.search(SearchRequest request, Collection<? super SearchResultEntry> entries)
Result	AbstractConnection.search(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references)
Result	AbstractConnectionWrapper.search(SearchRequest request, Collection<? super SearchResultEntry> entries)	Searches the Directory Server using the provided search request.
Result	AbstractConnectionWrapper.search(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references)	Searches the Directory Server using the provided search request.
Result	AbstractConnectionWrapper.search(SearchRequest request, SearchResultHandler handler)	Searches the Directory Server using the provided search request.
Result	Connection.search(SearchRequest request, Collection<? super SearchResultEntry> entries)	Searches the Directory Server using the provided search request.
Result	Connection.search(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references)	Searches the Directory Server using the provided search request.
Result	Connection.search(SearchRequest request, SearchResultHandler handler)	Searches the Directory Server using the provided search request.
SearchResultEntry	AbstractConnection.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)
SearchResultEntry	AbstractConnection.searchSingleEntry(SearchRequest request)
SearchResultEntry	AbstractConnectionWrapper.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server for a single entry using the provided search parameters.
SearchResultEntry	AbstractConnectionWrapper.searchSingleEntry(SearchRequest request)	Searches the Directory Server for a single entry using the provided search request.
SearchResultEntry	Connection.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server for a single entry using the provided search parameters.
SearchResultEntry	Connection.searchSingleEntry(SearchRequest request)	Searches the Directory Server for a single entry using the provided search request.
byte[]	ConnectionSecurityLayer.unwrap(byte[] incoming, int offset, int len)	Unwraps a byte array received from the peer.
byte[]	ConnectionSecurityLayer.wrap(byte[] outgoing, int offset, int len)	Wraps a byte array to be sent to the peer.

Constructor parameters in org.forgerock.opendj.ldap with type arguments of type LdapException

Modifier	Constructor	Description
	LDAPListener(int port, org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
	LDAPListener(int port, org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory, org.forgerock.util.Options options)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
	LDAPListener(String host, int port, org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
	LDAPListener(String host, int port, org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory, org.forgerock.util.Options options)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
	LDAPListener(Set<InetSocketAddress> addresses, org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.
	LDAPListener(Set<InetSocketAddress> addresses, org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory, org.forgerock.util.Options options)	Creates a new LDAP listener implementation which will listen for LDAP client connections at the provided address.

Uses of LdapException in org.forgerock.opendj.ldap.requests

Methods in org.forgerock.opendj.ldap.requests that throw LdapException

Modifier and Type	Method	Description
BindClient	AnonymousSASLBindRequest.createBindClient(String serverName)
BindClient	BindRequest.createBindClient(String serverName)	Creates a new bind client which can be used to perform the authentication process.
BindClient	CRAMMD5SASLBindRequest.createBindClient(String serverName)
BindClient	DigestMD5SASLBindRequest.createBindClient(String serverName)
BindClient	ExternalSASLBindRequest.createBindClient(String serverName)
BindClient	GenericBindRequest.createBindClient(String serverName)
BindClient	GSSAPISASLBindRequest.createBindClient(String serverName)
BindClient	PlainSASLBindRequest.createBindClient(String serverName)
BindClient	SASLBindRequest.createBindClient(String serverName)
BindClient	SimpleBindRequest.createBindClient(String serverName)
boolean	BindClient.evaluateResult(BindResult result)	Evaluates the provided bind result and returns true if authentication has completed successfully, or false if additional authentication steps are required (for example during a multi-stage SASL authentication attempt).

Uses of LdapException in org.forgerock.opendj.ldap.schema

Methods in org.forgerock.opendj.ldap.schema that throw LdapException

Modifier and Type	Method	Description
SchemaBuilder	SchemaBuilder.addSchema(Connection connection, DN name, boolean overwrite)	Reads the schema elements contained in the named subschema sub-entry and adds them to this schema builder.
SchemaBuilder	SchemaBuilder.addSchemaForEntry(Connection connection, DN name, boolean overwrite)	Reads the schema elements contained in the subschema sub-entry which applies to the named entry and adds them to this schema builder.
Entry	SchemaValidationPolicy.EntryResolver.getEntry(DN dn)	Returns the named entry in order to enforce DIT structure rules.
static Schema	Schema.readSchema(Connection connection, DN name)	Reads the schema contained in the named subschema sub-entry.
static Schema	Schema.readSchemaForEntry(Connection connection, DN name)	Reads the schema contained in the subschema sub-entry which applies to the named entry.

Uses of LdapException in org.forgerock.opendj.ldap.spi

Methods in org.forgerock.opendj.ldap.spi with type parameters of type LdapException

Modifier and Type	Method	Description
static <R, E extends LdapException> LdapPromise<R>	LdapPromises.newFailedLdapPromise(E error)	Returns a LdapPromise representing an asynchronous task which has already failed with the provided error.
static <R, E extends LdapException> LdapPromise<R>	LdapPromises.newFailedLdapPromise(E error, int requestID)	Returns a LdapPromise representing an asynchronous task, identified by the provided requestID, which has already failed with the provided error.

Methods in org.forgerock.opendj.ldap.spi that return LdapException

Modifier and Type	Method	Description
LdapException	ConnectionState.getConnectionError()	Returns the error that caused the connection to fail, or null if the connection has not failed.

Methods in org.forgerock.opendj.ldap.spi that return types with arguments of type LdapException

Modifier and Type	Method	Description
org.forgerock.util.promise.Promise<Void,LdapException>	LDAPConnectionImpl.enableTLS(SSLContext sslContext, List<String> protocols, List<String> suites)	Installs the TLS/SSL security layer on the underlying connection.
org.forgerock.util.promise.Promise<LDAPConnectionImpl,LdapException>	LDAPConnectionFactoryImpl.getConnectionAsync()	Asynchronously obtains a connection to the Directory Server associated with this connection factory.

Methods in org.forgerock.opendj.ldap.spi with parameters of type LdapException

Modifier and Type	Method	Description
void	LdapPromiseImpl.handleException(LdapException exception)
boolean	ConnectionState.notifyConnectionError(boolean isDisconnectNotification, LdapException error)	Attempts to transition this connection state to error and invokes event listeners if successful.

Method parameters in org.forgerock.opendj.ldap.spi with type arguments of type LdapException

Modifier and Type	Method	Description
static <R> LdapPromise<R>	LdapPromises.asPromise(org.forgerock.util.promise.Promise<R,LdapException> wrappedPromise)	Converts a Promise to a LdapPromise.
LDAPListenerImpl	TransportProvider.getLDAPListener(Set<InetSocketAddress> addresses, org.forgerock.util.Function<LDAPClientContext,com.forgerock.reactive.ReactiveHandler<LDAPClientContext,LdapMessages.LdapRequestEnvelope,com.forgerock.reactive.Stream<Response>>,LdapException> factory, org.forgerock.util.Options options)	Returns an implementation of LDAPListener.

Constructor parameters in org.forgerock.opendj.ldap.spi with type arguments of type LdapException

Modifier	Constructor	Description
protected	LdapPromiseImpl(org.forgerock.util.promise.PromiseImpl<S,LdapException> wrappedPromise, int requestID)	Creates a new LdapPromiseImpl from a wrapped existing PromiseImpl.

Uses of LdapException in org.forgerock.opendj.ldif

Methods in org.forgerock.opendj.ldif that throw LdapException

Modifier and Type	Method	Description
boolean	ConnectionEntryReader.hasNext()
boolean	ConnectionEntryReader.isEntry()	Waits for the next search result entry or reference to become available and returns true if it is an entry, or false if it is a reference.
boolean	ConnectionEntryReader.isReference()	Waits for the next search result entry or reference to become available and returns true if it is a reference, or false if it is an entry.
SearchResultEntry	ConnectionEntryReader.readEntry()	Waits for the next search result entry or reference to become available and, if it is an entry, returns it as a SearchResultEntry.
SearchResultReference	ConnectionEntryReader.readReference()	Waits for the next search result entry or reference to become available and, if it is a reference, returns it as a SearchResultReference.
Result	ConnectionEntryReader.readResult()	Waits for the next search response to become available and returns it if it is a search result indicating that the search completed successfully.
ConnectionChangeRecordWriter	ConnectionChangeRecordWriter.writeChangeRecord(AddRequest change)	Writes the provided Add request to the underlying connection, blocking until the request completes.
ConnectionChangeRecordWriter	ConnectionChangeRecordWriter.writeChangeRecord(DeleteRequest change)	Writes the provided Delete request to the underlying connection, blocking until the request completes.
ConnectionChangeRecordWriter	ConnectionChangeRecordWriter.writeChangeRecord(ModifyDNRequest change)	Writes the provided ModifyDN request to the underlying connection, blocking until the request completes.
ConnectionChangeRecordWriter	ConnectionChangeRecordWriter.writeChangeRecord(ModifyRequest change)	Writes the provided Modify request to the underlying connection, blocking until the request completes.
ConnectionChangeRecordWriter	ConnectionChangeRecordWriter.writeChangeRecord(ChangeRecord change)	Writes the provided change record to the underlying connection, blocking until the request completes.
ConnectionEntryWriter	ConnectionEntryWriter.writeEntry(Entry entry)	Writes an entry to the underlying connection using an Add request, blocking until the request completes.