|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface PluginOperation
This class defines a set of methods that are available for use by all types of plugins involved in operation processing (pre-parse, pre-operation, post-operation, post-response, search result entry, search result reference, and intermediate response). Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.
Method Summary | |
---|---|
void |
checkIfCanceled(boolean signalTooLate)
Checks to see if this operation requested to cancel in which case CanceledOperationException will be thrown. |
void |
disconnectClient(DisconnectReason disconnectReason,
boolean sendNotification,
Message message)
Terminates the client connection being used to process this operation. |
java.lang.Object |
getAttachment(java.lang.String name)
Retrieves the attachment with the specified name. |
java.util.Map<java.lang.String,java.lang.Object> |
getAttachments()
Retrieves the set of attachments defined for this operation, as a mapping between the attachment name and the associated object. |
ClientConnection |
getClientConnection()
Retrieves the client connection with which this operation is associated. |
long |
getConnectionID()
Retrieves the unique identifier that is assigned to the client connection that submitted this operation. |
int |
getMessageID()
Retrieves the message ID assigned to this operation. |
long |
getOperationID()
Retrieves the operation ID for this operation. |
OperationType |
getOperationType()
Retrieves the operation type for this operation. |
long |
getProcessingStartTime()
Retrieves the time that processing started for this operation. |
java.util.List<Control> |
getRequestControls()
Retrieves the set of controls included in the request from the client. |
java.util.List<Control> |
getResponseControls()
Retrieves the set of controls to include in the response to the client. |
boolean |
isInternalOperation()
Indicates whether this is an internal operation rather than one that was requested by an external client. |
boolean |
isSynchronizationOperation()
Indicates whether this is a synchronization operation rather than one that was requested by an external client. |
java.lang.Object |
removeAttachment(java.lang.String name)
Removes the attachment with the specified name. |
java.lang.Object |
setAttachment(java.lang.String name,
java.lang.Object value)
Sets the value of the specified attachment. |
java.lang.String |
toString()
Retrieves a string representation of this operation. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this operation to the provided buffer. |
Method Detail |
---|
OperationType getOperationType()
ClientConnection getClientConnection()
void disconnectClient(DisconnectReason disconnectReason, boolean sendNotification, Message message)
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.long getConnectionID()
long getOperationID()
int getMessageID()
java.util.List<Control> getRequestControls()
java.util.List<Control> getResponseControls()
boolean isInternalOperation()
true
if this is an internal operation, or
false
if it is not.boolean isSynchronizationOperation()
true
if this is a data synchronization
operation, or false
if it is not.java.util.Map<java.lang.String,java.lang.Object> getAttachments()
java.lang.Object getAttachment(java.lang.String name)
name
- The name for the attachment to retrieve. It will
be treated in a case-sensitive manner.
null
if
it does not exist.java.lang.Object removeAttachment(java.lang.String name)
name
- The name for the attachment to remove. It will be
treated in a case-sensitive manner.
null
if
it does not exist.java.lang.Object setAttachment(java.lang.String name, java.lang.Object value)
name
- The name to use for the attachment.value
- The value to use for the attachment.
null
if there was previously no
such attachment.long getProcessingStartTime()
java.lang.String toString()
toString
in class java.lang.Object
void toString(java.lang.StringBuilder buffer)
buffer
- The buffer into which a string representation of
this operation should be appended.void checkIfCanceled(boolean signalTooLate) throws CanceledOperationException
signalTooLate
- true
to signal that any further
cancel requests will be too late after
return from this call or false
otherwise.
CanceledOperationException
- if this operation should
be cancelled.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |