|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.plugin.PluginResult.PostConnect
public static final class PluginResult.PostConnect
Defines a post connect plugin result for client connection processing consisting of either continue, skip further plugins, or stop.
Method Summary | |
---|---|
static PluginResult.PostConnect |
continueConnectProcessing()
Defines a continue processing post connect plugin result. |
boolean |
continuePluginProcessing()
Whether to invoke the rest of the plugins. |
boolean |
continueProcessing()
Whether to continue operation processing. |
static PluginResult.PostConnect |
disconnectClient(DisconnectReason disconnectReason,
boolean sendDisconnectNotification,
Message errorMessage)
Defines a new stop processing post connect plugin result. |
DisconnectReason |
getDisconnectReason()
The disconnect reason that provides the generic cause for the disconnect. |
Message |
getErrorMessage()
Retrieves the error message if continueProcessing
returned false . |
boolean |
sendDisconnectNotification()
Indicates whether to try to provide notification to the client that the connection will be closed. |
static PluginResult.PostConnect |
skipFurtherPluginProcesssing()
Defines a skip further plugin processing post connect plugin result. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static PluginResult.PostConnect continueConnectProcessing()
public static PluginResult.PostConnect skipFurtherPluginProcesssing()
public static PluginResult.PostConnect disconnectClient(DisconnectReason disconnectReason, boolean sendDisconnectNotification, Message errorMessage)
disconnectReason
- The generic cause for the disconnect.sendDisconnectNotification
- Whether to send a disconnect
notification to the client.errorMessage
- An message explaining why processing
should stop for the given entry.
public boolean continueProcessing()
true
if processing should continue
or false
otherwise.public boolean continuePluginProcessing()
true
if the rest of the plugins should
be invoked for false
to skip the rest of the
plugins.public Message getErrorMessage()
continueProcessing
returned false
.
null
if none is provided.public DisconnectReason getDisconnectReason()
public boolean sendDisconnectNotification()
true
if notification should be provided or
false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |