Package com.github.scribejava.core.model

Class OAuthRequest

  • public class OAuthRequest
extends java.lang.Object
    The representation of an OAuth HttpRequest.

    • Field Detail

      • url

        private final java.lang.String url

      • verb

        private final Verb verb

      • querystringParams

        private final ParameterList querystringParams

      • headers

        private final java.util.Map<java.lang.String,​java.lang.String> headers

      • charset

        private java.lang.String charset

      • stringPayload

        private java.lang.String stringPayload

      • byteArrayPayload

        private byte[] byteArrayPayload

      • filePayload

        private java.io.File filePayload

      • oauthParameters

        private final java.util.Map<java.lang.String,​java.lang.String> oauthParameters

      • realm

        private java.lang.String realm

    • Constructor Detail

      • OAuthRequest

        public OAuthRequest​(Verb verb,
                    java.lang.String url)
        Default constructor.
        Parameters:
        verb - Http verb/method
        url - resource URL

    • Method Detail

      • 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

      • checkKey

        private java.lang.String checkKey​(java.lang.String key)

      • 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)

      • 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)

      • setBodyPartPayloadInMultipartPayload

        public void setBodyPartPayloadInMultipartPayload​(BodyPartPayload bodyPartPayload)

      • addBodyPartPayloadInMultipartPayload

        public void addBodyPartPayloadInMultipartPayload​(BodyPartPayload bodyPartPayload)

      • 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

      • resetPayload

        private void resetPayload()

      • 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

      • 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