java.lang.Object

com.github.scribejava.core.model.OAuthRequest

public class OAuthRequest
extends java.lang.Object

The representation of an OAuth HttpRequest.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static interface OAuthRequest.ResponseConverter<T>
Constructor Summary

Constructors

Constructor Description

OAuthRequest(Verb verb, java.lang.String url)
Default constructor.

Method Summary

Modifier and Type	Method	Description
`void`	`addBodyParameter(java.lang.String key, java.lang.String value)`	Add a body Parameter (for POST/ PUT Requests)
`void`	`addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload)`
`void`	`addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, java.lang.String contentType)`
`void`	`addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, java.util.Map<java.lang.String,java.lang.String> headers)`
`void`	`addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent)`
`void`	`addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, java.lang.String name)`
`void`	`addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, java.lang.String name, java.lang.String filename)`
`void`	`addFileByteArrayBodyPartPayloadInMultipartPayload(FileByteArrayBodyPartPayload fileByteArrayBodyPartPayload)`
`void`	`addFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent)`
`void`	`addFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent, java.lang.String name)`
`void`	`addFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent, java.lang.String name, java.lang.String filename)`
`void`	`addHeader(java.lang.String key, java.lang.String value)`	Add an HTTP Header to the Request
`void`	`addOAuthParameter(java.lang.String key, java.lang.String value)`	Adds an OAuth parameter.
`void`	`addParameter(java.lang.String key, java.lang.String value)`
`void`	`addQuerystringParameter(java.lang.String key, java.lang.String value)`	Add a QueryString parameter
`ParameterList`	`getBodyParams()`	Obtains a `ParameterList` of the body parameters.
`byte[]`	`getByteArrayPayload()`
`java.lang.String`	`getCharset()`
`java.lang.String`	`getCompleteUrl()`	Returns the complete url (host + resource + encoded querystring parameters).
`java.io.File`	`getFilePayload()`
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()`
`MultipartPayload`	`getMultipartPayload()`
`java.util.Map<java.lang.String,java.lang.String>`	`getOauthParameters()`
`ParameterList`	`getQueryStringParams()`	Get a `ParameterList` with the query string parameters.
`java.lang.String`	`getRealm()`
`java.lang.String`	`getSanitizedUrl()`	Returns the URL without the port and the query string part.
`java.lang.String`	`getStringPayload()`	Returns the body of the request (set in `setPayload(java.lang.String)`)
`java.lang.String`	`getUrl()`	Obtains the URL of the HTTP Request.
`Verb`	`getVerb()`
`void`	`initMultipartPayload()`
`void`	`initMultipartPayload(java.lang.String boundary)`
`void`	`initMultipartPayload(java.lang.String subtype, java.lang.String boundary)`
`void`	`initMultipartPayload(java.lang.String subtype, java.lang.String boundary, java.util.Map<java.lang.String,java.lang.String> headers)`
`void`	`initMultipartPayload(java.lang.String boundary, java.util.Map<java.lang.String,java.lang.String> headers)`
`void`	`initMultipartPayload(java.util.Map<java.lang.String,java.lang.String> headers)`
`void`	`setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload)`
`void`	`setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, java.lang.String contentType)`
`void`	`setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, java.util.Map<java.lang.String,java.lang.String> headers)`
`void`	`setCharset(java.lang.String charsetName)`	Set the charset of the body of the request
`void`	`setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent)`
`void`	`setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, java.lang.String name)`
`void`	`setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, java.lang.String name, java.lang.String filename)`
`void`	`setFileByteArrayBodyPartPayloadInMultipartPayload(FileByteArrayBodyPartPayload fileByteArrayBodyPartPayload)`
`void`	`setFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent)`
`void`	`setFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent, java.lang.String name)`
`void`	`setFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent, java.lang.String name, java.lang.String filename)`
`void`	`setMultipartPayload(MultipartPayload multipartPayload)`
`void`	`setPayload(byte[] payload)`	Overloaded version for byte arrays
`void`	`setPayload(java.io.File payload)`	Overloaded version for File
`void`	`setPayload(java.lang.String payload)`	Set body payload.
`void`	`setRealm(java.lang.String realm)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

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

Constructor Details
- OAuthRequest
  
  public OAuthRequest(Verb verb, java.lang.String url)
  
  Default constructor.
  
  Parameters:
  
  verb - Http verb/method
  
  url - resource URL
Method Details
- addOAuthParameter
  
  public void addOAuthParameter(java.lang.String key, java.lang.String value)
  
  Adds an OAuth parameter.
  
  Parameters:
  
  key - name of the parameter
  
  value - value of the parameter
  
  Throws:
  
  java.lang.IllegalArgumentException - if the parameter is not an OAuth parameter
- getOauthParameters
  
  public java.util.Map<java.lang.String,java.lang.String> getOauthParameters()
- setRealm
  
  public void setRealm(java.lang.String realm)
- getRealm
  
  public java.lang.String getRealm()
- getCompleteUrl
  
  public java.lang.String getCompleteUrl()
  
  Returns the complete url (host + resource + encoded querystring parameters).
  
  Returns:
  
  the complete url.
- addHeader
  
  public void addHeader(java.lang.String key, java.lang.String value)
  
  Add an HTTP Header to the Request
  
  Parameters:
  
  key - the header name
  
  value - the header value
