com.comphenix.protocol.injector

Class PacketFilterManager

java.lang.Object

com.comphenix.protocol.injector.PacketFilterManager

All Implemented Interfaces:

InternalManager, ListenerInvoker, PacketStream, ProtocolManager

public final class PacketFilterManager
extends Object
implements ListenerInvoker, InternalManager

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	REPORT_CANNOT_INITIALIZE_PACKET_INJECTOR
static ReportType	REPORT_CANNOT_INJECT_PLAYER
static ReportType	REPORT_CANNOT_LOAD_PACKET_LIST
static ReportType	REPORT_CANNOT_UNINJECT_OFFLINE_PLAYER
static ReportType	REPORT_CANNOT_UNINJECT_PLAYER
static ReportType	REPORT_CANNOT_UNREGISTER_PLUGIN
static ReportType	REPORT_PLUGIN_DEPEND_MISSING
static ReportType	REPORT_PLUGIN_VERIFIER_ERROR
static ReportType	REPORT_UNSUPPORTED_CLIENT_PACKET
static ReportType	REPORT_UNSUPPORTED_SERVER_PACKET
static int	TICKS_PER_SECOND The number of ticks in a second.

Constructor Summary

Constructors

Constructor and Description
PacketFilterManager(PacketFilterBuilder builder) Only create instances of this class if ProtocolLib is disabled.

Method Summary

Modifier and Type	Method and Description
void	addPacketListener(PacketListener listener)
void	broadcastServerPacket(PacketContainer packet)
void	broadcastServerPacket(PacketContainer packet, org.bukkit.entity.Entity entity, boolean includeTracker)
void	broadcastServerPacket(PacketContainer packet, org.bukkit.Location origin, int maxObserverDistance)
void	close() Called when ProtocolLib is closing.
PacketContainer	createPacket(int id) Deprecated.
PacketContainer	createPacket(int id, boolean forceDefaults) Deprecated.
PacketContainer	createPacket(PacketType type)
PacketContainer	createPacket(PacketType type, boolean forceDefaults)
PacketConstructor	createPacketConstructor(int id, Object... arguments) Deprecated.
PacketConstructor	createPacketConstructor(PacketType type, Object... arguments)
protected void	finalize()
AsynchronousManager	getAsynchronousManager()
ClassLoader	getClassLoader() Retrieves the current plugin class loader.
static Set<Integer>	getClientPackets() Deprecated.
org.bukkit.entity.Entity	getEntityFromID(org.bukkit.World container, int id)
List<org.bukkit.entity.Player>	getEntityTrackers(org.bukkit.entity.Entity entity)
InterceptWritePacket	getInterceptWritePacket() Retrieve the object responsible for intercepting write packets.
MinecraftVersion	getMinecraftVersion()
Class<?>	getPacketClassFromID(int packetID, boolean forceVanilla) Deprecated.
int	getPacketID(Object packet) Deprecated.
com.google.common.collect.ImmutableSet<PacketListener>	getPacketListeners()
PacketType	getPacketType(Object packet) Retrieve the associated type of a packet.
PlayerInjectHooks	getPlayerHook() Retrieves how the server packets are read.
int	getProtocolVersion(org.bukkit.entity.Player player)
Set<Integer>	getReceivingFilters()
Set<PacketType>	getReceivingFilterTypes()
Set<Integer>	getSendingFilters() Deprecated.
Set<PacketType>	getSendingFilterTypes()
static Set<Integer>	getServerPackets() Deprecated.
void	initializePlayers(List<org.bukkit.entity.Player> players) Initialize the packet injection for every player.
void	invokePacketRecieving(PacketEvent event) Invokes the given packet event for every registered listener.
void	invokePacketSending(PacketEvent event) Invokes the given packet event for every registered listener.
boolean	isClosed()
boolean	isDebug() Determine if debug mode is enabled.
static PacketFilterBuilder	newBuilder() Construct a new packet filter builder.
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet)
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet, boolean filters)
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet, NetworkMarker marker, boolean filters)
void	registerEvents(org.bukkit.plugin.PluginManager manager, org.bukkit.plugin.Plugin plugin) Register this protocol manager on Bukkit.
void	registerPacketClass(Class<?> clazz, int packetID) Deprecated.
void	removePacketListener(PacketListener listener)
void	removePacketListeners(org.bukkit.plugin.Plugin plugin)
boolean	requireInputBuffer(int packetId) Determine if a given packet requires input buffering.
void	sendServerPacket(org.bukkit.entity.Player reciever, PacketContainer packet)
void	sendServerPacket(org.bukkit.entity.Player reciever, PacketContainer packet, boolean filters)
void	sendServerPacket(org.bukkit.entity.Player receiver, PacketContainer packet, NetworkMarker marker, boolean filters)
void	sendWirePacket(org.bukkit.entity.Player receiver, int id, byte[] bytes)
void	sendWirePacket(org.bukkit.entity.Player receiver, WirePacket packet)
void	setDebug(boolean debug) Set whether or not debug mode is enabled.
void	setPlayerHook(PlayerInjectHooks playerHook) Sets how the server packets are read.
void	uninitializePlayers(List<org.bukkit.entity.Player> players) Uninitialize the packet injection of every player.
void	unregisterPacketClass(Class<?> clazz) Deprecated.
void	updateEntity(org.bukkit.entity.Entity entity, List<org.bukkit.entity.Player> observers)
void	verifyWhitelist(PacketListener listener, ListeningWhitelist whitelist) Determine if the packet IDs in a whitelist is valid.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_CANNOT_LOAD_PACKET_LIST

