Annotation Type OAuth


  • @Target(TYPE)
    @Retention(RUNTIME)
    public @interface OAuth
    This annotation is used to identify OAuth plugins by marking the corresponding TransferSettings class. An OAuth plugin will provide a 'token' field during the initialization process and the OAuthGenerator (provided via the help of the value() field) will be able to check that token.
    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.String PLUGIN_ID  
      static int RANDOM_PORT  
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.Class<? extends OAuthGenerator> value  
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String callbackId
      If no specific name is provided (or "%pluginid%" is used), the OAuthTokenWebListener will choose a random identifier for the OAuth process.
      Needed if an OAuth provider uses preset and strict redirect URLs.
      int callbackPort
      If no specific port is provided (or -1 is used), the OAuthTokenWebListener will choose a random port from the range of 55500 and 55599.
      Needed if an OAuth provider uses preset and strict redirect URLs.
      OAuthMode mode
      The default Mode is OAuthMode.SERVER