AbstractRequest (ScribeJava Core 3.4.0 API)

java.lang.Object
- com.github.scribejava.core.model.AbstractRequest

Direct Known Subclasses:

OAuthRequest, OAuthRequestAsync
```
public abstract class AbstractRequest
extends Object
```
The representation of an OAuth HttpRequest.

Field Summary

Fields
Modifier and Type Field and Description

protected static String CONTENT_LENGTH

static String CONTENT_TYPE

static String DEFAULT_CONTENT_TYPE

Fields
Modifier and Type	Field and Description
`protected static String`	`CONTENT_LENGTH`
`static String`	`CONTENT_TYPE`
`static String`	`DEFAULT_CONTENT_TYPE`

Constructor Summary

Constructors
Constructor and Description
`AbstractRequest(Verb verb, String url)` Default constructor.
`AbstractRequest(Verb verb, String url, OAuthService<?> service)` Deprecated. use `AbstractRequest(com.github.scribejava.core.model.Verb, java.lang.String)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addBodyParameter(String key, String value)` Add a body Parameter (for POST/ PUT Requests)
`void`	`addHeader(String key, String value)` Add an HTTP Header to the Request
`void`	`addOAuthParameter(String key, String value)` Adds an OAuth parameter.
`void`	`addParameter(String key, String value)`
`void`	`addPayload(byte[] payload)` Deprecated. use `setPayload(byte[])`
`void`	`addPayload(String payload)` Deprecated. use `setPayload(java.lang.String)`
`void`	`addQuerystringParameter(String key, String value)` Add a QueryString parameter
`String`	`getBodyContents()` Deprecated. use `getStringPayload()` or `getByteArrayPayload()`
`ParameterList`	`getBodyParams()` Obtains a `ParameterList` of the body parameters.
`byte[]`	`getByteArrayPayload()`
`byte[]`	`getByteBodyContents()` Deprecated. use `getByteArrayPayload()`
`String`	`getCharset()`
`String`	`getCompleteUrl()` Returns the complete url (host + resource + encoded querystring parameters).
`File`	`getFilePayload()`
`Map<String,String>`	`getHeaders()`
`Map<String,String>`	`getOauthParameters()`
`ParameterList`	`getQueryStringParams()` Get a `ParameterList` with the query string parameters.
`String`	`getRealm()`
`String`	`getSanitizedUrl()` Returns the URL without the port and the query string part.
`OAuthService<?>`	`getService()` Deprecated. Request doesn't couple with Service anymore. It doesn't need it. Look for service somewhere else
`String`	`getStringPayload()` Returns the body of the request (set in `setPayload(java.lang.String)`)
`String`	`getUrl()` Obtains the URL of the HTTP Request.
`Verb`	`getVerb()`
`protected boolean`	`hasBodyContent()`
`boolean`	`isFollowRedirects()`
`void`	`setCharset(String charsetName)` Set the charset of the body of the request
`void`	`setFollowRedirects(boolean followRedirects)` Sets whether the underlying Http Connection follows redirects or not.
`void`	`setPayload(byte[] payload)` Overloaded version for byte arrays
`void`	`setPayload(File payload)` Overloaded version for File
`void`	`setPayload(String payload)` Set body payload.
`void`	`setRealm(String realm)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_CONTENT_TYPE
```
public static final String DEFAULT_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - CONTENT_LENGTH
```
protected static final String CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractRequest
```
@Deprecated
public AbstractRequest(Verb verb,
                                   String url,
                                   OAuthService<?> service)
```
    Deprecated. use AbstractRequest(com.github.scribejava.core.model.Verb, java.lang.String)
    
    Default constructor.
    
    Parameters:
    
    verb - Http verb/method
    
    url - resource URL
    
    service - OAuthService
  - AbstractRequest
```
public AbstractRequest(Verb verb,
                       String url)
```
    Default constructor.
    
    Parameters:
    
    verb - Http verb/method
    
    url - resource URL
- Method Detail
  - addOAuthParameter
```
public void addOAuthParameter(String key,
                              String value)