public static final ReportType REPORT_CANNOT_LOAD_PACKET_LIST

REPORT_CANNOT_INITIALIZE_PACKET_INJECTOR

public static final ReportType REPORT_CANNOT_INITIALIZE_PACKET_INJECTOR

REPORT_PLUGIN_DEPEND_MISSING

public static final ReportType REPORT_PLUGIN_DEPEND_MISSING

REPORT_UNSUPPORTED_SERVER_PACKET

public static final ReportType REPORT_UNSUPPORTED_SERVER_PACKET

REPORT_UNSUPPORTED_CLIENT_PACKET

public static final ReportType REPORT_UNSUPPORTED_CLIENT_PACKET

REPORT_CANNOT_UNINJECT_PLAYER

public static final ReportType REPORT_CANNOT_UNINJECT_PLAYER

REPORT_CANNOT_UNINJECT_OFFLINE_PLAYER

public static final ReportType REPORT_CANNOT_UNINJECT_OFFLINE_PLAYER

REPORT_CANNOT_INJECT_PLAYER

public static final ReportType REPORT_CANNOT_INJECT_PLAYER

REPORT_CANNOT_UNREGISTER_PLUGIN

public static final ReportType REPORT_CANNOT_UNREGISTER_PLUGIN

REPORT_PLUGIN_VERIFIER_ERROR

public static final ReportType REPORT_PLUGIN_VERIFIER_ERROR

TICKS_PER_SECOND

public static final int TICKS_PER_SECOND

The number of ticks in a second.

See Also:

Constant Field Values

Constructor Detail

PacketFilterManager

public PacketFilterManager(PacketFilterBuilder builder)

Only create instances of this class if ProtocolLib is disabled.

Parameters:

builder - - PacketFilterBuilder

Method Detail

newBuilder

public static PacketFilterBuilder newBuilder()

Construct a new packet filter builder.

Returns:

New builder.

getProtocolVersion

public int getProtocolVersion(org.bukkit.entity.Player player)

Specified by:

getProtocolVersion in interface ProtocolManager

getMinecraftVersion

public MinecraftVersion getMinecraftVersion()

Specified by:

getMinecraftVersion in interface ProtocolManager

getAsynchronousManager

public AsynchronousManager getAsynchronousManager()

