org.apache.webdav.lib.methods

Class SubscribeMethod

java.lang.Object

org.apache.commons.httpclient.HttpMethodBase

org.apache.webdav.lib.methods.HttpRequestBodyMethodBase

org.apache.webdav.lib.methods.XMLResponseMethodBase

org.apache.webdav.lib.methods.SubscribeMethod

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod, DepthSupport

public class SubscribeMethod
extends XMLResponseMethodBase
implements DepthSupport

Implements the SUBSCRIBE method.

See Also:

Reference

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

XMLResponseMethodBase.OptionsResponse, XMLResponseMethodBase.Response, XMLResponseMethodBase.ResponseWithinMultistatus, XMLResponseMethodBase.SingleResponse

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_DELETE
static java.lang.String	TYPE_MOVE
static java.lang.String	TYPE_UPDATE
static java.lang.String	TYPE_UPDATE_NEW_MEMBER

Fields inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

builder, decodeResponseHrefs, responseURLs

Fields inherited from class org.apache.commons.httpclient.HttpMethodBase

effectiveVersion, statusLine

Fields inherited from interface org.apache.webdav.lib.methods.DepthSupport

DEPTH_0, DEPTH_1, DEPTH_INFINITY

Constructor Summary

Constructors

Constructor and Description
SubscribeMethod()
SubscribeMethod(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
protected void	addRequestHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)
java.lang.String	getCallback()
int	getDepth() Depth getter.
java.lang.String	getName()
long	getNotificationDelay()
java.lang.String	getNotificationType()
java.lang.String	getResponsedContentLocation() Returns the value of the content-location header of the response.
int	getResponsedSubscriptionId() Returns the subscription ID responsed from the server.
long	getResponsedSubscriptionLifetime() Returns the subscription lifetime responsed from the server.
long	getSubsciptionLifetime()
long	getSubscriptionId()
protected void	processResponseHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)
void	recycle() Reset the State of the class to its initial state, so that it can be used again.
void	setCallback(java.lang.String callback) Sets the URI that's to be notified if the subscribed event does occur.
void	setDepth(int depth) Sets the depth.
void	setNotificationDelay(long delay) Sets the notification delay in seconds.
void	setNotificationType(java.lang.String notificationType) Sets the notification type, i.e.
void	setRequestHeader(java.lang.String headerName, java.lang.String headerValue) Adds special checking of header values of the SUBSCRIBE method to the super class implementation.
void	setSubsciptionLifetime(long subsciptionLifetime) Sets the duration of the subscription in seconds.
void	setSubscriptionId(int subscriptionId) Sets the ID of a subscription to be refreshed.

Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

convertElementToProperty, generateRequestBody, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponses, getResponseURLs, parseResponse, parseXMLResponse, readResponseBody, setDebug, setDecodeResponseHrefs, setDocument, setResponseHashtable, writeRequestBody

Methods inherited from class org.apache.webdav.lib.methods.HttpRequestBodyMethodBase

isRequestContentAlreadySet, readContinueCode, setRequestBody, setRequestBody, setRequestBody, setRequestBody, setRequestBody

Methods inherited from class org.apache.commons.httpclient.HttpMethodBase

abort, addCookieRequestHeader, addHostRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getEffectiveVersion, getFollowRedirects, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getPath, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, getRequestCharSet, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isHttp11, isRequestSent, isStrictMode, processCookieHeaders, processResponseBody, processStatusLine, readResponse, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setResponseStream, setStrictMode, setURI, shouldCloseConnection, validate, writeRequest, writeRequestHeaders, writeRequestLine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_UPDATE

public static final java.lang.String TYPE_UPDATE

See Also:

Constant Field Values

TYPE_UPDATE_NEW_MEMBER

public static final java.lang.String TYPE_UPDATE_NEW_MEMBER

See Also:

Constant Field Values

TYPE_DELETE

public static final java.lang.String TYPE_DELETE

See Also:

Constant Field Values

TYPE_MOVE

public static final java.lang.String TYPE_MOVE

See Also:

Constant Field Values

Constructor Detail

SubscribeMethod

public SubscribeMethod()

SubscribeMethod

public SubscribeMethod(java.lang.String path)

Method Detail

getCallback

public java.lang.String getCallback()

setCallback

public void setCallback(java.lang.String callback)

Sets the URI that's to be notified if the subscribed event does occur.

getNotificationType

public java.lang.String getNotificationType()

setNotificationType

public void setNotificationType(java.lang.String notificationType)

Sets the notification type, i.e. determines the events that are subscribed.

See Also:

TYPE_DELETE, TYPE_MOVE, TYPE_UPDATE, TYPE_UPDATE_NEW_MEMBER

getSubsciptionLifetime

public long getSubsciptionLifetime()

setSubsciptionLifetime

public void setSubsciptionLifetime(long subsciptionLifetime)

Sets the duration of the subscription in seconds.

getSubscriptionId

public long getSubscriptionId()

setSubscriptionId

public void setSubscriptionId(int subscriptionId)

Sets the ID of a subscription to be refreshed.

Parameters:

subscriptionId -

setNotificationDelay

public void setNotificationDelay(long delay)

Sets the notification delay in seconds.

getNotificationDelay

public long getNotificationDelay()

getDepth

public int getDepth()

Description copied from interface: DepthSupport

Depth getter.

Specified by:

getDepth in interface DepthSupport

Returns:

int depth value

setDepth

public void setDepth(int depth)

Sets the depth.

Specified by:

setDepth in interface DepthSupport

Parameters:

depth - New depth value

getResponsedSubscriptionId

public int getResponsedSubscriptionId()

Returns the subscription ID responsed from the server.

Returns:

-1 if no subscription id was in the response

getResponsedSubscriptionLifetime

public long getResponsedSubscriptionLifetime()

Returns the subscription lifetime responsed from the server.

Returns:

-1 if no subscription lifetime was given in the response

getResponsedContentLocation

public java.lang.String getResponsedContentLocation()

Returns the value of the content-location header of the response. This shall be used to the request uri for a POLL method querying this subscription.

getName

public java.lang.String getName()

Specified by:

getName in interface org.apache.commons.httpclient.HttpMethod

Specified by:

getName in class org.apache.commons.httpclient.HttpMethodBase

recycle

public void recycle()

Description copied from class: XMLResponseMethodBase

Reset the State of the class to its initial state, so that it can be used again.

Specified by:

recycle in interface org.apache.commons.httpclient.HttpMethod

Overrides:

recycle in class XMLResponseMethodBase

addRequestHeaders

protected void addRequestHeaders(org.apache.commons.httpclient.HttpState state,
                                 org.apache.commons.httpclient.HttpConnection conn)
                          throws java.io.IOException,
                                 org.apache.commons.httpclient.HttpException

Overrides:

addRequestHeaders in class org.apache.commons.httpclient.HttpMethodBase

Throws:

java.io.IOException

org.apache.commons.httpclient.HttpException

setRequestHeader

public void setRequestHeader(java.lang.String headerName,
                             java.lang.String headerValue)

Adds special checking of header values of the SUBSCRIBE method to the super class implementation.

Specified by:

setRequestHeader in interface org.apache.commons.httpclient.HttpMethod

Overrides:

setRequestHeader in class org.apache.commons.httpclient.HttpMethodBase

processResponseHeaders

protected void processResponseHeaders(org.apache.commons.httpclient.HttpState state,
                                      org.apache.commons.httpclient.HttpConnection conn)

Overrides:

processResponseHeaders in class org.apache.commons.httpclient.HttpMethodBase