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

Class BaseMultipartRequest

java.lang.Object

com.adobe.pdfservices.operation.internal.http.BaseMultipartRequest

All Implemented Interfaces:

HttpRequest, MultiPartRequest

public class BaseMultipartRequest
extends Object
implements MultiPartRequest

Returns a new instance of the multipart request on every setter

Constructor Summary

Constructors

Constructor	Description
BaseMultipartRequest(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()
List<ByteArrayPart>	getByteArrayParts()
HttpRequestConfig	getConfig()
org.apache.http.entity.StringEntity	getEntity()
String	getFinalUri()
Map<String,String>	getHeaders()
HttpMethod	getHttpMethod()
List<InputStreamPart>	getInputStreams()
RequestKey	getRequestKey()
RequestType	getRequestType()
StringBodyPart	getStringBodyPart()
String	getTemplateString()
MultiPartRequest	withAcceptType(String acceptHeader)
MultiPartRequest	withAuthenticationMethod(AuthenticationMethod authMethod)
MultiPartRequest	withAuthenticator(Authenticator authenticator)	Attaches an authenticator instance to the class, which will be used for all access token operations
MultiPartRequest	withBody(String body)
MultiPartRequest	withByteArrayPart(ByteArrayPart byteArrayPart)
MultiPartRequest	withConfig(HttpRequestConfig requestConfig)
MultiPartRequest	withContentType(String contentType)
MultiPartRequest	withHeader(String headerName, String headerValue)
MultiPartRequest	withHeaders(Map<String,String> headers)
MultiPartRequest	withInputStreamPart(InputStreamPart inputStreamPart)
HttpRequest	withRequestKey(RequestKey requestKey)
MultiPartRequest	withStringBodyPart(StringBodyPart stringBodyPart)	Only supports a single body part for now, based on the backend API.
MultiPartRequest	withTemplate(String uriTemplate)
MultiPartRequest	withUriParam(String name, String value)
MultiPartRequest	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

BaseMultipartRequest

public BaseMultipartRequest(String uriTemplate)

Method Detail

withContentType

public MultiPartRequest withContentType(String contentType)

Specified by:

withContentType in interface HttpRequest

withHeader

public MultiPartRequest withHeader(String headerName,
                                   String headerValue)

Specified by:

withHeader in interface HttpRequest

withHeaders

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

Specified by:

withHeaders in interface HttpRequest

withUriParam

public MultiPartRequest withUriParam(String name,
                                     String value)

Specified by:

withUriParam in interface HttpRequest

withUrlEncodedFormParams

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

Specified by:

withUrlEncodedFormParams in interface HttpRequest

withBody

public MultiPartRequest withBody(String body)

Specified by:

withBody in interface HttpRequest

withAuthenticationMethod

public MultiPartRequest withAuthenticationMethod(AuthenticationMethod authMethod)

Specified by:

withAuthenticationMethod in interface HttpRequest

withTemplate

public MultiPartRequest withTemplate(String uriTemplate)

Specified by:

withTemplate in interface HttpRequest

withAcceptType

public MultiPartRequest withAcceptType(String acceptHeader)

Specified by:

withAcceptType in interface HttpRequest

withAuthenticator

public MultiPartRequest 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 MultiPartRequest withConfig(HttpRequestConfig requestConfig)

Specified by:

withConfig in interface HttpRequest

withRequestKey

public HttpRequest withRequestKey(RequestKey requestKey)

Specified by:

withRequestKey in interface HttpRequest

withStringBodyPart

public MultiPartRequest withStringBodyPart(StringBodyPart stringBodyPart)

Only supports a single body part for now, based on the backend API. Internal implementation can be changed

Specified by:

withStringBodyPart in interface MultiPartRequest

Parameters:

stringBodyPart -

Returns:

withInputStreamPart

public MultiPartRequest withInputStreamPart(InputStreamPart inputStreamPart)

Specified by:

withInputStreamPart in interface MultiPartRequest

withByteArrayPart

public MultiPartRequest withByteArrayPart(ByteArrayPart byteArrayPart)

Specified by:

withByteArrayPart in interface MultiPartRequest

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

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

getRequestType

public RequestType getRequestType()

Specified by:

getRequestType in interface HttpRequest

getAuthenticator

public Authenticator getAuthenticator()

Specified by:

getAuthenticator in interface HttpRequest

getTemplateString

public String getTemplateString()

Specified by:

getTemplateString in interface HttpRequest

getByteArrayParts

public List<ByteArrayPart> getByteArrayParts()

Specified by:

getByteArrayParts in interface MultiPartRequest

getInputStreams

public List<InputStreamPart> getInputStreams()

Specified by:

getInputStreams in interface MultiPartRequest

getStringBodyPart

public StringBodyPart getStringBodyPart()

Specified by:

getStringBodyPart in interface MultiPartRequest

getRequestKey

public RequestKey getRequestKey()

Specified by:

getRequestKey in interface HttpRequest