Specified by:

getAsynchronousManager in interface ProtocolManager

isDebug

public boolean isDebug()

Description copied from interface: InternalManager

Determine if debug mode is enabled.

Specified by:

isDebug in interface InternalManager

Returns:

TRUE if it is, FALSE otherwise.

setDebug

public void setDebug(boolean debug)

Description copied from interface: InternalManager

Set whether or not debug mode is enabled.

Specified by:

setDebug in interface InternalManager

Parameters:

debug - - TRUE if it is, FALSE otherwise.

getPlayerHook

public PlayerInjectHooks getPlayerHook()

Retrieves how the server packets are read.

Specified by:

getPlayerHook in interface InternalManager

Returns:

Injection method for reading server packets.

setPlayerHook

public void setPlayerHook(PlayerInjectHooks playerHook)

Sets how the server packets are read.

Specified by:

setPlayerHook in interface InternalManager

Parameters:

playerHook - - the new injection method for reading server packets.

getPacketListeners

public com.google.common.collect.ImmutableSet<PacketListener> getPacketListeners()

Specified by:

getPacketListeners in interface ProtocolManager

getInterceptWritePacket

public InterceptWritePacket getInterceptWritePacket()

Description copied from interface: ListenerInvoker

Retrieve the object responsible for intercepting write packets.

Specified by:

getInterceptWritePacket in interface ListenerInvoker

Returns:

Object that intercepts write packets.

addPacketListener

public void addPacketListener(PacketListener listener)

Specified by:

addPacketListener in interface ProtocolManager

verifyWhitelist

public void verifyWhitelist(PacketListener listener,
                            ListeningWhitelist whitelist)

Determine if the packet IDs in a whitelist is valid.

Specified by:

verifyWhitelist in interface ProtocolManager

Parameters:

listener - - the listener that will be mentioned in the error.

whitelist - - whitelist of packet IDs.

Throws:

IllegalArgumentException - If the whitelist is illegal.

removePacketListener

public void removePacketListener(PacketListener listener)

Specified by:

removePacketListener in interface ProtocolManager

removePacketListeners

public void removePacketListeners(org.bukkit.plugin.Plugin plugin)

Specified by:

removePacketListeners in interface ProtocolManager

invokePacketRecieving

public void invokePacketRecieving(PacketEvent event)

Description copied from interface: ListenerInvoker

Invokes the given packet event for every registered listener.

Specified by:

invokePacketRecieving in interface ListenerInvoker

Parameters:

event - - the packet event to invoke.

invokePacketSending

public void invokePacketSending(PacketEvent event)

Description copied from interface: ListenerInvoker

Invokes the given packet event for every registered listener.

Specified by:

invokePacketSending in interface ListenerInvoker

Parameters:

event - - the packet event to invoke.

requireInputBuffer

public boolean requireInputBuffer(int packetId)

Description copied from interface: ListenerInvoker

Determine if a given packet requires input buffering.

Specified by:

requireInputBuffer in interface ListenerInvoker

Parameters:

packetId - - the packet to check.

Returns:

TRUE if it does, FALSE otherwise.

broadcastServerPacket

public void broadcastServerPacket(PacketContainer packet)

Specified by:

broadcastServerPacket in interface ProtocolManager

broadcastServerPacket

public void broadcastServerPacket(PacketContainer packet,
                                  org.bukkit.entity.Entity entity,
                                  boolean includeTracker)

Specified by:

broadcastServerPacket in interface ProtocolManager

broadcastServerPacket

public void broadcastServerPacket(PacketContainer packet,
                                  org.bukkit.Location origin,
                                  int maxObserverDistance)

Specified by:

broadcastServerPacket in interface ProtocolManager

sendServerPacket

public void sendServerPacket(org.bukkit.entity.Player reciever,
                             PacketContainer packet)
                      throws InvocationTargetException

Specified by:

sendServerPacket in interface PacketStream

Throws:

