net.jradius.handler.chain

Interface JRCommand

All Superinterfaces:

org.apache.commons.chain.Command

All Known Subinterfaces:

EventHandler, PacketHandler

All Known Implementing Classes:

EventHandlerBase, EventHandlerChain, JRChainBase, PacketHandlerBase, PacketHandlerChain

public interface JRCommand
extends org.apache.commons.chain.Command

The JRadius Command Interface for Jakarta Commons Chain. This class is the foundation of all handlers within JRadius - which can be single command, or chains of commands.

Author:

David Bird

Field Summary

Fields inherited from interface org.apache.commons.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Method Summary

Modifier and Type	Method and Description
boolean	doesHandle(JRadiusEvent event) Tests whether or not this handler handles the given JRadiusEvent.
String	getName()
void	setConfig(ConfigurationItem cfg) Set the ConfigurationItem of this handler.

Methods inherited from interface org.apache.commons.chain.Command

execute

Method Detail

setConfig

void setConfig(ConfigurationItem cfg)

Set the ConfigurationItem of this handler. All JRadius handlers have an associated HandlerConfigurationItem associated with it.

Parameters:

cfg - The HandlerConfigurationItem to be set

doesHandle

boolean doesHandle(JRadiusEvent event)

Tests whether or not this handler handles the given JRadiusEvent.

Parameters:

event - The JRadiusEvent (or JRadiusRequest) to be checked

Returns:

Returns true if this handler should handle the given event

getName

String getName()

Returns:

Returns the name of the handler (as defined in the configuration)