Package de.msi.oauth.flow
Interface RequestTokenFlowParam
public interface RequestTokenFlowParam
The parameter, required for the
RequestTokenFlow.
Use RequestTokenFlowParam.RequestTokenFlowParamBuilder to build an instance of RequestTokenFlowParam.
- Author:
- Martin Siegemund
- See Also:
- 6.1. Obtaining an Unauthorized Request Token
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classRequestTokenFlowParam.RequestTokenFlowParamBuilderCreatesRequestTokenFlowParaminstances. -
Method Summary
Modifier and Type Method Description HeaderFieldsadditionalParams()Any additional parameters, as defined by the Service Provider.Optional<URI>callback()An absolute URL to which the Service Provider will redirect the User back when the Obtaining User Authorization (Obtaining User Authorization) step is completed.ConsumerKeyconsumerKey()Retrieve theconsumer_key.booleanincludeVersion()Retrieve the information about weather or not, theoauth_versioninformation should be included within the header fields.SignatureMethodsignatureMethod()Retrieve theSignatureMethod, used to sign the header fields for acquiring the request token.UserObtainRequestTokenuserObtainRequestToken()The user operation which is capable of retrieving the request token.
-
Method Details
-
consumerKey
ConsumerKey consumerKey()Retrieve theconsumer_key.- Returns:
- the key
-
signatureMethod
SignatureMethod signatureMethod()Retrieve theSignatureMethod, used to sign the header fields for acquiring the request token.- Returns:
- the
SignatureMethod
-
includeVersion
boolean includeVersion()Retrieve the information about weather or not, theoauth_versioninformation should be included within the header fields.- Returns:
trueif the information should be included, otherwisefalse
-
callback
An absolute URL to which the Service Provider will redirect the User back when the Obtaining User Authorization (Obtaining User Authorization) step is completed.- Returns:
- the
URIorOptional.empty()
-
additionalParams
HeaderFields additionalParams()Any additional parameters, as defined by the Service Provider.- Returns:
- the
HeaderFields
-
userObtainRequestToken
UserObtainRequestToken userObtainRequestToken()The user operation which is capable of retrieving the request token.- Returns:
- the
UserObtainRequestToken
-