HttpSubscribe (The Adobe Experience Manager SDK 2022.11.9850.20221116T162329Z-220900)

java.lang.Object
- org.apache.http.message.AbstractHttpMessage
- - org.apache.http.client.methods.AbstractExecutionAwareRequest
  - - org.apache.http.client.methods.HttpRequestBase
    - - org.apache.http.client.methods.HttpEntityEnclosingRequestBase
      - org.apache.jackrabbit.webdav.client.methods.BaseDavRequest
        
        org.apache.jackrabbit.webdav.client.methods.HttpSubscribe

All Implemented Interfaces:

java.lang.Cloneable, AbortableHttpRequest, Configurable, HttpExecutionAware, HttpUriRequest, HttpEntityEnclosingRequest, HttpMessage, HttpRequest
```
public class HttpSubscribe
extends BaseDavRequest
```
Represents an HTTP SUBSCRIBE request.
Note that "SUBSCRIBE" is a custom HTTP extension, not defined in a standards paper.

Since:

2.13.6

Constructor Summary

Constructors
Constructor	Description
`HttpSubscribe(java.lang.String uri, SubscriptionInfo info, java.lang.String subscriptionId)`
`HttpSubscribe(java.net.URI uri, SubscriptionInfo info, java.lang.String subscriptionId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getMethod()`	Returns the HTTP method this request uses, such as `GET`, `PUT`, `POST`, or other.
`java.lang.String`	`getSubscriptionId(HttpResponse response)`
`boolean`	`succeeded(HttpResponse response)`	Check the provided `HttpResponse` for successful execution.

Methods inherited from class org.apache.jackrabbit.webdav.client.methods.BaseDavRequest
checkSuccess, getResponseBodyAsDocument, getResponseBodyAsEventDiscovery, getResponseBodyAsLockDiscovery, getResponseBodyAsMultiStatus, getResponseBodyAsSubscriptionDiscovery, getResponseException

Methods inherited from class org.apache.http.client.methods.HttpEntityEnclosingRequestBase
clone, expectContinue, getEntity, setEntity

Methods inherited from class org.apache.http.client.methods.HttpRequestBase
getConfig, getProtocolVersion, getRequestLine, getURI, releaseConnection, setConfig, setProtocolVersion, setURI, started, toString

Methods inherited from class org.apache.http.client.methods.AbstractExecutionAwareRequest
abort, completed, isAborted, reset, setCancellable, setConnectionRequest, setReleaseTrigger

Methods inherited from class org.apache.http.message.AbstractHttpMessage
addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.http.HttpMessage
addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, getProtocolVersion, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

Methods inherited from interface org.apache.http.HttpRequest
getRequestLine

Methods inherited from interface org.apache.http.client.methods.HttpUriRequest
abort, isAborted

- Constructor Detail
  - HttpSubscribe
```
public HttpSubscribe(java.net.URI uri,
                     SubscriptionInfo info,
                     java.lang.String subscriptionId)
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - HttpSubscribe
```
public HttpSubscribe(java.lang.String uri,
                     SubscriptionInfo info,
                     java.lang.String subscriptionId)
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - getSubscriptionId
```
public java.lang.String getSubscriptionId(HttpResponse response)
```
  - getMethod
```
public java.lang.String getMethod()
```
    Description copied from interface: HttpUriRequest
    
    Returns the HTTP method this request uses, such as GET, PUT, POST, or other.
    
    Specified by:
    
    getMethod in interface HttpUriRequest
    
    Specified by:
    
    getMethod in class HttpRequestBase
  - succeeded
```
public boolean succeeded(HttpResponse response)
```
    Description copied from class: BaseDavRequest
    
    Check the provided HttpResponse for successful execution. The default implementation treats all 2xx status codes (RFC 7231, Section 6.3). Implementations can further restrict the accepted range of responses (or even check the response body).
    
    Overrides:
    
    succeeded in class BaseDavRequest