Package com.adobe.pdfservices.operation.internal.http

Class BaseHttpRequest

java.lang.Object

com.adobe.pdfservices.operation.internal.http.BaseHttpRequest

All Implemented Interfaces:

HttpRequest

public class BaseHttpRequest
extends Object
implements HttpRequest

Constructor Summary

Constructors

Constructor	Description
BaseHttpRequest(HttpMethod httpMethod)
BaseHttpRequest(String requestKey, HttpMethod httpMethod, String uriTemplate)

Method Summary

Modifier and Type	Method	Description
void	authenticate()	Gets an access token from the authenticator configured with a request and adds it as an authorization header
void	forceAuthenticate()	Refreshes the access token via the authenticator configured with a request and adds it as an authorization header
Authenticator	getAuthenticator()
AuthenticationMethod	getAuthMethod()
HttpRequestConfig	getConfig()
org.apache.http.entity.StringEntity	getEntity()
String	getFinalUri()
Map<String,String>	getHeaders()
HttpMethod	getHttpMethod()
RequestKey	getRequestKey()
RequestType	getRequestType()
String	getTemplateString()
HttpRequest	withAcceptType(String acceptHeader)
HttpRequest	withAuthenticationMethod(AuthenticationMethod authMethod)
HttpRequest	withAuthenticator(Authenticator authenticator)	Attaches an authenticator instance to the class, which will be used for all access token operations
HttpRequest	withBody(String body)
HttpRequest	withConfig(HttpRequestConfig requestConfig)
HttpRequest	withContentType(String contentType)
HttpRequest	withHeader(String headerName, String headerValue)
HttpRequest	withHeaders(Map<String,String> headers)	Will overwrite headers as well
HttpRequest	withRequestKey(RequestKey requestKey)
HttpRequest	withTemplate(String uriTemplate)
HttpRequest	withUriParam(String name, String value)
HttpRequest	withUrlEncodedFormParams(List<org.apache.http.NameValuePair> formParams)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseHttpRequest

public BaseHttpRequest(String requestKey,
                       HttpMethod httpMethod,
                       String uriTemplate)

BaseHttpRequest

public BaseHttpRequest(HttpMethod httpMethod)

Method Detail

withContentType

public HttpRequest withContentType(String contentType)

Specified by:

withContentType in interface HttpRequest

withHeader

public HttpRequest withHeader(String headerName,
                              String headerValue)

Specified by:

withHeader in interface HttpRequest

withHeaders

public HttpRequest withHeaders(Map<String,String> headers)

Will overwrite headers as well

Specified by:

withHeaders in interface HttpRequest

Parameters:

headers -

Returns:

withUriParam

public HttpRequest withUriParam(String name,
                                String value)

Specified by:

withUriParam in interface HttpRequest

withUrlEncodedFormParams

public HttpRequest withUrlEncodedFormParams(List<org.apache.http.NameValuePair> formParams)

Specified by:

withUrlEncodedFormParams in interface HttpRequest

withBody

public HttpRequest withBody(String body)

Specified by:

withBody in interface HttpRequest

withAuthenticationMethod

public HttpRequest withAuthenticationMethod(AuthenticationMethod authMethod)

Specified by:

withAuthenticationMethod in interface HttpRequest

withAuthenticator

public HttpRequest withAuthenticator(Authenticator authenticator)

Description copied from interface: HttpRequest

Attaches an authenticator instance to the class, which will be used for all access token operations

Specified by:

withAuthenticator in interface HttpRequest

Returns:

withConfig

public HttpRequest withConfig(HttpRequestConfig requestConfig)

Specified by:

withConfig in interface HttpRequest

withRequestKey

public HttpRequest withRequestKey(RequestKey requestKey)

Specified by:

withRequestKey in interface HttpRequest

authenticate

public void authenticate()

Description copied from interface: HttpRequest

Gets an access token from the authenticator configured with a request and adds it as an authorization header

Specified by:

authenticate in interface HttpRequest

forceAuthenticate

public void forceAuthenticate()

Description copied from interface: HttpRequest

Refreshes the access token via the authenticator configured with a request and adds it as an authorization header

Specified by:

forceAuthenticate in interface HttpRequest

getConfig

public HttpRequestConfig getConfig()

Specified by:

getConfig in interface HttpRequest

withTemplate

public HttpRequest withTemplate(String uriTemplate)

Specified by:

withTemplate in interface HttpRequest

withAcceptType

public HttpRequest withAcceptType(String acceptHeader)

Specified by:

withAcceptType in interface HttpRequest

getEntity

public org.apache.http.entity.StringEntity getEntity()

Specified by:

getEntity in interface HttpRequest

getHttpMethod

public HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface HttpRequest

getAuthMethod

public AuthenticationMethod getAuthMethod()

Specified by:

getAuthMethod in interface HttpRequest

getHeaders

public Map<String,String> getHeaders()

Specified by:

getHeaders in interface HttpRequest

getFinalUri

public String getFinalUri()

Specified by:

getFinalUri in interface HttpRequest

getTemplateString

public String getTemplateString()

Specified by:

getTemplateString in interface HttpRequest

getRequestType

public RequestType getRequestType()

Specified by:

getRequestType in interface HttpRequest

getAuthenticator

public Authenticator getAuthenticator()

Specified by:

getAuthenticator in interface HttpRequest

getRequestKey

public RequestKey getRequestKey()

Specified by:

getRequestKey in interface HttpRequest