public class STDavRequest
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
long |
startTime
the start time
|
Constructor and Description |
---|
STDavRequest(HttpServletRequest httpRequest,
DavLocatorFactory factory)
Creates a new
DavServletRequest with the given parameters. |
STDavRequest(HttpServletRequest httpRequest,
DavLocatorFactory factory,
boolean createAbsoluteURI)
Creates a new
DavServletRequest with the given parameters. |
Modifier and Type | Method and Description |
---|---|
boolean |
authenticate(javax.servlet.http.HttpServletResponse r) |
java.lang.String |
changeSessionId() |
AsyncContext |
getAsyncContext() |
java.lang.Object |
getAttribute(java.lang.String s) |
java.util.Enumeration<java.lang.String> |
getAttributeNames() |
java.lang.String |
getAuthType() |
BindInfo |
getBindInfo() |
java.lang.String |
getCharacterEncoding() |
int |
getContentLength() |
long |
getContentLengthLong() |
java.lang.String |
getContentType() |
java.lang.String |
getContextPath() |
Cookie[] |
getCookies() |
long |
getDateHeader(java.lang.String s) |
DavSession |
getDavSession() |
int |
getDepth() |
int |
getDepth(int defaultValue) |
DavResourceLocator |
getDestinationLocator()
Parse the destination header field and return the path of the destination
resource.
|
DispatcherType |
getDispatcherType() |
java.lang.String |
getHeader(java.lang.String s) |
java.util.Enumeration<java.lang.String> |
getHeaderNames() |
java.util.Enumeration<java.lang.String> |
getHeaders(java.lang.String s) |
DavResourceLocator |
getHrefLocator(java.lang.String href)
Parse a href and return the path of the resource.
|
ServletInputStream |
getInputStream() |
int |
getIntHeader(java.lang.String s) |
java.lang.String |
getLabel() |
LabelInfo |
getLabelInfo() |
java.lang.String |
getLocalAddr() |
java.util.Locale |
getLocale() |
java.util.Enumeration<java.util.Locale> |
getLocales() |
java.lang.String |
getLocalName() |
int |
getLocalPort() |
LockInfo |
getLockInfo()
LockInfo object encapsulating the information passed with a LOCK
request if the LOCK request body was valid. |
java.lang.String |
getLockToken()
Retrieve the lock token from the 'Lock-Token' header.
|
DavResourceLocator |
getMemberLocator(java.lang.String segment)
Returns the pat
|
MergeInfo |
getMergeInfo() |
java.lang.String |
getMethod() |
OptionsInfo |
getOptionsInfo() |
java.lang.String |
getOrderingType() |
OrderPatch |
getOrderPatch() |
java.lang.String |
getParameter(java.lang.String s) |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameterMap() |
java.util.Enumeration<java.lang.String> |
getParameterNames() |
java.lang.String[] |
getParameterValues(java.lang.String s) |
javax.servlet.http.Part |
getPart(java.lang.String p) |
java.util.Collection<javax.servlet.http.Part> |
getParts() |
java.lang.String |
getPathInfo() |
java.lang.String |
getPathTranslated() |
long |
getPollTimeout() |
Position |
getPosition() |
DavPropertyNameSet |
getPropFindProperties()
Returns the set of properties requested by the PROPFIND body or an
empty set if the
type is either 'allprop' or
'propname'. |
int |
getPropFindType()
Returns the type of PROPFIND as indicated by the request body.
|
java.util.List<? extends PropEntry> |
getPropPatchChangeList()
Return a
List of property change operations. |
java.lang.String |
getProtocol() |
java.lang.String |
getQueryString() |
java.io.BufferedReader |
getReader() |
java.lang.String |
getRealPath(java.lang.String s)
Deprecated.
|
RebindInfo |
getRebindInfo() |
java.lang.String |
getRemoteAddr() |
java.lang.String |
getRemoteHost() |
int |
getRemotePort() |
java.lang.String |
getRemoteUser() |
ReportInfo |
getReportInfo() |
RequestDispatcher |
getRequestDispatcher(java.lang.String s) |
org.w3c.dom.Document |
getRequestDocument() |
java.lang.String |
getRequestedSessionId() |
DavResourceLocator |
getRequestLocator()
Return a
DavResourceLocator representing the request handle. |
java.lang.String |
getRequestURI() |
java.lang.StringBuffer |
getRequestURL() |
java.lang.String |
getScheme() |
java.lang.String |
getServerName() |
int |
getServerPort() |
ServletContext |
getServletContext() |
java.lang.String |
getServletPath() |
HttpSession |
getSession() |
HttpSession |
getSession(boolean b) |
java.lang.String |
getSubscriptionId() |
SubscriptionInfo |
getSubscriptionInfo() |
long |
getTimeout()
Parse the Timeout header and return a long representing the value.
|
java.lang.String |
getTransactionId() |
TransactionInfo |
getTransactionInfo() |
UnbindInfo |
getUnbindInfo() |
UpdateInfo |
getUpdateInfo() |
java.security.Principal |
getUserPrincipal() |
boolean |
isAsyncStarted() |
boolean |
isAsyncSupported() |
boolean |
isOverwrite()
Return true if the overwrite header does not inhibit overwriting.
|
boolean |
isRequestedSessionIdFromCookie() |
boolean |
isRequestedSessionIdFromUrl()
Deprecated.
|
boolean |
isRequestedSessionIdFromURL() |
boolean |
isRequestedSessionIdValid() |
boolean |
isSecure() |
boolean |
isUserInRole(java.lang.String s) |
void |
login(java.lang.String u,
java.lang.String p) |
void |
logout() |
boolean |
matchesIfHeader(DavResource resource)
Test if the if header matches the given resource.
|
boolean |
matchesIfHeader(java.lang.String href,
java.lang.String token,
java.lang.String eTag) |
void |
removeAttribute(java.lang.String s) |
void |
setAttribute(java.lang.String s,
java.lang.Object o) |
void |
setCharacterEncoding(java.lang.String s) |
void |
setDavSession(DavSession session)
Sets the session field and adds all lock tokens present with either the
Lock-Token header or the If header to the given session object.
|
AsyncContext |
startAsync() |
AsyncContext |
startAsync(ServletRequest req,
ServletResponse res) |
<T extends HttpUpgradeHandler> |
upgrade(java.lang.Class<T> handlerClass) |
public STDavRequest(HttpServletRequest httpRequest, DavLocatorFactory factory)
DavServletRequest
with the given parameters.httpRequest
- factory
- public STDavRequest(HttpServletRequest httpRequest, DavLocatorFactory factory, boolean createAbsoluteURI)
DavServletRequest
with the given parameters.httpRequest
- factory
- createAbsoluteURI
- defines if we must create a absolute URI. if false a absolute path will be createdpublic void logout()
public void login(java.lang.String u, java.lang.String p)
public boolean isAsyncSupported()
public boolean isAsyncStarted()
public AsyncContext startAsync(ServletRequest req, ServletResponse res)
public AsyncContext startAsync()
public ServletContext getServletContext()
public <T extends HttpUpgradeHandler> T upgrade(java.lang.Class<T> handlerClass)
public boolean authenticate(javax.servlet.http.HttpServletResponse r) throws java.io.IOException, ServletException
java.io.IOException
ServletException
public DispatcherType getDispatcherType()
public AsyncContext getAsyncContext()
public java.util.Collection<javax.servlet.http.Part> getParts() throws java.io.IOException, ServletException
java.io.IOException
ServletException
public javax.servlet.http.Part getPart(java.lang.String p) throws java.io.IOException, ServletException
java.io.IOException
ServletException
public void setDavSession(DavSession session)
session
- DavServletRequest#setDavSession(DavSession)
public DavSession getDavSession()
DavServletRequest#getDavSession()
public DavResourceLocator getRequestLocator()
DavResourceLocator
representing the request handle.DavServletRequest#getRequestLocator()
public DavResourceLocator getDestinationLocator() throws DavException
DavException
#HEADER_DESTINATION
,
DavServletRequest#getDestinationLocator
public DavResourceLocator getHrefLocator(java.lang.String href) throws DavException
href
- org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.bind.BindServletRequest#getHrefLocator
public DavResourceLocator getMemberLocator(java.lang.String segment)
segment
- of the member resource of the request resource which is identified by the segment parameter.public boolean isOverwrite()
#HEADER_OVERWRITE
,
DavServletRequest#isOverwrite()
public int getDepth(int defaultValue)
defaultValue
- DavServletRequest#getDepth(int)
public int getDepth()
DavServletRequest#getDepth()
public long getTimeout()
#UNDEFINED_TIMEOUT
is used as default value if no header
is available or if the parsing fails.DavServletRequest#getTimeout()
,
TimeoutHeader#parse(javax.servlet.http.HttpServletRequest, long)
public java.lang.String getLockToken()
java.lang.IllegalArgumentException
- If the value has not the correct format.#HEADER_LOCK_TOKEN
,
DavServletRequest#getLockToken()
public org.w3c.dom.Document getRequestDocument() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
DavServletRequest#getRequestDocument()
public int getPropFindType() throws DavException
org.apache.jackrabbit.webdav.DavException@throws
- org.apache.jackrabbit.webdav.DavExceptionPROPFIND_ALL_PROP allprops}DavException
DavServletRequest#getPropFindType()
public DavPropertyNameSet getPropFindProperties() throws DavException
type
is either 'allprop' or
'propname'.org.apache.jackrabbit.webdav.DavException
DavException
DavServletRequest#getPropFindProperties()
public java.util.List<? extends PropEntry> getPropPatchChangeList() throws DavException
List
of property change operations. Each entry
is either of type DavPropertyName
, indicating a <remove>
operation, or of type DavProperty
, indicating a <set>
operation. Note that ordering is significant here.org.apache.jackrabbit.webdav.DavException
DavException
DavServletRequest#getPropPatchChangeList()
public LockInfo getLockInfo() throws DavException
LockInfo
object encapsulating the information passed with a LOCK
request if the LOCK request body was valid. If the request body is
missing a 'refresh lock' request is assumed. The LockInfo
then only provides timeout and isDeep property and returns true on
org.apache.jackrabbit.webdav.lock.LockInfo#isRefreshLock()
null
if an error occurred while
parsing the request body.DavException
- throws a 400 (Bad Request) DavException if a request
body is present but does not start with a DAV:lockinfo element. Note however,
that a non-existing request body is a valid request used to refresh
an existing lock.DavServletRequest#getLockInfo()
public boolean matchesIfHeader(DavResource resource)
resource href
and the token returned from an exclusive write lock present on
the resource.null
or if
the resource has not applied an exclusive write lock the preconditions are met.
If in contrast the lock applied to the given resource returns a
null
lock token (e.g. for security reasons) or a lock token
that does not match, the method will return false.resource
- Webdav resources being operated onDavServletRequest#matchesIfHeader(DavResource)
,
IfHeader#matches(String, String, String)
,
DavResource#hasLock(org.apache.jackrabbit.webdav.lock.Type, org.apache.jackrabbit.webdav.lock.Scope)
,
org.apache.jackrabbit.webdav.lock.ActiveLock#getToken()
public boolean matchesIfHeader(java.lang.String href, java.lang.String token, java.lang.String eTag)
href
- token
- The tokeneTag
- DavServletRequest#matchesIfHeader(String, String, String)
,
IfHeader#matches(String, String, String)
public java.lang.String getTransactionId()
org.apache.jackrabbit.webdav.transaction.TransactionDavServletRequest#getTransactionId()
public TransactionInfo getTransactionInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.transaction.TransactionDavServletRequest#getTransactionInfo()
public java.lang.String getSubscriptionId()
org.apache.jackrabbit.webdav.observation.ObservationDavServletRequest#getSubscriptionId()
public long getPollTimeout()
org.apache.jackrabbit.webdav.observation.ObservationDavServletRequest#getPollTimeout()
public SubscriptionInfo getSubscriptionInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.observation.ObservationDavServletRequest#getSubscriptionInfo()
public java.lang.String getOrderingType()
org.apache.jackrabbit.webdav.ordering.OrderingDavServletRequest#getOrderingType()
public Position getPosition()
org.apache.jackrabbit.webdav.ordering.OrderingDavServletRequest#getPosition()
public OrderPatch getOrderPatch() throws DavException
OrderPatch
object representing the order patch request
body or null
if theorg.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.ordering.OrderingDavServletRequest#getOrderPatch()
public java.lang.String getLabel()
org.apache.jackrabbit.webdav.version.DeltaVServletRequest#getLabel()
public LabelInfo getLabelInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.version.DeltaVServletRequest#getLabelInfo()
public MergeInfo getMergeInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.version.DeltaVServletRequest#getMergeInfo()
public UpdateInfo getUpdateInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.version.DeltaVServletRequest#getUpdateInfo()
public ReportInfo getReportInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.version.DeltaVServletRequest#getReportInfo()
public OptionsInfo getOptionsInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.version.DeltaVServletRequest#getOptionsInfo()
public RebindInfo getRebindInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.bind.BindServletRequest#getRebindInfo()
public UnbindInfo getUnbindInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.bind.BindServletRequest#getUnbindInfo()
public BindInfo getBindInfo() throws DavException
org.apache.jackrabbit.webdav.DavException
DavException
org.apache.jackrabbit.webdav.bind.BindServletRequest#getBindInfo()
public java.lang.String getAuthType()
public Cookie[] getCookies()
public long getDateHeader(java.lang.String s)
public java.lang.String getHeader(java.lang.String s)
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String s)
public java.util.Enumeration<java.lang.String> getHeaderNames()
public int getIntHeader(java.lang.String s)
public java.lang.String getMethod()
public java.lang.String getPathInfo()
public java.lang.String getPathTranslated()
public java.lang.String getContextPath()
public java.lang.String getQueryString()
public java.lang.String getRemoteUser()
public boolean isUserInRole(java.lang.String s)
public java.security.Principal getUserPrincipal()
public java.lang.String getRequestedSessionId()
public java.lang.String getRequestURI()
public java.lang.StringBuffer getRequestURL()
public java.lang.String getServletPath()
public HttpSession getSession(boolean b)
public HttpSession getSession()
public boolean isRequestedSessionIdValid()
public boolean isRequestedSessionIdFromCookie()
public boolean isRequestedSessionIdFromURL()
public boolean isRequestedSessionIdFromUrl()
public java.lang.Object getAttribute(java.lang.String s)
public java.util.Enumeration<java.lang.String> getAttributeNames()
public java.lang.String getCharacterEncoding()
public void setCharacterEncoding(java.lang.String s) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public int getContentLength()
public java.lang.String getContentType()
public ServletInputStream getInputStream() throws java.io.IOException
java.io.IOException
public java.lang.String getParameter(java.lang.String s)
public java.util.Enumeration<java.lang.String> getParameterNames()
public java.lang.String[] getParameterValues(java.lang.String s)
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
public java.lang.String getProtocol()
public java.lang.String getScheme()
public java.lang.String getServerName()
public int getServerPort()
public java.io.BufferedReader getReader() throws java.io.IOException
java.io.IOException
public java.lang.String getRemoteAddr()
public java.lang.String getRemoteHost()
public void setAttribute(java.lang.String s, java.lang.Object o)
public void removeAttribute(java.lang.String s)
public java.util.Locale getLocale()
public java.util.Enumeration<java.util.Locale> getLocales()
public boolean isSecure()
public RequestDispatcher getRequestDispatcher(java.lang.String s)
public java.lang.String getRealPath(java.lang.String s)
s
- public int getRemotePort()
public java.lang.String getLocalName()
public java.lang.String getLocalAddr()
public int getLocalPort()
public java.lang.String changeSessionId()
public long getContentLengthLong()
stSoftware Copyright © 2001-2014 stSoftware All Rights Reserved.