InvocationTargetException

sendServerPacket

public void sendServerPacket(org.bukkit.entity.Player reciever,
                             PacketContainer packet,
                             boolean filters)
                      throws InvocationTargetException

Specified by:

sendServerPacket in interface PacketStream

Specified by:

sendServerPacket in interface ProtocolManager

Throws:

InvocationTargetException

sendServerPacket

public void sendServerPacket(org.bukkit.entity.Player receiver,
                             PacketContainer packet,
                             NetworkMarker marker,
                             boolean filters)
                      throws InvocationTargetException

Specified by:

sendServerPacket in interface PacketStream

Throws:

InvocationTargetException

sendWirePacket

public void sendWirePacket(org.bukkit.entity.Player receiver,
                           int id,
                           byte[] bytes)
                    throws InvocationTargetException

Specified by:

sendWirePacket in interface PacketStream

Throws:

InvocationTargetException

sendWirePacket

public void sendWirePacket(org.bukkit.entity.Player receiver,
                           WirePacket packet)
                    throws InvocationTargetException

Specified by:

sendWirePacket in interface PacketStream

Throws:

InvocationTargetException

recieveClientPacket

public void recieveClientPacket(org.bukkit.entity.Player sender,
                                PacketContainer packet)
                         throws IllegalAccessException,
                                InvocationTargetException

Specified by:

recieveClientPacket in interface PacketStream

Throws:

IllegalAccessException

InvocationTargetException

recieveClientPacket

public void recieveClientPacket(org.bukkit.entity.Player sender,
                                PacketContainer packet,
                                boolean filters)
                         throws IllegalAccessException,
                                InvocationTargetException

Specified by:

recieveClientPacket in interface PacketStream

Specified by:

recieveClientPacket in interface ProtocolManager

Throws:

IllegalAccessException

InvocationTargetException

recieveClientPacket

public void recieveClientPacket(org.bukkit.entity.Player sender,
                                PacketContainer packet,
                                NetworkMarker marker,
                                boolean filters)
                         throws IllegalAccessException,
                                InvocationTargetException

Specified by:

recieveClientPacket in interface PacketStream

Throws:

IllegalAccessException

InvocationTargetException

createPacket

@Deprecated
public PacketContainer createPacket(int id)

Deprecated.

Specified by:

createPacket in interface ProtocolManager

createPacket

public PacketContainer createPacket(PacketType type)

Specified by:

createPacket in interface ProtocolManager

createPacket

@Deprecated
public PacketContainer createPacket(int id,
                                                 boolean forceDefaults)

Deprecated.

Specified by:

createPacket in interface ProtocolManager

createPacket

public PacketContainer createPacket(PacketType type,
                                    boolean forceDefaults)

Specified by:

createPacket in interface ProtocolManager

createPacketConstructor

@Deprecated
public PacketConstructor createPacketConstructor(int id,
                                                              Object... arguments)

Deprecated.

Specified by:

createPacketConstructor in interface ProtocolManager

createPacketConstructor

public PacketConstructor createPacketConstructor(PacketType type,
                                                 Object... arguments)

Specified by:

createPacketConstructor in interface ProtocolManager

getSendingFilters

@Deprecated
public Set<Integer> getSendingFilters()

Deprecated.

Specified by:

getSendingFilters in interface ProtocolManager

getReceivingFilters

public Set<Integer> getReceivingFilters()

Specified by:

getReceivingFilters in interface ProtocolManager

getSendingFilterTypes

public Set<PacketType> getSendingFilterTypes()

Specified by:

getSendingFilterTypes in interface ProtocolManager

getReceivingFilterTypes

public Set<PacketType> getReceivingFilterTypes()

Specified by:

getReceivingFilterTypes in interface ProtocolManager

updateEntity

public void updateEntity(org.bukkit.entity.Entity entity,
                         List<org.bukkit.entity.Player> observers)
                  throws FieldAccessException

Specified by:

updateEntity in interface ProtocolManager

Throws:

FieldAccessException

getEntityFromID

public org.bukkit.entity.Entity getEntityFromID(org.bukkit.World container,
                                                int id)
                                         throws FieldAccessException

Specified by:

getEntityFromID in interface ProtocolManager

Throws:

FieldAccessException

getEntityTrackers

public List<org.bukkit.entity.Player> getEntityTrackers(org.bukkit.entity.Entity entity)
                                                 throws FieldAccessException

Specified by:

getEntityTrackers in interface ProtocolManager

Throws:

FieldAccessException

initializePlayers

public void initializePlayers(List<org.bukkit.entity.Player> players)

Initialize the packet injection for every player.

Parameters:

players - - list of players to inject.

uninitializePlayers

public void uninitializePlayers(List<org.bukkit.entity.Player> players)

Uninitialize the packet injection of every player.

Parameters:

players - - list of players to uninject.

registerEvents

public void registerEvents(org.bukkit.plugin.PluginManager manager,
                           org.bukkit.plugin.Plugin plugin)

Register this protocol manager on Bukkit.

Specified by:

registerEvents in interface InternalManager

Parameters:

manager - - Bukkit plugin manager that provides player join/leave events.

plugin - - the parent plugin.

getPacketID

@Deprecated
public int getPacketID(Object packet)

Deprecated.

Description copied from interface: ListenerInvoker

Retrieve the associated ID of a packet.

Specified by:

getPacketID in interface ListenerInvoker

Parameters:

packet - - the packet.

Returns:

The packet ID.

getPacketType

public PacketType getPacketType(Object packet)

Description copied from interface: ListenerInvoker

Retrieve the associated type of a packet.

Specified by:

getPacketType in interface ListenerInvoker

Parameters:

packet - - the packet.

Returns:

The packet type.

registerPacketClass

@Deprecated
public void registerPacketClass(Class<?> clazz,
                                             int packetID)

Deprecated.

Description copied from interface: ListenerInvoker

Register a given class in the packet registry. Internal method.

Specified by:

registerPacketClass in interface ListenerInvoker

Parameters:

clazz - - class to register.

packetID - - the the new associated packet ID.

unregisterPacketClass

@Deprecated
public void unregisterPacketClass(Class<?> clazz)

Deprecated.

Description copied from interface: ListenerInvoker

Associate a given class with the given packet ID. Internal method.

Specified by:

unregisterPacketClass in interface ListenerInvoker

Parameters:

clazz - - class to associate.

getPacketClassFromID

@Deprecated
public Class<?> getPacketClassFromID(int packetID,
                                                  boolean forceVanilla)

Deprecated.

Description copied from interface: ListenerInvoker

Retrieves the correct packet class from a given packet ID.

Specified by:

getPacketClassFromID in interface ListenerInvoker

Parameters:

packetID - - the packet ID.

forceVanilla - - whether or not to look for vanilla classes, not injected classes.

Returns:

The associated class.

getServerPackets

@Deprecated
public static Set<Integer> getServerPackets()
                                                  throws FieldAccessException

Deprecated.

Retrieve every known and supported server packet.

Returns:

An immutable set of every known server packet.

Throws:

FieldAccessException - If we're unable to retrieve the server packet data from Minecraft.

getClientPackets

@Deprecated
public static Set<Integer> getClientPackets()
                                                  throws FieldAccessException

Deprecated.

Retrieve every known and supported client packet.

Returns:

An immutable set of every known client packet.

Throws:

FieldAccessException - If we're unable to retrieve the client packet data from Minecraft.

getClassLoader

public ClassLoader getClassLoader()

Retrieves the current plugin class loader.

Returns:

Class loader.

isClosed

public boolean isClosed()

Specified by:

isClosed in interface ProtocolManager

close

public void close()

Description copied from interface: InternalManager

Called when ProtocolLib is closing.

Specified by:

close in interface InternalManager

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable