org.nuxeo.ecm.webengine

Class PathDescriptor

java.lang.Object

org.nuxeo.ecm.webengine.PathDescriptor

All Implemented Interfaces:

Comparable<PathDescriptor>

public class PathDescriptor
extends Object
implements Comparable<PathDescriptor>

Configure how a given path is handled by the WebEngine filter.

If autoTx is true (which is the default) then a transaction will be started each time a path matching the given path specification is requested. (the transaction is started in a filter before the JAX-RS resource is called and closed after the response is sent to the output stream). If false then no transaction handling is done. The default is to start a transaction for any path but: [^/]+/skin/.*

The value attribute is required and must be used to specify the path pattern. The path pattern is either a prefix or a regular expression. If the regex parameter is true (the default is false) then the value will be expected to be a regular expression. A prefix denotes a path starting with 'prefix'. Paths are relative to the webengine servlet (i.e. they correspond to the servlet path info in the JAX-RS servlet) - and always begin with a '/'.

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	autoTx
protected PathMatcher	matcher
protected boolean	regex
protected String	value

Constructor Summary

Constructors

Constructor and Description
PathDescriptor()

Method Summary

Modifier and Type	Method and Description
int	compareTo(PathDescriptor o)
PathMatcher	createMatcher()
boolean	equals(Object obj)
Boolean	getAutoTx()
PathMatcher	getMatcher()
String	getValue()
int	hashCode()
boolean	isAutoTx(boolean defaultValue)
boolean	match(String path)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected String value

regex

protected boolean regex

autoTx

protected Boolean autoTx

matcher

protected PathMatcher matcher

Constructor Detail

PathDescriptor

public PathDescriptor()

Method Detail

getMatcher

public PathMatcher getMatcher()

getValue

public String getValue()

getAutoTx

public Boolean getAutoTx()

isAutoTx

public boolean isAutoTx(boolean defaultValue)

createMatcher

public PathMatcher createMatcher()

match

public boolean match(String path)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(PathDescriptor o)

Specified by:

compareTo in interface Comparable<PathDescriptor>