Package org.scribe.builder.api

Class DefaultApi10a

java.lang.Object
org.scribe.builder.api.DefaultApi10a
All Implemented Interfaces:
Api
Direct Known Subclasses:
AWeberApi, ConstantContactApi, DiggApi, DropBoxApi, EvernoteApi, FlickrApi, FoursquareApi, FreelancerApi, GetGlueApi, GoogleApi, ImgUrApi, KaixinApi, LinkedInApi, LoveFilmApi, MeetupApi, MendeleyApi, MisoApi, NeteaseWeibooApi, NetProspexApi, PlurkApi, Px500Api, QWeiboApi, SapoApi, SimpleGeoApi, SinaWeiboApi, SkyrockApi, SohuWeiboApi, TrelloApi, TumblrApi, TwitterApi, UbuntuOneApi, VimeoApi, XingApi, YahooApi, YammerApi
public abstract class DefaultApi10a extends Object implements Api
Default implementation of the OAuth protocol, version 1.0a This class is meant to be extended by concrete implementations of the API, providing the endpoints and endpoint-http-verbs. If your Api adheres to the 1.0a protocol correctly, you just need to extend this class and define the getters for your endpoints. If your Api does something a bit different, you can override the different extractors or services, in order to fine-tune the process. Please read the javadocs of the interfaces to get an idea of what to do.

  • Constructor Details

    • DefaultApi10a

      public DefaultApi10a()

  • Method Details

    • getAccessTokenExtractor

      public AccessTokenExtractor getAccessTokenExtractor()
      Returns the access token extractor.
      Returns:
      access token extractor

    • getBaseStringExtractor

      public BaseStringExtractor getBaseStringExtractor()
      Returns the base string extractor.
      Returns:
      base string extractor

    • getHeaderExtractor

      public HeaderExtractor getHeaderExtractor()
      Returns the header extractor.
      Returns:
      header extractor

    • getRequestTokenExtractor

      public RequestTokenExtractor getRequestTokenExtractor()
      Returns the request token extractor.
      Returns:
      request token extractor

    • getSignatureService

      public SignatureService getSignatureService()
      Returns the signature service.
      Returns:
      signature service

    • getTimestampService

      public TimestampService getTimestampService()
      Returns the timestamp service.
      Returns:
      timestamp service

    • getAccessTokenVerb

      public Verb getAccessTokenVerb()
      Returns the verb for the access token endpoint (defaults to POST)
      Returns:
      access token endpoint verb

    • getRequestTokenVerb

      public Verb getRequestTokenVerb()
      Returns the verb for the request token endpoint (defaults to POST)
      Returns:
      request token endpoint verb

    • getRequestTokenEndpoint

      public abstract String getRequestTokenEndpoint()
      Returns the URL that receives the request token requests.
      Returns:
      request token URL

    • getAccessTokenEndpoint

      public abstract String getAccessTokenEndpoint()
      Returns the URL that receives the access token requests.
      Returns:
      access token URL

    • getAuthorizationUrl

      public abstract String getAuthorizationUrl(Token requestToken)
      Returns the URL where you should redirect your users to authenticate your application.
      Parameters:
      requestToken - the request token you need to authorize
      Returns:
      the URL where you should redirect your users

    • createService

      public OAuthService createService(OAuthConfig config)
      Returns the OAuthService for this Api
      Specified by:
      createService in interface Api
      Parameters:
      apiKey - Key
      apiSecret - Api Secret
      callback - OAuth callback (either URL or 'oob')
      scope - OAuth scope (optional)
      Returns:
      fully configured OAuthService