org.nuxeo.ecm.webengine
Class PathDescriptor
java.lang.Object
org.nuxeo.ecm.webengine.PathDescriptor
- All Implemented Interfaces:
- java.lang.Comparable<PathDescriptor>
public class PathDescriptor
- extends java.lang.Object
- implements java.lang.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/.*
If stateful flag is set (the default is false) then the core session
which is provided to the JAX-RS resource (through
UserSession.getCoreSession()
) will be reused for each request in the
same HTPP session (i.e. the core session is stored in the HTTP Session and
closed when the session expires). By default the provided core session has a
REQUEST scope (it is closed automatically when request ends).
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
'/'.
- Author:
- Bogdan Stefanescu
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
PathDescriptor
public PathDescriptor()
PathDescriptor
public PathDescriptor(java.lang.String value,
boolean regex,
boolean autoTx,
boolean stateful)
getMatcher
public PathMatcher getMatcher()
getValue
public java.lang.String getValue()
getAutoTx
public java.lang.Boolean getAutoTx()
getStateful
public java.lang.Boolean getStateful()
isAutoTx
public boolean isAutoTx(boolean defaultValue)
isStateful
public boolean isStateful(boolean defaultValue)
createMatcher
public PathMatcher createMatcher()
match
public boolean match(java.lang.String path)
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in class java.lang.Object
hashCode
public int hashCode()
- Overrides:
hashCode
in class java.lang.Object
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
compareTo
public int compareTo(PathDescriptor o)
- Specified by:
compareTo
in interface java.lang.Comparable<PathDescriptor>
main
public static void main(java.lang.String[] args)
Copyright © 2010 Nuxeo SAS. All Rights Reserved.