Class PluginResult.PostConnect

  • Enclosing class:
    PluginResult

    public static final class PluginResult.PostConnect
    extends Object
    Defines a post connect plugin result for client connection processing consisting of either continue, skip further plugins, or stop.
    • Method Detail

      • continueConnectProcessing

        public static PluginResult.PostConnect continueConnectProcessing()
        Defines a continue processing post connect plugin result.
        Returns:
        a continue processing post connect plugin result.
      • skipFurtherPluginProcessing

        public static PluginResult.PostConnect skipFurtherPluginProcessing()
        Defines a skip further plugin processing post connect plugin result.
        Returns:
        a skip further plugin processing post connect plugin result.
      • disconnectClient

        public static PluginResult.PostConnect disconnectClient​(DisconnectReason disconnectReason,
                                                                boolean sendDisconnectNotification,
                                                                LocalizableMessage errorMessage)
        Defines a new stop processing post connect plugin result.
        Parameters:
        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.
        Returns:
        a new stop processing post connect plugin result.
      • continueProcessing

        public boolean continueProcessing()
        Whether to continue operation processing.
        Returns:
        true if processing should continue or false otherwise.
      • continuePluginProcessing

        public boolean continuePluginProcessing()
        Whether to invoke the rest of the plugins.
        Returns:
        true if the rest of the plugins should be invoked for false to skip the rest of the plugins.
      • getErrorMessage

        public LocalizableMessage getErrorMessage()
        Retrieves the error message if continueProcessing() returned false.
        Returns:
        An error message explaining why processing should stop or null if none is provided.
      • getDisconnectReason

        public DisconnectReason getDisconnectReason()
        The disconnect reason that provides the generic cause for the disconnect.
        Returns:
        the generic cause for the disconnect.
      • sendDisconnectNotification

        public boolean sendDisconnectNotification()
        Indicates whether to try to provide notification to the client that the connection will be closed.
        Returns:
        true if notification should be provided or false otherwise.