- addBodyParameter
  
  public void addBodyParameter(java.lang.String key, java.lang.String value)
  
  Add a body Parameter (for POST/ PUT Requests)
  
  Parameters:
  
  key - the parameter name
  
  value - the parameter value
- addQuerystringParameter
  
  public void addQuerystringParameter(java.lang.String key, java.lang.String value)
  
  Add a QueryString parameter
  
  Parameters:
  
  key - the parameter name
  
  value - the parameter value
- addParameter
  
  public void addParameter(java.lang.String key, java.lang.String value)
- getMultipartPayload
  
  public MultipartPayload getMultipartPayload()
- setMultipartPayload
  
  public void setMultipartPayload(MultipartPayload multipartPayload)
- initMultipartPayload
  
  public void initMultipartPayload()
- initMultipartPayload
  
  public void initMultipartPayload(java.lang.String boundary)
- initMultipartPayload
  
  public void initMultipartPayload(java.lang.String subtype, java.lang.String boundary)
- initMultipartPayload
  
  public void initMultipartPayload(java.util.Map<java.lang.String,java.lang.String> headers)
- initMultipartPayload
  
  public void initMultipartPayload(java.lang.String boundary, java.util.Map<java.lang.String,java.lang.String> headers)
- initMultipartPayload
  
  public void initMultipartPayload(java.lang.String subtype, java.lang.String boundary, java.util.Map<java.lang.String,java.lang.String> headers)
- setByteArrayBodyPartPayloadInMultipartPayload
  
  public void setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload)
- setByteArrayBodyPartPayloadInMultipartPayload
  
  public void setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, java.lang.String contentType)
- setByteArrayBodyPartPayloadInMultipartPayload
  
  public void setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, java.util.Map<java.lang.String,java.lang.String> headers)
- addByteArrayBodyPartPayloadInMultipartPayload
  
  public void addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload)
- addByteArrayBodyPartPayloadInMultipartPayload
  
  public void addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, java.lang.String contentType)
- addByteArrayBodyPartPayloadInMultipartPayload
  
  public void addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, java.util.Map<java.lang.String,java.lang.String> headers)
- setFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent)
- setFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void setFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent)
- setFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, java.lang.String name)
- setFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void setFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent, java.lang.String name)
- setFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, java.lang.String name, java.lang.String filename)
- setFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void setFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent, java.lang.String name, java.lang.String filename)
- setFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void setFileByteArrayBodyPartPayloadInMultipartPayload(FileByteArrayBodyPartPayload fileByteArrayBodyPartPayload)
- addFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent)
- addFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void addFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent)
- addFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, java.lang.String name)
- addFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void addFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent, java.lang.String name)
- addFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, java.lang.String name, java.lang.String filename)
- addFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void addFileByteArrayBodyPartPayloadInMultipartPayload(java.lang.String contentType, byte[] fileContent, java.lang.String name, java.lang.String filename)
- addFileByteArrayBodyPartPayloadInMultipartPayload
  
  public void addFileByteArrayBodyPartPayloadInMultipartPayload(FileByteArrayBodyPartPayload fileByteArrayBodyPartPayload)
- setPayload
  
  public void setPayload(java.lang.String payload)
  
  Set body payload. This method is used when the HTTP body is not a form-url-encoded string, but another thing. Like for example XML. Note: The contents are not part of the OAuth signature
  
  Parameters:
  
  payload - the body of the request
- setPayload
  
  public void setPayload(byte[] payload)
  
  Overloaded version for byte arrays
  
  Parameters:
  
  payload - byte[]
- setPayload
  
  public void setPayload(java.io.File payload)
  
  Overloaded version for File
  
  Parameters:
  
  payload - File
- getQueryStringParams
  
  public ParameterList getQueryStringParams()
  
  Get a ParameterList with the query string parameters.
  
  Returns:
  
  a ParameterList containing the query string parameters.
  
  Throws:
  
  OAuthException - if the request URL is not valid.
- getBodyParams
  
  public ParameterList getBodyParams()
  
  Obtains a ParameterList of the body parameters.
  
  Returns:
  
  a ParameterListcontaining the body parameters.
- getUrl
  
  public java.lang.String getUrl()
  
  Obtains the URL of the HTTP Request.
  
  Returns:
  
  the original URL of the HTTP Request
- getSanitizedUrl
  
  public java.lang.String getSanitizedUrl()
  
  Returns the URL without the port and the query string part.
  
  Returns:
  
  the OAuth-sanitized URL
- getStringPayload
  
  public java.lang.String getStringPayload()
  
  Returns the body of the request (set in setPayload(java.lang.String))
  
  Returns:
  
  form encoded string
- getByteArrayPayload
  
  public byte[] getByteArrayPayload()
  
  Returns:
  
  the body of the request (set in setPayload(byte[]) or in addBodyParameter(java.lang.String, java.lang.String) )
- getFilePayload
  
  public java.io.File getFilePayload()
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- getVerb
  
  public Verb getVerb()
- getHeaders
  
  public java.util.Map<java.lang.String,java.lang.String> getHeaders()
- getCharset
  
  public java.lang.String getCharset()
- setCharset
  
  public void setCharset(java.lang.String charsetName)
  
  Set the charset of the body of the request
  
  Parameters:
  
  charsetName - name of the charset of the request

Class OAuthRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details