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

Interface HttpRequest

All Known Subinterfaces:

MultiPartRequest

All Known Implementing Classes:

BaseHttpRequest, BaseMultipartRequest

public interface HttpRequest

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)
HttpRequest	withRequestKey(RequestKey requestKey)
HttpRequest	withTemplate(String uriTemplate)
HttpRequest	withUriParam(String name, String value)
HttpRequest	withUrlEncodedFormParams(List<org.apache.http.NameValuePair> formParams)

Method Detail

withTemplate

HttpRequest withTemplate(String uriTemplate)

withContentType

HttpRequest withContentType(String contentType)

withAcceptType

HttpRequest withAcceptType(String acceptHeader)

withHeader

HttpRequest withHeader(String headerName,
                       String headerValue)

withHeaders

HttpRequest withHeaders(Map<String,String> headers)

withUriParam

HttpRequest withUriParam(String name,
                         String value)

withUrlEncodedFormParams

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

withBody

HttpRequest withBody(String body)

withAuthenticationMethod

HttpRequest withAuthenticationMethod(AuthenticationMethod authMethod)

withAuthenticator

HttpRequest withAuthenticator(Authenticator authenticator)

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

Parameters:

authenticator -

Returns:

withConfig

HttpRequest withConfig(HttpRequestConfig requestConfig)

withRequestKey

HttpRequest withRequestKey(RequestKey requestKey)

authenticate

void authenticate()

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

forceAuthenticate

void forceAuthenticate()

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

getConfig

HttpRequestConfig getConfig()

getEntity

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

getHttpMethod

HttpMethod getHttpMethod()

getAuthMethod

AuthenticationMethod getAuthMethod()

getHeaders

Map<String,String> getHeaders()

getFinalUri

String getFinalUri()

getTemplateString

String getTemplateString()

getRequestType

RequestType getRequestType()

getAuthenticator

Authenticator getAuthenticator()

getRequestKey

RequestKey getRequestKey()