```
    Adds an OAuth parameter.
    
    Parameters:
    
    key - name of the parameter
    
    value - value of the parameter
    
    Throws:
    
    IllegalArgumentException - if the parameter is not an OAuth parameter
  - getOauthParameters
```
public Map<String,String> getOauthParameters()
```
  - setRealm
```
public void setRealm(String realm)
```
  - getRealm
```
public String getRealm()
```
  - getCompleteUrl
```
public String getCompleteUrl()
```
    Returns the complete url (host + resource + encoded querystring parameters).
    
    Returns:
    
    the complete url.
  - addHeader
```
public void addHeader(String key,
                      String value)
```
    Add an HTTP Header to the Request
    
    Parameters:
    
    key - the header name
    
    value - the header value
  - addBodyParameter
```
public void addBodyParameter(String key,
                             String value)
```
    Add a body Parameter (for POST/ PUT Requests)
    
    Parameters:
    
    key - the parameter name
    
    value - the parameter value
  - addQuerystringParameter
```
public void addQuerystringParameter(String key,
                                    String value)
```
    Add a QueryString parameter
    
    Parameters:
    
    key - the parameter name
    
    value - the parameter value
  - addParameter
```
public void addParameter(String key,
                         String value)
```
  - hasBodyContent
```
protected boolean hasBodyContent()
```
  - addPayload
```
@Deprecated
public void addPayload(String payload)
```
    Deprecated. use setPayload(java.lang.String)
    
    Parameters:
    
    payload - payload
  - addPayload
```
@Deprecated
public void addPayload(byte[] payload)
```
    Deprecated. use setPayload(byte[])
    
    Parameters:
    
    payload - payload
  - setPayload
```
public void setPayload(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(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 String getUrl()
```
    Obtains the URL of the HTTP Request.
    
    Returns:
    
    the original URL of the HTTP Request
  - getSanitizedUrl
```
public String getSanitizedUrl()
```
    Returns the URL without the port and the query string part.
    
    Returns:
    
    the OAuth-sanitized URL
  - getBodyContents
```
@Deprecated
public String getBodyContents()
```
    Deprecated. use getStringPayload() or getByteArrayPayload()
    
    Returns:
    
    value set in setPayload(java.lang.String)
  - getStringPayload
```
public String getStringPayload()
```
    Returns the body of the request (set in setPayload(java.lang.String))
    
    Returns:
    
    form encoded string
    
    Throws:
    
    OAuthException - if the charset chosen is not supported
  - getByteBodyContents
```
@Deprecated
public byte[] getByteBodyContents()
```
    Deprecated. use getByteArrayPayload()
    
    Returns:
    
    value set in setPayload(byte[])
  - 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 File getFilePayload()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getVerb
```
public Verb getVerb()
```
  - getHeaders
```
public Map<String,String> getHeaders()
```
  - getCharset
```
public String getCharset()
```
  - setCharset
```
public void setCharset(String charsetName)
```
    Set the charset of the body of the request
    
    Parameters:
    
    charsetName - name of the charset of the request
  - setFollowRedirects
```
public void setFollowRedirects(boolean followRedirects)
```
    Sets whether the underlying Http Connection follows redirects or not. Defaults to true (follow redirects)
    
    Parameters:
    
    followRedirects - boolean
    
    See Also:
    
    http://docs.oracle.com/javase/6/docs/api/java/net/HttpURLConnection.html#setInstanceFollowRedirects(boolean)
  - isFollowRedirects
```
public boolean isFollowRedirects()
```
  - getService
```
@Deprecated
public OAuthService<?> getService()
```
    Deprecated. Request doesn't couple with Service anymore. It doesn't need it. Look for service somewhere else
    
    always throws UnsupportedOperationException
    
    Returns:
    
    never

Class AbstractRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CONTENT_TYPE

CONTENT_TYPE

CONTENT_LENGTH

Constructor Detail

AbstractRequest

AbstractRequest

Method Detail

addOAuthParameter

getOauthParameters

setRealm

getRealm

getCompleteUrl

addHeader

addBodyParameter

addQuerystringParameter

addParameter

hasBodyContent

addPayload

addPayload

setPayload

setPayload

setPayload

getQueryStringParams

getBodyParams

getUrl

getSanitizedUrl

getBodyContents

getStringPayload

getByteBodyContents

getByteArrayPayload

getFilePayload

toString

getVerb

getHeaders

getCharset

setCharset

setFollowRedirects

isFollowRedirects

getService