com.taggercat.handlers
Annotation Type URIAction

@Retention(value=RUNTIME)
@Documented
public @interface URIAction

This annotation can be used to map a request handler to URI Pattern. It is not used to map in handlers using regular expressions.

Required Element Summary

java.lang.String

URIPattern The URI pattern matching the URIs supported by this handler - this is not a reg-ex

Optional Element Summary

java.lang.String	defaultActionMethod The name of the default action method.
java.lang.String[]	defaultValues Default value to be used when the pattern placeholder is not matched in the URI.
boolean	firstMatchOnly Should pattern matching stop if this is included in the action chain.
int	priority The priority given to this handler when chained in; 1 = high, 10 = low.
java.lang.String[]	qualifiers An array of reg-ex expressions to further qualify the matching of the pattern to the request.
boolean	requiresSession Does this action require a valid active session
boolean	validOnDelete Set to true to have pattern apply to DELETE requests
boolean	validOnGet Set to true to have pattern apply to GET requests
boolean	validOnPost Set to true to have pattern apply to POST requests
boolean	validOnPut Set to true to have pattern apply to PUT requests

Element Detail

URIPattern

public abstract java.lang.String URIPattern

The URI pattern matching the URIs supported by this handler - this is not a reg-ex

defaultActionMethod

public abstract java.lang.String defaultActionMethod

The name of the default action method. If you don't use an {action} placeholder, you'll probably want to use this attribute.

Default:

""

defaultValues

public abstract java.lang.String[] defaultValues

Default value to be used when the pattern placeholder is not matched in the URI. The default values must be specified in the same order has the pattern's placeholders

Default:

{}

validOnPost

public abstract boolean validOnPost

Set to true to have pattern apply to POST requests

Default:

true

validOnGet

public abstract boolean validOnGet

Set to true to have pattern apply to GET requests

Default:

true

validOnPut

public abstract boolean validOnPut

Set to true to have pattern apply to PUT requests

Default:

false

validOnDelete

public abstract boolean validOnDelete

Set to true to have pattern apply to DELETE requests

Default:

false

priority

public abstract int priority

The priority given to this handler when chained in; 1 = high, 10 = low.

Default:

5

firstMatchOnly

public abstract boolean firstMatchOnly

Should pattern matching stop if this is included in the action chain. The default is true, since you usually only what one handler matching a URL Pattern

Default:

true

qualifiers

public abstract java.lang.String[] qualifiers

An array of reg-ex expressions to further qualify the matching of the pattern to the request. The same number of qualifier regEx expressions must be specified, and in the same order has the pattern's placeholders

Default:

{}

requiresSession

public abstract boolean requiresSession

Does this action require a valid active session

Default:

true