Package de.msi.oauth.flow.params.header
Interface HeaderFieldsBuilder
public interface HeaderFieldsBuilder
Helps building a
HeaderFields instance in regard to the fields which
have been added.- Author:
- Martin Siegemund
-
Method Summary
Modifier and Type Method Description HeaderFieldsBuilderadditionalParameter(HeaderFields additionalParams)Add additional (service provider defined) fields.HeaderFieldsbuild(SignatureMethod signatureMethod)Build theHeaderFieldsinstance by using the givenSignatureMethod.HeaderFieldsBuilderconsumerKey(ConsumerKey consumerKey)Add theoauth_consumer_key.HeaderFieldsBuildertoken(Token token)Add theoauth_token.HeaderFieldsBuildertokenSecret(TokenSecret tokenSecret)Add theoauth_token_secret.HeaderFieldsBuilderverifier(VerificationCode verifier)Add theoauth_verifier.HeaderFieldsBuilderversionInformation()Invoke this method if theoauth_versioninformation (1.0) should be added to the header fields.static HeaderFieldsBuilderwithCallback(URI callback)Create a newHeaderFieldsBuilderwhich provides anoauth_callback.static HeaderFieldsBuilderwithoutCallback()Create a newHeaderFieldsBuilderwithout providing anoauth_callbackfield.static HeaderFieldsBuilderwithOutOfBandsCallback()Create a newHeaderFieldsBuilderwhich provides anoauth_callbackfield with the valueoob(out-of-band).
-
Method Details
-
consumerKey
Add theoauth_consumer_key.- Parameters:
consumerKey- theoauth_consumer_key- Returns:
- the builder
-
versionInformation
HeaderFieldsBuilder versionInformation()Invoke this method if theoauth_versioninformation (1.0) should be added to the header fields.- Returns:
- the builder
-
token
Add theoauth_token.- Parameters:
token- theoauth_token- Returns:
- the builder
-
verifier
Add theoauth_verifier.- Parameters:
verifier- theoauth_verifier- Returns:
- the builder
-
tokenSecret
Add theoauth_token_secret.This is required for certain signing methods.
- Parameters:
tokenSecret- theoauth_token_secret- Returns:
- the builder
-
additionalParameter
Add additional (service provider defined) fields.- Parameters:
additionalParams- the additional fields- Returns:
- the builder
-
build
Build theHeaderFieldsinstance by using the givenSignatureMethod.- Parameters:
signatureMethod- the desiredSignatureMethod- Returns:
- the resulting
HeaderFields
-
withCallback
Create a newHeaderFieldsBuilderwhich provides anoauth_callback.- Parameters:
callback- the callback address- Returns:
- the
HeaderFieldsBuilder
-
withOutOfBandsCallback
Create a newHeaderFieldsBuilderwhich provides anoauth_callbackfield with the valueoob(out-of-band).- Returns:
- the
HeaderFieldsBuilder
-
withoutCallback
Create a newHeaderFieldsBuilderwithout providing anoauth_callbackfield.- Returns:
- the
HeaderFieldsBuilder
-