org.ocpsoft.rewrite.config

Class Log

java.lang.Object

org.ocpsoft.rewrite.config.DefaultOperationBuilder

org.ocpsoft.rewrite.config.Log

All Implemented Interfaces:

Operation, OperationBuilder, Parameterized

public class Log
extends DefaultOperationBuilder
implements Parameterized

An Operation responsible for logging a message.

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getRequiredParameterNames() Get all required Parameter names for this Parameterized instance.
static Log	message(org.ocpsoft.logging.Logger.Level level, String message) Log a message at the given Logger.Level.
void	perform(Rewrite event, EvaluationContext context) Perform the Operation.
void	setParameterStore(ParameterStore store) Initialize this Parameterized instance with the global ParameterStore.

Methods inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder

and

Methods inherited from class java.lang.Object

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

Method Detail

message

public static Log message(org.ocpsoft.logging.Logger.Level level,
          String message)

Log a message at the given Logger.Level.

The message may be parameterized:

For example, assuming a given Condition has been configured to use a parameter "p"}:

Path.matches("/{p}")

The parameter "p" may be referenced in the log message:

Log.message(Level.INFO, "Client requested path: {p}")

Parameters:

level - the log Logger.Level to which the message be written

message - ParameterizedPattern to be written to the log.

See Also:

ConfigurationRuleParameterBuilder#where(String)}

perform

public void perform(Rewrite event,
           EvaluationContext context)

Description copied from interface: Operation

Perform the Operation.

Specified by:

perform in interface Operation

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Description copied from interface: Parameterized

Get all required Parameter names for this Parameterized instance.

Specified by:

getRequiredParameterNames in interface Parameterized

setParameterStore

public void setParameterStore(ParameterStore store)

Description copied from interface: Parameterized

Initialize this Parameterized instance with the global ParameterStore.

Specified by:

setParameterStore in interface Parameterized