com.github.crob1140.confluence.requests

Class ConfluenceRequest

java.lang.Object

com.github.crob1140.confluence.requests.ConfluenceRequest

Direct Known Subclasses:

CreateContentRequest, GetContentRequest, UpdateContentRequest

public abstract class ConfluenceRequest
extends java.lang.Object

This class represents a HTTP request performed against the Confluence REST API

Constructor Summary

Constructors

Constructor and Description
ConfluenceRequest()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.MediaType	getAcceptedResponseType() This method returns the media type that is expected for the response.
abstract java.util.Optional<java.lang.Object>	getBodyEntity() This method returns the entity that is sent in the body of the request.
javax.ws.rs.core.MediaType	getContentType() This method returns the content type of this request.
abstract java.lang.String	getMethod() This method returns the HTTP method used by this request.
abstract java.util.Map<java.lang.String,java.lang.String>	getQueryParams() This method returns the query parameters for this request.
abstract java.lang.String	getRelativePath() This method returns the path of the request relative to the Confluence wiki root.
abstract java.lang.Class<?>	getReturnType() This method returns the class of the object in the body of the response for this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceRequest

public ConfluenceRequest()

Method Detail

getRelativePath

public abstract java.lang.String getRelativePath()

This method returns the path of the request relative to the Confluence wiki root.

Returns:

The path of the request relative to the Confluence wiki root.

getMethod

public abstract java.lang.String getMethod()

This method returns the HTTP method used by this request.

Returns:

the HTTP method used by this request.

getQueryParams

public abstract java.util.Map<java.lang.String,java.lang.String> getQueryParams()

This method returns the query parameters for this request.

Returns:

The query parameters for this request.

getBodyEntity

public abstract java.util.Optional<java.lang.Object> getBodyEntity()

This method returns the entity that is sent in the body of the request.

Returns:

The entity that is sent in the body of the request.

getContentType

public javax.ws.rs.core.MediaType getContentType()

This method returns the content type of this request.

Returns:

The content type accepted by this request.

getAcceptedResponseType

public javax.ws.rs.core.MediaType getAcceptedResponseType()

This method returns the media type that is expected for the response.

Returns:

The media type that is expected for the response.

getReturnType

public abstract java.lang.Class<?> getReturnType()

This method returns the class of the object in the body of the response for this request.

Returns:

The class of the object in the body of response for this request.