com.comphenix.protocol

Class CommandFilter

java.lang.Object

com.comphenix.protocol.CommandFilter

All Implemented Interfaces:

org.bukkit.command.CommandExecutor

public class CommandFilter
extends java.lang.Object

A command to apply JavaScript filtering to the packet command.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandFilter.Filter A filter that will be used to process a packet event.
static interface	CommandFilter.FilterFailedHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME Name of this command.
static java.lang.String	PERMISSION_ADMIN
static ReportType	REPORT_CANNOT_HANDLE_CONVERSATION
static ReportType	REPORT_CANNOT_LOAD_FALLBACK_ENGINE
static ReportType	REPORT_COMMAND_ERROR
static ReportType	REPORT_FALLBACK_ENGINE
static ReportType	REPORT_FILTER_REMOVED_FOR_ERROR
static ReportType	REPORT_PACKAGES_UNSUPPORTED_IN_ENGINE
static ReportType	REPORT_UNEXPECTED_COMMAND
protected ErrorReporter	reporter

Constructor Summary

Constructors

Constructor and Description
CommandFilter(ErrorReporter reporter, org.bukkit.plugin.Plugin plugin, ProtocolConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	filterEvent(PacketEvent event) Determine whether or not to pass the given packet event to the packet listeners.
boolean	filterEvent(PacketEvent event, CommandFilter.FilterFailedHandler handler) Determine whether or not to pass the given packet event to the packet listeners.
java.lang.String	getName() Retrieve the primary name of this command.
java.lang.String	getPermission() Retrieve the permission necessary to execute this command.
protected ErrorReporter	getReporter() Retrieve the error reporter.
protected boolean	handleCommand(org.bukkit.command.CommandSender sender, java.lang.String[] args) Main implementation of this command.
boolean	isInitialized() Determine if the filter engine has been successfully initialized.
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command command, java.lang.String label, java.lang.String[] args)
protected java.lang.Boolean	parseBoolean(java.util.Deque<java.lang.String> arguments, java.lang.String parameterName) Parse a boolean value at the head of the queue.
protected java.util.Deque<java.lang.String>	toQueue(java.lang.String[] args, int start) Create a queue from a sublist of a given array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REPORT_FALLBACK_ENGINE

public static final ReportType REPORT_FALLBACK_ENGINE

REPORT_CANNOT_LOAD_FALLBACK_ENGINE

public static final ReportType REPORT_CANNOT_LOAD_FALLBACK_ENGINE

REPORT_PACKAGES_UNSUPPORTED_IN_ENGINE

public static final ReportType REPORT_PACKAGES_UNSUPPORTED_IN_ENGINE

REPORT_FILTER_REMOVED_FOR_ERROR

public static final ReportType REPORT_FILTER_REMOVED_FOR_ERROR

REPORT_CANNOT_HANDLE_CONVERSATION

public static final ReportType REPORT_CANNOT_HANDLE_CONVERSATION

NAME

public static final java.lang.String NAME

Name of this command.

See Also:

Constant Field Values

REPORT_COMMAND_ERROR

public static final ReportType REPORT_COMMAND_ERROR

REPORT_UNEXPECTED_COMMAND

public static final ReportType REPORT_UNEXPECTED_COMMAND

PERMISSION_ADMIN

public static final java.lang.String PERMISSION_ADMIN

See Also:

Constant Field Values

reporter

protected ErrorReporter reporter

Constructor Detail

CommandFilter

public CommandFilter(ErrorReporter reporter,
             org.bukkit.plugin.Plugin plugin,
             ProtocolConfig config)

Method Detail

isInitialized

public boolean isInitialized()

Determine if the filter engine has been successfully initialized.

Returns:

TRUE if it has, FALSE otherwise.

filterEvent

public boolean filterEvent(PacketEvent event)

Determine whether or not to pass the given packet event to the packet listeners.

Uses a default filter failure handler that simply prints the error message and removes the filter.

Parameters:

event - - the event.

Returns:

TRUE if we should, FALSE otherwise.

filterEvent

public boolean filterEvent(PacketEvent event,
                  CommandFilter.FilterFailedHandler handler)

Determine whether or not to pass the given packet event to the packet listeners.

Parameters:

event - - the event.

handler - - failure handler.

Returns:

TRUE if we should, FALSE otherwise.

Throws:

FilterFailedException - If one of the filters failed.

handleCommand

protected boolean handleCommand(org.bukkit.command.CommandSender sender,
                    java.lang.String[] args)

Main implementation of this command.

Parameters:

sender - - command sender.

args - - input arguments.

Returns:

TRUE if the command was successfully handled, FALSE otherwise.

onCommand

public final boolean onCommand(org.bukkit.command.CommandSender sender,
                org.bukkit.command.Command command,
                java.lang.String label,
                java.lang.String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

parseBoolean

protected java.lang.Boolean parseBoolean(java.util.Deque<java.lang.String> arguments,
                             java.lang.String parameterName)

Parse a boolean value at the head of the queue.

Parameters:

arguments - - the queue of arguments.

parameterName - - the parameter name we will match.

Returns:

The parsed boolean, or NULL if not valid.

toQueue

protected java.util.Deque<java.lang.String> toQueue(java.lang.String[] args,
                                        int start)

Create a queue from a sublist of a given array.

Parameters:

args - - the source array.

start - - the starting index.

Returns:

A queue that contains every element in the array, starting at the given index.

getPermission

public java.lang.String getPermission()

Retrieve the permission necessary to execute this command.

Returns:

The permission, or NULL if not needed.

getName

public java.lang.String getName()

Retrieve the primary name of this command.

Returns:

Primary name.

getReporter

protected ErrorReporter getReporter()

Retrieve the error reporter.

Returns:

Error reporter.