|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.http.Descriptor
public class Descriptor
Webapplication Descriptor Class representation of an XQuery Web Application Descriptor file with some helper functions for performing Descriptor related actions Uses the Singleton design pattern.
Method Summary | |
---|---|
boolean |
allowRequestLogging()
Determines whether it is permissible to Log Requests Enabled by descriptor.xml |
boolean |
allowSourceXQuery(String path)
Determines whether it is permissible to show the source of an XQuery. |
Object |
clone()
Thows a CloneNotSupportedException as this class uses a Singleton design pattern |
void |
doLogRequestInReplayLog(HttpServletRequest request)
Logs HTTP Request's in a log file suitable for replaying to eXist later Takes a HttpServletRequest or a HttpServletRequestWrapper as an argument for logging. |
void |
error(SAXParseException exception)
|
void |
fatalError(SAXParseException exception)
|
static Descriptor |
getDescriptorSingleton()
Returns a refernce to this (Descriptor) Singleton class |
String |
mapPath(String path)
Map's one XQuery or Collection path to another Takes a path such as that from RESTServer.doGet() as an argument, if it finds a matching map path then it returns the map view else it returns the passed in path |
void |
warning(SAXParseException exception)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static Descriptor getDescriptorSingleton()
public boolean allowSourceXQuery(String path)
path
- The path of the XQuery (e.g. /db/MyCollection/query.xql)
public String mapPath(String path)
path
- The path of the XQuery or Collection (e.g. /db/MyCollection/query.xql or /db/MyCollection) to map from
public boolean allowRequestLogging()
public void doLogRequestInReplayLog(HttpServletRequest request)
request
- The HttpServletRequest to log.
For Simple HTTP POST Requests - EXistServlet/XQueryServlet - POST parameters (e.g. form data) will only be logged if a HttpServletRequestWrapper is used instead of HttpServletRequest! POST Uploaded files are not yet supported!
For XML-RPC Requests - RpcServlet - HttpServletRequestWrapper must be used, otherwise the content of the Request will be lost!
For Cocoon Requests -public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
public void error(SAXParseException exception) throws SAXException
error
in interface ErrorHandler
SAXException
ErrorHandler.error(org.xml.sax.SAXParseException)
public void fatalError(SAXParseException exception) throws SAXException
fatalError
in interface ErrorHandler
SAXException
ErrorHandler.fatalError(org.xml.sax.SAXParseException)
public void warning(SAXParseException exception) throws SAXException
warning
in interface ErrorHandler
SAXException
ErrorHandler.warning(org.xml.sax.SAXParseException)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |