|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.webdav.lib.methods.WebdavMethodBase
WebDAV method abstract implementation.
Field Summary | |
protected int |
debug
Debug. |
protected java.util.Hashtable |
headers
Headers. |
protected java.lang.String |
name
Method name. |
protected java.util.Hashtable |
parameters
URL parameters. |
protected java.lang.String |
path
Server path. |
protected java.lang.String |
query
|
protected java.lang.String |
queryString
|
protected State |
state
Global state. |
protected int |
statusCode
Status code. |
protected java.lang.String |
statusText
Status text. |
Fields inherited from interface org.apache.webdav.lib.methods.WebdavMethod |
PROTOCOL |
Constructor Summary | |
WebdavMethodBase()
Method constructor. |
|
WebdavMethodBase(java.lang.String path)
Method constructor. |
Method Summary | |
protected void |
checkNotUsed()
Check if the method has been executed, and throws an IllegalStateException otherwise. |
protected void |
checkUsed()
Check if the method has been executed, and throws an IllegalStateException otherwise. |
boolean |
followRedirects()
True if this methods should automatically follow redirects. |
void |
generateHeaders(State state)
Deprecated. this method is deprecated in favour of the generateHeaders(String, State) method. |
void |
generateHeaders(java.lang.String host,
State state)
Generate additional headers needed by the request. |
java.lang.String |
generateQuery()
Generate the query body. |
java.lang.String |
generateRequestLine()
Generate the HTTP request line. |
Header |
getHeader(java.lang.String headerName)
Get header. |
java.util.Enumeration |
getHeaders()
Get headers. |
java.lang.String |
getName()
Name property getter. |
java.lang.String |
getPath()
Path property getter. |
int |
getStatusCode()
Status code property getter. |
java.lang.String |
getStatusText()
Status text property getter. |
boolean |
hasBeenUsed()
Checks if this method's instance has already been used, and has not been recycled. |
boolean |
isStreamedQuery()
Is the query body submitted through an InputStream of with a String. |
boolean |
needContentLength()
Return true if the method needs a content-length header in the request. |
abstract void |
parseResponse(java.io.InputStream is)
Parse response. |
void |
processResponseHeaders(java.util.Hashtable headers)
Process response headers. |
void |
recycle()
Recycle the method object, so that it can be reused again. |
void |
removeHeader(java.lang.String headerName)
Remove header. |
void |
setDebug(int debug)
Debug property setter. |
void |
setHeader(java.lang.String headerName,
java.lang.String headerValue)
Set header. |
void |
setParameter(java.lang.String parameterName,
java.lang.String parameterValue)
Set URL parameter. |
void |
setPath(java.lang.String path)
Path property setter. |
void |
setQuery(java.lang.String query)
Set the query String as a XML document. |
void |
setQueryString(java.lang.String queryString)
Set query string. |
void |
setState(State state)
Set the state token. |
void |
setStatusCode(int statusCode)
Status code property setter. |
void |
setStatusText(java.lang.String statusText)
Status text property setter. |
void |
setUsed()
Set the method as used. |
void |
streamQuery(java.io.OutputStream out)
Stream the body of the query. |
boolean |
validate()
Ensures the correctness of the request according to criterions which are method dependent. |
Methods inherited from class java.lang.Object |
|
Field Detail |
protected int debug
protected int statusCode
protected java.lang.String statusText
protected java.lang.String path
protected java.lang.String name
protected java.util.Hashtable headers
protected java.util.Hashtable parameters
protected State state
protected java.lang.String query
protected java.lang.String queryString
Constructor Detail |
public WebdavMethodBase()
public WebdavMethodBase(java.lang.String path)
Method Detail |
public void setDebug(int debug)
setDebug
in interface WebdavMethod
int
- Debugpublic void setStatusCode(int statusCode)
setStatusCode
in interface WebdavMethod
int
- Status codepublic int getStatusCode()
getStatusCode
in interface WebdavMethod
public void setStatusText(java.lang.String statusText)
setStatusText
in interface WebdavMethod
statusText
- Status textpublic java.lang.String getStatusText()
getStatusText
in interface WebdavMethod
public void setPath(java.lang.String path)
setPath
in interface WebdavMethod
path
- Absolute pathpublic java.lang.String getPath()
getPath
in interface WebdavMethod
public java.lang.String getName()
getName
in interface WebdavMethod
public void setHeader(java.lang.String headerName, java.lang.String headerValue)
setHeader
in interface WebdavMethod
headerName
- Header nameheaderValue
- Header valuepublic Header getHeader(java.lang.String headerName)
getHeader
in interface WebdavMethod
headerName
- Header namepublic void removeHeader(java.lang.String headerName)
removeHeader
in interface WebdavMethod
headerName
- Header namepublic final boolean hasBeenUsed()
hasBeenUsed
in interface WebdavMethod
public boolean followRedirects()
followRedirects
in interface WebdavMethod
public void setState(State state)
setState
in interface WebdavMethod
public void setParameter(java.lang.String parameterName, java.lang.String parameterValue)
setParameter
in interface WebdavMethod
parameterName
- Parameter nameparameterValue
- Parameter valuepublic void setQueryString(java.lang.String queryString)
setQueryString
in interface WebdavMethod
queryString
- Query stringpublic void setUsed()
setUsed
in interface WebdavMethod
public boolean validate()
validate
in interface WebdavMethod
public void recycle()
recycle
in interface WebdavMethod
public java.util.Enumeration getHeaders()
getHeaders
in interface WebdavMethod
public void generateHeaders(State state)
generateHeaders(String, State)
method.
state
- State tokenpublic void generateHeaders(java.lang.String host, State state)
generateHeaders
in interface WebdavMethod
host
- the hoststate
- State tokenpublic boolean isStreamedQuery()
isStreamedQuery
in interface WebdavMethod
public void setQuery(java.lang.String query)
setQuery
in interface WebdavMethod
public java.lang.String generateQuery()
generateQuery
in interface WebdavMethod
public void streamQuery(java.io.OutputStream out) throws java.io.IOException
streamQuery
in interface WebdavMethod
public void processResponseHeaders(java.util.Hashtable headers)
processResponseHeaders
in interface WebdavMethod
headers
- Headers listpublic abstract void parseResponse(java.io.InputStream is) throws java.io.IOException, WebdavException
parseResponse
in interface WebdavMethod
is
- Input streampublic final java.lang.String generateRequestLine()
generateRequestLine
in interface WebdavMethod
public boolean needContentLength()
needContentLength
in interface WebdavMethod
protected void checkUsed()
protected void checkNotUsed()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |