|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.ClientConnection
org.opends.server.protocols.internal.InternalClientConnection
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class InternalClientConnection
This class defines a pseudo-connection object that can be used for performing internal operations.
Field Summary | |
---|---|
static java.lang.String |
PROTOCOL_VERSION
The protocol verison string that will be used for internal bind operations. |
Constructor Summary | |
---|---|
InternalClientConnection(AuthenticationInfo authInfo)
Creates a new internal client connection that will be authenticated as the specified user. |
|
InternalClientConnection(DN userDN)
Creates a new internal client connection that will be authenticated as the specified user. |
Method Summary | |
---|---|
boolean |
bindInProgress()
Indicates whether a bind operation is in progress on this client connection. |
void |
cancelAllOperations(CancelRequest cancelRequest)
Attempts to cancel all operations in progress on this connection. |
void |
cancelAllOperationsExcept(CancelRequest cancelRequest,
int messageID)
Attempts to cancel all operations in progress on this connection except the operation with the specified message ID. |
CancelResult |
cancelOperation(int messageID,
CancelRequest cancelRequest)
Attempts to cancel the specified operation. |
void |
disconnect(DisconnectReason disconnectReason,
boolean sendNotification,
Message message)
Closes the connection to the client, optionally sending it a message indicating the reason for the closure. |
AuthenticationInfo |
getAuthenticationInfo()
Retrieves information about the authentication that has been performed for this connection. |
java.lang.String |
getClientAddress()
Retrieves a string representation of the address of the client. |
ConnectionHandler |
getConnectionHandler()
Retrieves the connection handler that accepted this client connection. |
long |
getConnectionID()
Retrieves the unique identifier that has been assigned to this connection. |
ConnectionSecurityProvider |
getConnectionSecurityProvider()
Retrieves the connection security provider for this client connection. |
java.net.InetAddress |
getLocalAddress()
Retrieves the java.net.InetAddress for the Directory
Server system to which the client has established the connection. |
java.lang.String |
getMonitorSummary()
Retrieves a one-line summary of this client connection in a form that is suitable for including in the monitor entry for the associated connection handler. |
AbstractOperation |
getOperationInProgress(int messageID)
Retrieves the operation in progress with the specified message ID. |
java.util.Collection<AbstractOperation> |
getOperationsInProgress()
Retrieves the set of operations in progress for this client connection. |
java.lang.String |
getProtocol()
Retrieves the protocol that the client is using to communicate with the Directory Server. |
java.net.InetAddress |
getRemoteAddress()
Retrieves the java.net.InetAddress associated with
the remote client system. |
static InternalClientConnection |
getRootConnection()
Retrieves a shared internal client connection that is authenticated as a root user. |
java.lang.String |
getSecurityMechanism()
Retrieves the human-readable name of the security mechanism that is used to protect communication with this client. |
java.lang.String |
getServerAddress()
Retrieves a string representation of the address on the server to which the client connected. |
boolean |
isSecure()
Indicates whether this client connection is currently using a secure mechanism to communicate with the server. |
static int |
nextMessageID()
Retrieves the message ID that should be used for the next internal operation. |
static long |
nextOperationID()
Retrieves the operation ID that should be used for the next internal operation. |
AddOperation |
processAdd(AddChangeRecordEntry addRecord)
Processes an internal add operation based on the provided add change record entry. |
AddOperation |
processAdd(ByteString rawEntryDN,
java.util.List<RawAttribute> rawAttributes)
Processes an internal add operation with the provided information. |
AddOperation |
processAdd(ByteString rawEntryDN,
java.util.List<RawAttribute> rawAttributes,
java.util.List<Control> controls)
Processes an internal add operation with the provided information. |
AddOperation |
processAdd(DN entryDN,
java.util.Map<ObjectClass,java.lang.String> objectClasses,
java.util.Map<AttributeType,java.util.List<Attribute>> userAttributes,
java.util.Map<AttributeType,java.util.List<Attribute>> operationalAttributes)
Processes an internal add operation with the provided information. |
AddOperation |
processAdd(DN entryDN,
java.util.Map<ObjectClass,java.lang.String> objectClasses,
java.util.Map<AttributeType,java.util.List<Attribute>> userAttributes,
java.util.Map<AttributeType,java.util.List<Attribute>> operationalAttributes,
java.util.List<Control> controls)
Processes an internal add operation with the provided information. |
AddOperation |
processAdd(Entry entry)
Processes an internal add operation with the provided information. |
AddOperation |
processAdd(Entry entry,
java.util.List<Control> controls)
Processes an internal add operation with the provided information. |
AddOperation |
processAdd(java.lang.String rawEntryDN,
java.util.List<RawAttribute> rawAttributes)
Processes an internal add operation with the provided information. |
CompareOperation |
processCompare(ByteString rawEntryDN,
java.lang.String attributeType,
ByteString assertionValue)
Processes an internal compare operation with the provided information. |
CompareOperation |
processCompare(ByteString rawEntryDN,
java.lang.String attributeType,
ByteString assertionValue,
java.util.List<Control> controls)
Processes an internal compare operation with the provided information. |
CompareOperation |
processCompare(DN entryDN,
AttributeType attributeType,
ByteString assertionValue)
Processes an internal compare operation with the provided information. |
CompareOperation |
processCompare(DN entryDN,
AttributeType attributeType,
ByteString assertionValue,
java.util.List<Control> controls)
Processes an internal compare operation with the provided information. |
CompareOperation |
processCompare(java.lang.String rawEntryDN,
java.lang.String attributeType,
java.lang.String assertionValue)
Processes an internal compare operation with the provided information. |
CompareOperation |
processCompare(java.lang.String rawEntryDN,
java.lang.String attributeType,
java.lang.String assertionValue,
java.util.List<Control> controls)
Processes an internal compare operation with the provided information. |
boolean |
processDataRead(java.nio.ByteBuffer buffer)
Indicates that the data in the provided buffer has been read from the client and should be processed. |
DeleteOperation |
processDelete(ByteString rawEntryDN)
Processes an internal delete operation with the provided information. |
DeleteOperation |
processDelete(ByteString rawEntryDN,
java.util.List<Control> controls)
Processes an internal delete operation with the provided information. |
DeleteOperation |
processDelete(DeleteChangeRecordEntry deleteRecord)
Processes an internal delete operation with the provided information. |
DeleteOperation |
processDelete(DN entryDN)
Processes an internal delete operation with the provided information. |
DeleteOperation |
processDelete(DN entryDN,
java.util.List<Control> controls)
Processes an internal delete operation with the provided information. |
DeleteOperation |
processDelete(java.lang.String rawEntryDN)
Processes an internal delete operation with the provided information. |
DeleteOperation |
processDelete(java.lang.String rawEntryDN,
java.util.List<Control> controls)
Processes an internal delete operation with the provided information. |
ExtendedOperation |
processExtendedOperation(java.lang.String requestOID,
ASN1OctetString requestValue)
Processes an internal extended operation with the provided information. |
ExtendedOperation |
processExtendedOperation(java.lang.String requestOID,
ASN1OctetString requestValue,
java.util.List<Control> controls)
Processes an internal extended operation with the provided information. |
ModifyOperation |
processModify(ByteString rawEntryDN,
java.util.List<RawModification> rawModifications)
Processes an internal modify operation with the provided information. |
ModifyOperation |
processModify(ByteString rawEntryDN,
java.util.List<RawModification> rawModifications,
java.util.List<Control> controls)
Processes an internal modify operation with the provided information. |
ModifyOperation |
processModify(DN entryDN,
java.util.List<Modification> modifications)
Processes an internal modify operation with the provided information. |
ModifyOperation |
processModify(DN entryDN,
java.util.List<Modification> modifications,
java.util.List<Control> controls)
Processes an internal modify operation with the provided information. |
ModifyOperation |
processModify(ModifyChangeRecordEntry modifyRecord)
Processes an internal modify operation with the provided information. |
ModifyOperation |
processModify(java.lang.String rawEntryDN,
java.util.List<RawModification> rawModifications)
Processes an internal modify operation with the provided information. |
ModifyOperation |
processModify(java.lang.String rawEntryDN,
java.util.List<RawModification> rawModifications,
java.util.List<Control> controls)
Processes an internal modify operation with the provided information. |
ModifyDNOperation |
processModifyDN(ByteString rawEntryDN,
ByteString rawNewRDN,
boolean deleteOldRDN)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(ByteString rawEntryDN,
ByteString rawNewRDN,
boolean deleteOldRDN,
ByteString rawNewSuperior)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(ByteString rawEntryDN,
ByteString rawNewRDN,
boolean deleteOldRDN,
ByteString rawNewSuperior,
java.util.List<Control> controls)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(DN entryDN,
RDN newRDN,
boolean deleteOldRDN)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(DN entryDN,
RDN newRDN,
boolean deleteOldRDN,
DN newSuperior)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(DN entryDN,
RDN newRDN,
boolean deleteOldRDN,
DN newSuperior,
java.util.List<Control> controls)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(ModifyDNChangeRecordEntry modifyDNRecord)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(java.lang.String rawEntryDN,
java.lang.String rawNewRDN,
boolean deleteOldRDN)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(java.lang.String rawEntryDN,
java.lang.String rawNewRDN,
boolean deleteOldRDN,
java.util.List<Control> controls)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(java.lang.String rawEntryDN,
java.lang.String rawNewRDN,
boolean deleteOldRDN,
java.lang.String rawNewSuperior)
Processes an internal modify DN operation with the provided information. |
ModifyDNOperation |
processModifyDN(java.lang.String rawEntryDN,
java.lang.String rawNewRDN,
boolean deleteOldRDN,
java.lang.String rawNewSuperior,
java.util.List<Control> controls)
Processes an internal modify DN operation with the provided information. |
BindOperation |
processSASLBind(ByteString rawBindDN,
java.lang.String saslMechanism,
ASN1OctetString saslCredentials)
Processes an internal bind operation with the provided information. |
BindOperation |
processSASLBind(ByteString rawBindDN,
java.lang.String saslMechanism,
ASN1OctetString saslCredentials,
java.util.List<Control> controls)
Processes an internal bind operation with the provided information. |
BindOperation |
processSASLBind(DN bindDN,
java.lang.String saslMechanism,
ASN1OctetString saslCredentials)
Processes an internal bind operation with the provided information. |
BindOperation |
processSASLBind(DN bindDN,
java.lang.String saslMechanism,
ASN1OctetString saslCredentials,
java.util.List<Control> controls)
Processes an internal bind operation with the provided information. |
InternalSearchOperation |
processSearch(ByteString rawBaseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
RawFilter filter,
java.util.LinkedHashSet<java.lang.String> attributes)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(ByteString rawBaseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
RawFilter filter,
java.util.LinkedHashSet<java.lang.String> attributes,
InternalSearchListener searchListener)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(ByteString rawBaseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
RawFilter filter,
java.util.LinkedHashSet<java.lang.String> attributes,
java.util.List<Control> controls,
InternalSearchListener searchListener)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(ByteString rawBaseDN,
SearchScope scope,
RawFilter filter)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(DN baseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
SearchFilter filter,
java.util.LinkedHashSet<java.lang.String> attributes)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(DN baseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
SearchFilter filter,
java.util.LinkedHashSet<java.lang.String> attributes,
InternalSearchListener searchListener)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(DN baseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
SearchFilter filter,
java.util.LinkedHashSet<java.lang.String> attributes,
java.util.List<Control> controls,
InternalSearchListener searchListener)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(DN baseDN,
SearchScope scope,
SearchFilter filter)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(java.lang.String rawBaseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
java.lang.String filterString,
java.util.LinkedHashSet<java.lang.String> attributes)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(java.lang.String rawBaseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
java.lang.String filterString,
java.util.LinkedHashSet<java.lang.String> attributes,
InternalSearchListener searchListener)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(java.lang.String rawBaseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
java.lang.String filterString,
java.util.LinkedHashSet<java.lang.String> attributes,
java.util.List<Control> controls,
InternalSearchListener searchListener)
Processes an internal search operation with the provided information. |
InternalSearchOperation |
processSearch(java.lang.String rawBaseDN,
SearchScope scope,
java.lang.String filterString)
Processes an internal search operation with the provided information. |
BindOperation |
processSimpleBind(ByteString rawBindDN,
ByteString password)
Processes an internal bind operation with the provided information. |
BindOperation |
processSimpleBind(ByteString rawBindDN,
ByteString password,
java.util.List<Control> controls)
Processes an internal bind operation with the provided information. |
BindOperation |
processSimpleBind(DN bindDN,
ByteString password)
Processes an internal bind operation with the provided information. |
BindOperation |
processSimpleBind(DN bindDN,
ByteString password,
java.util.List<Control> controls)
Processes an internal bind operation with the provided information. |
BindOperation |
processSimpleBind(java.lang.String rawBindDN,
java.lang.String password)
Processes an internal bind operation with the provided information. |
BindOperation |
processSimpleBind(java.lang.String rawBindDN,
java.lang.String password,
java.util.List<Control> controls)
Processes an internal bind operation with the provided information. |
boolean |
removeOperationInProgress(int messageID)
Removes the provided operation from the set of operations in progress for this client connection. |
protected boolean |
sendIntermediateResponseMessage(IntermediateResponse intermediateResponse)
Sends the provided intermediate response message to the client. |
void |
sendResponse(Operation operation)
Sends a response to the client based on the information in the provided operation. |
void |
sendSearchEntry(SearchOperation searchOperation,
SearchResultEntry searchEntry)
Sends the provided search result entry to the client. |
boolean |
sendSearchReference(SearchOperation searchOperation,
SearchResultReference searchReference)
Sends the provided search result reference to the client. |
void |
setAuthenticationInfo(AuthenticationInfo authenticationInfo)
This method has no effect, as the authentication info for internal client connections is set when the connection is created and cannot be changed after the fact. |
void |
setBindInProgress(boolean bindInProgress)
Specifies whether a bind operation is in progress on this client connection. |
void |
setConnectionSecurityProvider(ConnectionSecurityProvider securityProvider)
Specifies the connection security provider for this client connection. |
void |
setIdleTimeLimit(long idleTimeLimit)
Specifies the maximum length of time in milliseconds that this client connection will be allowed to remain idle before it should be disconnected. |
void |
setLookthroughLimit(int lookthroughLimit)
Specifies the default maximum number of entries that should be checked for matches during a search. |
void |
setSizeLimit(int sizeLimit)
Specifies the size limit that will be enforced for searches performed using this client connection. |
void |
setTimeLimit(int timeLimit)
Specifies the time limit that will be enforced for searches performed using this client connection. |
void |
setUnauthenticated()
This method has no effect, as the authentication info for internal client connections is set when the connection is created and cannot be changed after the fact. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this client connection to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PROTOCOL_VERSION
Constructor Detail |
---|
public InternalClientConnection(AuthenticationInfo authInfo)
authInfo
- The authentication information to use for the
connection.public InternalClientConnection(DN userDN) throws DirectoryException
userDN
- The DN of the entry to use as the
authentication and authorization identity.
DirectoryException
- If a problem occurs while trying to
get the entry for the provided user
DN.Method Detail |
---|
public static InternalClientConnection getRootConnection()
public static long nextOperationID()
public static int nextMessageID()
public long getConnectionID()
getConnectionID
in class ClientConnection
@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public ConnectionHandler getConnectionHandler()
getConnectionHandler
in class ClientConnection
public java.lang.String getProtocol()
getProtocol
in class ClientConnection
public java.lang.String getClientAddress()
getClientAddress
in class ClientConnection
public java.lang.String getServerAddress()
getServerAddress
in class ClientConnection
public java.net.InetAddress getRemoteAddress()
java.net.InetAddress
associated with
the remote client system.
getRemoteAddress
in class ClientConnection
java.net.InetAddress
associated with
the remote client system. It may be null
if the client is not connected over an IP-based
connection.public java.net.InetAddress getLocalAddress()
java.net.InetAddress
for the Directory
Server system to which the client has established the connection.
getLocalAddress
in class ClientConnection
java.net.InetAddress
for the Directory
Server system to which the client has established the
connection. It may be null
if the client
is not connected over an IP-based connection.public void setSizeLimit(int sizeLimit)
setSizeLimit
in class ClientConnection
sizeLimit
- The size limit that will be enforced for
searches performed using this client
connection.public void setLookthroughLimit(int lookthroughLimit)
setLookthroughLimit
in class ClientConnection
lookthroughLimit
- The default maximum number of
entries that should be check for
matches during a search.public void setIdleTimeLimit(long idleTimeLimit)
setIdleTimeLimit
in class ClientConnection
idleTimeLimit
- The maximum length of time in milliseconds
that this client connection will be
allowed to remain idle before it should be
disconnected.public void setTimeLimit(int timeLimit)
setTimeLimit
in class ClientConnection
timeLimit
- The time limit that will be enforced for
searches performed using this client
connection.public boolean isSecure()
false
to
true
if the client uses the StartTLS extended
operation).
isSecure
in class ClientConnection
true
if the client connection is currently
using a secure mechanism to communicate with the server,
or false
if not.public ConnectionSecurityProvider getConnectionSecurityProvider()
getConnectionSecurityProvider
in class ClientConnection
@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void setConnectionSecurityProvider(ConnectionSecurityProvider securityProvider)
setConnectionSecurityProvider
in class ClientConnection
securityProvider
- The connection security provider to use
for communication on this client
connection.public java.lang.String getSecurityMechanism()
getSecurityMechanism
in class ClientConnection
null
if no security is in place.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public boolean processDataRead(java.nio.ByteBuffer buffer)
processDataRead
in class ClientConnection
buffer
- The byte buffer containing the data available for
reading.
true
if all the data in the provided buffer
was processed and the client connection can remain
established, or false
if a decoding error
occurred and requests from this client should no longer
be processed. Note that if this method does return
false
, then it must have already
disconnected the client.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void sendResponse(Operation operation)
sendResponse
in class ClientConnection
operation
- The operation for which to send the response.public AuthenticationInfo getAuthenticationInfo()
getAuthenticationInfo
in class ClientConnection
@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void setAuthenticationInfo(AuthenticationInfo authenticationInfo)
setAuthenticationInfo
in class ClientConnection
authenticationInfo
- Information about the authentication
that has been performed for this
connection. It should not be
null
.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void setUnauthenticated()
setUnauthenticated
in class ClientConnection
public AddOperation processAdd(java.lang.String rawEntryDN, java.util.List<RawAttribute> rawAttributes)
rawEntryDN
- The DN to use for the entry to add.rawAttributes
- The set of attributes to include in the
entry to add.
public AddOperation processAdd(ByteString rawEntryDN, java.util.List<RawAttribute> rawAttributes)
rawEntryDN
- The DN to use for the entry to add.rawAttributes
- The set of attributes to include in the
entry to add.
public AddOperation processAdd(ByteString rawEntryDN, java.util.List<RawAttribute> rawAttributes, java.util.List<Control> controls)
rawEntryDN
- The DN to use for the entry to add.rawAttributes
- The set of attributes to include in the
entry to add.controls
- The set of controls to include in the
request.
public AddOperation processAdd(DN entryDN, java.util.Map<ObjectClass,java.lang.String> objectClasses, java.util.Map<AttributeType,java.util.List<Attribute>> userAttributes, java.util.Map<AttributeType,java.util.List<Attribute>> operationalAttributes)
entryDN
- The entry DN for the add
operation.objectClasses
- The set of objectclasses for the
add operation.userAttributes
- The set of user attributes for the
add operation.operationalAttributes
- The set of operational attributes
for the add operation.
public AddOperation processAdd(DN entryDN, java.util.Map<ObjectClass,java.lang.String> objectClasses, java.util.Map<AttributeType,java.util.List<Attribute>> userAttributes, java.util.Map<AttributeType,java.util.List<Attribute>> operationalAttributes, java.util.List<Control> controls)
entryDN
- The entry DN for the add
operation.objectClasses
- The set of objectclasses for the
add operation.userAttributes
- The set of user attributes for the
add operation.operationalAttributes
- The set of operational attributes
for the add operation.controls
- The set of controls to include in
the request.
public AddOperation processAdd(Entry entry)
entry
- The entry to be added.
public AddOperation processAdd(Entry entry, java.util.List<Control> controls)
entry
- The entry to be added.controls
- The set of controls to include in the request.
public AddOperation processAdd(AddChangeRecordEntry addRecord)
addRecord
- The add change record entry to be processed.
public BindOperation processSimpleBind(java.lang.String rawBindDN, java.lang.String password)
rawBindDN
- The bind DN for the operation.password
- The bind password for the operation.
public BindOperation processSimpleBind(java.lang.String rawBindDN, java.lang.String password, java.util.List<Control> controls)
rawBindDN
- The bind DN for the operation.password
- The bind password for the operation.controls
- The set of controls to include in the
request.
public BindOperation processSimpleBind(ByteString rawBindDN, ByteString password)
rawBindDN
- The bind DN for the operation.password
- The bind password for the operation.
public BindOperation processSimpleBind(ByteString rawBindDN, ByteString password, java.util.List<Control> controls)
rawBindDN
- The bind DN for the operation.password
- The bind password for the operation.controls
- The set of controls to include in the request.
public BindOperation processSimpleBind(DN bindDN, ByteString password)
bindDN
- The bind DN for the operation.password
- The bind password for the operation.
public BindOperation processSimpleBind(DN bindDN, ByteString password, java.util.List<Control> controls)
bindDN
- The bind DN for the operation.password
- The bind password for the operation.controls
- The set of controls to include in the request.
public BindOperation processSASLBind(ByteString rawBindDN, java.lang.String saslMechanism, ASN1OctetString saslCredentials)
rawBindDN
- The bind DN for the operation.saslMechanism
- The SASL mechanism for the operation.saslCredentials
- The SASL credentials for the operation.
public BindOperation processSASLBind(ByteString rawBindDN, java.lang.String saslMechanism, ASN1OctetString saslCredentials, java.util.List<Control> controls)
rawBindDN
- The bind DN for the operation.saslMechanism
- The SASL mechanism for the operation.saslCredentials
- The SASL credentials for the operation.controls
- The set of controls to include in the
request.
public BindOperation processSASLBind(DN bindDN, java.lang.String saslMechanism, ASN1OctetString saslCredentials)
bindDN
- The bind DN for the operation.saslMechanism
- The SASL mechanism for the operation.saslCredentials
- The SASL credentials for the operation.
public BindOperation processSASLBind(DN bindDN, java.lang.String saslMechanism, ASN1OctetString saslCredentials, java.util.List<Control> controls)
bindDN
- The bind DN for the operation.saslMechanism
- The SASL mechanism for the operation.saslCredentials
- The SASL credentials for the operation.controls
- The set of controls to include in the
request.
public CompareOperation processCompare(java.lang.String rawEntryDN, java.lang.String attributeType, java.lang.String assertionValue)
rawEntryDN
- The entry DN for the compare operation.attributeType
- The attribute type for the compare
operation.assertionValue
- The assertion value for the compare
operation.
public CompareOperation processCompare(java.lang.String rawEntryDN, java.lang.String attributeType, java.lang.String assertionValue, java.util.List<Control> controls)
rawEntryDN
- The entry DN for the compare operation.attributeType
- The attribute type for the compare
operation.assertionValue
- The assertion value for the compare
operation.controls
- The set of controls to include in the
request.
public CompareOperation processCompare(ByteString rawEntryDN, java.lang.String attributeType, ByteString assertionValue)
rawEntryDN
- The entry DN for the compare operation.attributeType
- The attribute type for the compare
operation.assertionValue
- The assertion value for the compare
operation.
public CompareOperation processCompare(ByteString rawEntryDN, java.lang.String attributeType, ByteString assertionValue, java.util.List<Control> controls)
rawEntryDN
- The entry DN for the compare operation.attributeType
- The attribute type for the compare
operation.assertionValue
- The assertion value for the compare
operation.controls
- The set of controls to include in the
request.
public CompareOperation processCompare(DN entryDN, AttributeType attributeType, ByteString assertionValue)
entryDN
- The entry DN for the compare operation.attributeType
- The attribute type for the compare
operation.assertionValue
- The assertion value for the compare
operation.
public CompareOperation processCompare(DN entryDN, AttributeType attributeType, ByteString assertionValue, java.util.List<Control> controls)
entryDN
- The entry DN for the compare operation.attributeType
- The attribute type for the compare
operation.assertionValue
- The assertion value for the compare
operation.controls
- The set of controls to include in the
request.
public DeleteOperation processDelete(java.lang.String rawEntryDN)
rawEntryDN
- The entry DN for the delete operation.
public DeleteOperation processDelete(java.lang.String rawEntryDN, java.util.List<Control> controls)
rawEntryDN
- The entry DN for the delete operation.controls
- The set of controls to include in the
request.
public DeleteOperation processDelete(ByteString rawEntryDN)
rawEntryDN
- The entry DN for the delete operation.
public DeleteOperation processDelete(ByteString rawEntryDN, java.util.List<Control> controls)
rawEntryDN
- The entry DN for the delete operation.controls
- The set of controls to include in the
request.
public DeleteOperation processDelete(DN entryDN)
entryDN
- The entry DN for the delete operation.
public DeleteOperation processDelete(DN entryDN, java.util.List<Control> controls)
entryDN
- The entry DN for the delete operation.controls
- The set of controls to include in the request.
public DeleteOperation processDelete(DeleteChangeRecordEntry deleteRecord)
deleteRecord
- The delete change record entry to be
processed.
public ExtendedOperation processExtendedOperation(java.lang.String requestOID, ASN1OctetString requestValue)
requestOID
- The OID for the extended request.requestValue
- The encoded value for the extended
operation, or null
if there is
no value.
public ExtendedOperation processExtendedOperation(java.lang.String requestOID, ASN1OctetString requestValue, java.util.List<Control> controls)
requestOID
- The OID for the extended request.requestValue
- The encoded value for the extended
operation, or null
if there is
no value.controls
- The set of controls to include in the
request.
public ModifyOperation processModify(java.lang.String rawEntryDN, java.util.List<RawModification> rawModifications)
rawEntryDN
- The raw entry DN for this modify
operation.rawModifications
- The set of modifications for this
modify operation.
public ModifyOperation processModify(java.lang.String rawEntryDN, java.util.List<RawModification> rawModifications, java.util.List<Control> controls)
rawEntryDN
- The raw entry DN for this modify
operation.rawModifications
- The set of modifications for this
modify operation.controls
- The set of controls to include in the
request.
public ModifyOperation processModify(ByteString rawEntryDN, java.util.List<RawModification> rawModifications)
rawEntryDN
- The raw entry DN for this modify
operation.rawModifications
- The set of modifications for this
modify operation.
public ModifyOperation processModify(ByteString rawEntryDN, java.util.List<RawModification> rawModifications, java.util.List<Control> controls)
rawEntryDN
- The raw entry DN for this modify
operation.rawModifications
- The set of modifications for this
modify operation.controls
- The set of controls to include in the
request.
public ModifyOperation processModify(DN entryDN, java.util.List<Modification> modifications)
entryDN
- The entry DN for this modify operation.modifications
- The set of modifications for this modify
operation.
public ModifyOperation processModify(DN entryDN, java.util.List<Modification> modifications, java.util.List<Control> controls)
entryDN
- The entry DN for this modify operation.modifications
- The set of modifications for this modify
operation.controls
- The set of controls to include in the
request.
public ModifyOperation processModify(ModifyChangeRecordEntry modifyRecord)
modifyRecord
- The modify change record entry with
information about the changes to perform.
public ModifyDNOperation processModifyDN(java.lang.String rawEntryDN, java.lang.String rawNewRDN, boolean deleteOldRDN)
rawEntryDN
- The current DN of the entry to rename.rawNewRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.
public ModifyDNOperation processModifyDN(java.lang.String rawEntryDN, java.lang.String rawNewRDN, boolean deleteOldRDN, java.util.List<Control> controls)
rawEntryDN
- The current DN of the entry to rename.rawNewRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.controls
- The set of controls to include in the
request.
public ModifyDNOperation processModifyDN(ByteString rawEntryDN, ByteString rawNewRDN, boolean deleteOldRDN)
rawEntryDN
- The current DN of the entry to rename.rawNewRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.
public ModifyDNOperation processModifyDN(java.lang.String rawEntryDN, java.lang.String rawNewRDN, boolean deleteOldRDN, java.lang.String rawNewSuperior)
rawEntryDN
- The current DN of the entry to rename.rawNewRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.rawNewSuperior
- The new superior for the modify DN
operation, or null
if the
entry will remain below the same parent.
public ModifyDNOperation processModifyDN(java.lang.String rawEntryDN, java.lang.String rawNewRDN, boolean deleteOldRDN, java.lang.String rawNewSuperior, java.util.List<Control> controls)
rawEntryDN
- The current DN of the entry to rename.rawNewRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.rawNewSuperior
- The new superior for the modify DN
operation, or null
if the
entry will remain below the same parent.controls
- The set of controls to include in the
request.
public ModifyDNOperation processModifyDN(ByteString rawEntryDN, ByteString rawNewRDN, boolean deleteOldRDN, ByteString rawNewSuperior)
rawEntryDN
- The current DN of the entry to rename.rawNewRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.rawNewSuperior
- The new superior for the modify DN
operation, or null
if the
entry will remain below the same parent.
public ModifyDNOperation processModifyDN(ByteString rawEntryDN, ByteString rawNewRDN, boolean deleteOldRDN, ByteString rawNewSuperior, java.util.List<Control> controls)
rawEntryDN
- The current DN of the entry to rename.rawNewRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.rawNewSuperior
- The new superior for the modify DN
operation, or null
if the
entry will remain below the same parent.controls
- The set of controls to include in the
request.
public ModifyDNOperation processModifyDN(DN entryDN, RDN newRDN, boolean deleteOldRDN)
entryDN
- The current DN of the entry to rename.newRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.
public ModifyDNOperation processModifyDN(DN entryDN, RDN newRDN, boolean deleteOldRDN, DN newSuperior)
entryDN
- The current DN of the entry to rename.newRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.newSuperior
- The new superior for the modify DN
operation, or null
if the
entry will remain below the same parent.
public ModifyDNOperation processModifyDN(DN entryDN, RDN newRDN, boolean deleteOldRDN, DN newSuperior, java.util.List<Control> controls)
entryDN
- The current DN of the entry to rename.newRDN
- The new RDN to use for the entry.deleteOldRDN
- The flag indicating whether the old RDN
value is to be removed from the entry.newSuperior
- The new superior for the modify DN
operation, or null
if the
entry will remain below the same parent.controls
- The set of controls to include in the
request.
public ModifyDNOperation processModifyDN(ModifyDNChangeRecordEntry modifyDNRecord)
modifyDNRecord
- The modify DN change record entry with
information about the processing to
perform.
public InternalSearchOperation processSearch(java.lang.String rawBaseDN, SearchScope scope, java.lang.String filterString) throws DirectoryException
rawBaseDN
- The base DN for the search.scope
- The scope for the search.filterString
- The string representation of the filter for
the search.
DirectoryException
- If the provided filter string cannot
be decoded as a search filter.public InternalSearchOperation processSearch(java.lang.String rawBaseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, java.lang.String filterString, java.util.LinkedHashSet<java.lang.String> attributes) throws DirectoryException
rawBaseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filterString
- The string representation of the filter for
the search.attributes
- The set of requested attributes for the
search.
DirectoryException
- If the provided filter string cannot
be decoded as a search filter.public InternalSearchOperation processSearch(java.lang.String rawBaseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, java.lang.String filterString, java.util.LinkedHashSet<java.lang.String> attributes, InternalSearchListener searchListener) throws DirectoryException
rawBaseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filterString
- The string representation of the filter
for the search.attributes
- The set of requested attributes for the
search.searchListener
- The internal search listener that should
be used to handle the matching entries
and references.
DirectoryException
- If the provided filter string cannot
be decoded as a search filter.public InternalSearchOperation processSearch(java.lang.String rawBaseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, java.lang.String filterString, java.util.LinkedHashSet<java.lang.String> attributes, java.util.List<Control> controls, InternalSearchListener searchListener) throws DirectoryException
rawBaseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filterString
- The string representation of the filter
for the search.attributes
- The set of requested attributes for the
search.controls
- The set of controls to include in the
request.searchListener
- The internal search listener that should
be used to handle the matching entries
and references.
DirectoryException
- If the provided filter string cannot
be decoded as a search filter.public InternalSearchOperation processSearch(ByteString rawBaseDN, SearchScope scope, RawFilter filter)
rawBaseDN
- The base DN for the search.scope
- The scope for the search.filter
- The filter for the search.
public InternalSearchOperation processSearch(ByteString rawBaseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, RawFilter filter, java.util.LinkedHashSet<java.lang.String> attributes)
rawBaseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filter
- The filter for the search.attributes
- The set of requested attributes for the
search.
public InternalSearchOperation processSearch(ByteString rawBaseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, RawFilter filter, java.util.LinkedHashSet<java.lang.String> attributes, InternalSearchListener searchListener)
rawBaseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filter
- The filter for the search.attributes
- The set of requested attributes for the
search.searchListener
- The internal search listener that should
be used to handle the matching entries
and references.
public InternalSearchOperation processSearch(ByteString rawBaseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, RawFilter filter, java.util.LinkedHashSet<java.lang.String> attributes, java.util.List<Control> controls, InternalSearchListener searchListener)
rawBaseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filter
- The filter for the search.attributes
- The set of requested attributes for the
search.controls
- The set of controls to include in the
request.searchListener
- The internal search listener that should
be used to handle the matching entries
and references.
public InternalSearchOperation processSearch(DN baseDN, SearchScope scope, SearchFilter filter)
baseDN
- The base DN for the search.scope
- The scope for the search.filter
- The filter for the search.
public InternalSearchOperation processSearch(DN baseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, SearchFilter filter, java.util.LinkedHashSet<java.lang.String> attributes)
baseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filter
- The filter for the search.attributes
- The set of requested attributes for the
search.
public InternalSearchOperation processSearch(DN baseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, SearchFilter filter, java.util.LinkedHashSet<java.lang.String> attributes, InternalSearchListener searchListener)
baseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filter
- The filter for the search.attributes
- The set of requested attributes for the
search.searchListener
- The internal search listener that should
be used to handle the matching entries
and references.
public InternalSearchOperation processSearch(DN baseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, SearchFilter filter, java.util.LinkedHashSet<java.lang.String> attributes, java.util.List<Control> controls, InternalSearchListener searchListener)
baseDN
- The base DN for the search.scope
- The scope for the search.derefPolicy
- The alias dereferencing policy for the
search.sizeLimit
- The size limit for the search.timeLimit
- The time limit for the search.typesOnly
- The typesOnly flag for the search.filter
- The filter for the search.attributes
- The set of requested attributes for the
search.controls
- The set of controls to include in the
request.searchListener
- The internal search listener that should
be used to handle the matching entries
and references.
@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void sendSearchEntry(SearchOperation searchOperation, SearchResultEntry searchEntry) throws DirectoryException
sendSearchEntry
in class ClientConnection
searchOperation
- The search operation with which the
entry is associated.searchEntry
- The search result entry to be sent to
the client.
DirectoryException
- If a problem occurs while processing
the entry and the search should be
terminated.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public boolean sendSearchReference(SearchOperation searchOperation, SearchResultReference searchReference) throws DirectoryException
sendSearchReference
in class ClientConnection
searchOperation
- The search operation with which the
reference is associated.searchReference
- The search result reference to be sent
to the client.
true
if the client is able to accept
referrals, or false
if the client cannot
handle referrals and no more attempts should be made to
send them for the associated search operation.
DirectoryException
- If a problem occurs while processing
the entry and the search should be
terminated.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) protected boolean sendIntermediateResponseMessage(IntermediateResponse intermediateResponse)
sendIntermediateResponseMessage
in class ClientConnection
intermediateResponse
- The intermediate response message
to be sent.
true
if processing on the associated
operation should continue, or false
if not.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void disconnect(DisconnectReason disconnectReason, boolean sendNotification, Message message)
disconnect
in class ClientConnection
disconnectReason
- The disconnect reason that provides the
generic cause for the disconnect.sendNotification
- Indicates whether to try to provide
notification to the client that the
connection will be closed.message
- The message to send to the client. It
may be null
if no
notification is to be sent.public boolean bindInProgress()
bindInProgress
in class ClientConnection
true
if a bind operation is in progress on
this connection, or false
if not.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void setBindInProgress(boolean bindInProgress)
setBindInProgress
in class ClientConnection
bindInProgress
- Specifies whether a bind operation is in
progress on this client connection.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public java.util.Collection<AbstractOperation> getOperationsInProgress()
getOperationsInProgress
in class ClientConnection
@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public AbstractOperation getOperationInProgress(int messageID)
getOperationInProgress
in class ClientConnection
messageID
- The message ID of the operation to retrieve.
null
if no such operation could be
found.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public boolean removeOperationInProgress(int messageID)
removeOperationInProgress
in class ClientConnection
messageID
- The message ID of the operation to remove from
the set of operations in progress.
true
if the operation was found and removed
from the set of operations in progress, or
false
if not.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public CancelResult cancelOperation(int messageID, CancelRequest cancelRequest)
cancelOperation
in class ClientConnection
messageID
- The message ID of the operation to cancel.cancelRequest
- An object providing additional information
about how the cancel should be processed.
@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void cancelAllOperations(CancelRequest cancelRequest)
cancelAllOperations
in class ClientConnection
cancelRequest
- An object providing additional information
about how the cancel should be processed.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public void cancelAllOperationsExcept(CancelRequest cancelRequest, int messageID)
cancelAllOperationsExcept
in class ClientConnection
cancelRequest
- An object providing additional information
about how the cancel should be processed.messageID
- The message ID of the operation that
should not be canceled.public java.lang.String getMonitorSummary()
getMonitorSummary
in class ClientConnection
public void toString(java.lang.StringBuilder buffer)
toString
in class ClientConnection
buffer
- The buffer to which the information should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |