@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface BackendServer
Modifier and Type | Method and Description |
---|---|
LDAPResult |
addUnaltered(AddRequest addRequest)
Sends the provided add request to the backend server without altering the
request or result in any way.
|
CompareResult |
compareUnaltered(CompareRequest compareRequest)
Sends the provided compare request to the backend server without altering
the request or result in any way.
|
LDAPConnection |
createNewConnection(LDAPConnectionOptions options,
java.lang.String purpose)
Creates a new connection to the associated directory server which is
authenticated and/or secured in accordance with the LDAP external server
configuration.
|
LDAPResult |
deleteUnaltered(DeleteRequest deleteRequest)
Sends the provided delete request to the backend server without altering
the request or result in any way.
|
int |
getActiveOperations()
Retrieves the number of operations which are currently being processed
against the LDAP external server through the local Directory Proxy Server
instance.
|
java.lang.String |
getConfigEntryDN()
Retrieves the DN of the configuration entry in which this LDAP external
server is defined.
|
HealthCheckResult |
getHealthCheckResult()
Retrieves the health check result currently assigned to this LDAP external
server.
|
Location |
getLocation()
Retrieves the location assigned to this LDAP external server, if any.
|
DN |
getParsedConfigEntryDN()
Retrieves the DN of the configuration entry in which this LDAP external
server is defined.
|
java.lang.String |
getServerAddress()
Retrieves the address for this LDAP external server.
|
int |
getServerPort()
Retrieves the port for this LDAP external server.
|
boolean |
isAvailable()
Indicates whether this LDAP external server currently has a health check
state of AVAILABLE.
|
boolean |
isLocal()
Indicates whether this LDAP external server is in the same location as the
Directory Proxy Server that is referencing it.
|
LDAPResult |
modifyDNUnaltered(ModifyDNRequest modifyDNRequest)
Sends the provided modify DN request to the backend server without altering
the request or result in any way.
|
LDAPResult |
modifyUnaltered(ModifyRequest modifyRequest)
Sends the provided modify request to the backend server without altering
the request or result in any way.
|
SearchResult |
searchUnaltered(SearchRequest searchRequest)
Sends the provided search request to the backend server without altering
the request or result in any way.
|
boolean |
supportsOperation(OperationType t)
Indicates whether this LDAP external server may be used to process
operations of the specified type.
|
java.lang.String getConfigEntryDN()
DN getParsedConfigEntryDN()
LDAPConnection createNewConnection(LDAPConnectionOptions options, java.lang.String purpose) throws LDAPException
options
- The set of options to use for the connection. It may be
null
if a default set of connection options should
be used.purpose
- A message with information about the purpose for this
connection. This message will be included in the
administrative operation control sent to the server (if
the server supports that control) for any operations
processed during the course of preparing the connection.LDAPException
- If a problem is encountered while attempting to
create the connection.Location getLocation()
null
if no location has been assigned.java.lang.String getServerAddress()
int getServerPort()
boolean isLocal()
true
if this LDAP external server is in the same location
as the Directory Proxy Server that is referencing it, or
false
if it is in a different location or no location has
been assigned.int getActiveOperations()
createNewConnection(com.unboundid.ldap.sdk.LDAPConnectionOptions, java.lang.String)
method.HealthCheckResult getHealthCheckResult()
boolean isAvailable()
true
if this LDAP external server currently has a health
check state of AVAILABLE, or false
if not.boolean supportsOperation(OperationType t)
t
- The operation type for which to make the determination.true
if this LDAP external server may be used to process
operations of the specified type, or false
if not.LDAPResult addUnaltered(AddRequest addRequest) throws LDAPException
addRequest
- The add request to be processed.LDAPException
- If an error occurred while processing the add
request.CompareResult compareUnaltered(CompareRequest compareRequest) throws LDAPException
compareRequest
- The compare request to be processed.LDAPException
- If an error occurred while processing the compare
request.LDAPResult deleteUnaltered(DeleteRequest deleteRequest) throws LDAPException
deleteRequest
- The delete request to be processed.LDAPException
- If an error occurred while processing the delete
request.LDAPResult modifyUnaltered(ModifyRequest modifyRequest) throws LDAPException
modifyRequest
- The modify request to be processed.LDAPException
- If an error occurred while processing the modify
request.LDAPResult modifyDNUnaltered(ModifyDNRequest modifyDNRequest) throws LDAPException
modifyDNRequest
- The modify DN request to be processed.LDAPException
- If an error occurred while processing the modify DN
request.SearchResult searchUnaltered(SearchRequest searchRequest) throws LDAPException
searchRequest
- The search request to be processed.LDAPException
- If an error occurred while processing the search
request.