Package com.github.scribejava.core.model
Class OAuthRequest
- java.lang.Object
-
- com.github.scribejava.core.model.OAuthRequest
-
public class OAuthRequest extends 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, String url)
Default constructor.
-
Method Summary
-
-
-
Method Detail
-
addOAuthParameter
public void addOAuthParameter(String key, String value)
Adds an OAuth parameter.- Parameters:
key
- name of the parametervalue
- value of the parameter- Throws:
IllegalArgumentException
- if the parameter is not an OAuth parameter
-
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 namevalue
- the header value
-
addBodyParameter
public void addBodyParameter(String key, String value)
Add a body Parameter (for POST/ PUT Requests)- Parameters:
key
- the parameter namevalue
- the parameter value
-
addQuerystringParameter
public void addQuerystringParameter(String key, String value)
Add a QueryString parameter- Parameters:
key
- the parameter namevalue
- the parameter value
-
getMultipartPayload
public MultipartPayload getMultipartPayload()
-
setMultipartPayload
public void setMultipartPayload(MultipartPayload multipartPayload)
-
initMultipartPayload
public void initMultipartPayload()
-
initMultipartPayload
public void initMultipartPayload(String boundary)
-
initMultipartPayload
public void initMultipartPayload(String boundary, Map<String,String> headers)
-
initMultipartPayload
public void initMultipartPayload(String subtype, String boundary, Map<String,String> headers)
-
setByteArrayBodyPartPayloadInMultipartPayload
public void setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload)
-
setByteArrayBodyPartPayloadInMultipartPayload
public void setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, String contentType)
-
setByteArrayBodyPartPayloadInMultipartPayload
public void setByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, Map<String,String> headers)
-
addByteArrayBodyPartPayloadInMultipartPayload
public void addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload)
-
addByteArrayBodyPartPayloadInMultipartPayload
public void addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, String contentType)
-
addByteArrayBodyPartPayloadInMultipartPayload
public void addByteArrayBodyPartPayloadInMultipartPayload(byte[] bodyPartPayload, Map<String,String> headers)
-
setFileByteArrayBodyPartPayloadInMultipartPayload
public void setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent)
-
setFileByteArrayBodyPartPayloadInMultipartPayload
public void setFileByteArrayBodyPartPayloadInMultipartPayload(String contentType, byte[] fileContent)
-
setFileByteArrayBodyPartPayloadInMultipartPayload
public void setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, String name)
-
setFileByteArrayBodyPartPayloadInMultipartPayload
public void setFileByteArrayBodyPartPayloadInMultipartPayload(String contentType, byte[] fileContent, String name)
-
setFileByteArrayBodyPartPayloadInMultipartPayload
public void setFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, String name, String filename)
-
setFileByteArrayBodyPartPayloadInMultipartPayload
public void setFileByteArrayBodyPartPayloadInMultipartPayload(String contentType, byte[] fileContent, String name, String filename)
-
setFileByteArrayBodyPartPayloadInMultipartPayload
public void setFileByteArrayBodyPartPayloadInMultipartPayload(FileByteArrayBodyPartPayload fileByteArrayBodyPartPayload)
-
addFileByteArrayBodyPartPayloadInMultipartPayload
public void addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent)
-
addFileByteArrayBodyPartPayloadInMultipartPayload
public void addFileByteArrayBodyPartPayloadInMultipartPayload(String contentType, byte[] fileContent)
-
addFileByteArrayBodyPartPayloadInMultipartPayload
public void addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, String name)
-
addFileByteArrayBodyPartPayloadInMultipartPayload
public void addFileByteArrayBodyPartPayloadInMultipartPayload(String contentType, byte[] fileContent, String name)
-
addFileByteArrayBodyPartPayloadInMultipartPayload
public void addFileByteArrayBodyPartPayloadInMultipartPayload(byte[] fileContent, String name, String filename)
-
addFileByteArrayBodyPartPayloadInMultipartPayload
public void addFileByteArrayBodyPartPayloadInMultipartPayload(String contentType, byte[] fileContent, String name, String filename)
-
addFileByteArrayBodyPartPayloadInMultipartPayload
public void addFileByteArrayBodyPartPayloadInMultipartPayload(FileByteArrayBodyPartPayload fileByteArrayBodyPartPayload)
-
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 aParameterList
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 aParameterList
of the body parameters.- Returns:
- a
ParameterList
containing 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
-
getStringPayload
public String getStringPayload()
Returns the body of the request (set insetPayload(java.lang.String)
)- Returns:
- form encoded string
-
getByteArrayPayload
public byte[] getByteArrayPayload()
- Returns:
- the body of the request (set in
setPayload(byte[])
or inaddBodyParameter(java.lang.String, java.lang.String)
)
-
getFilePayload
public File getFilePayload()
-
getVerb
public Verb getVerb()
-
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
-
-