Enum Class BoxFetcherConfig.AuthMethod

java.lang.Object
java.lang.Enum<BoxFetcherConfig.AuthMethod>
com.norconex.crawler.fs.fetch.impl.box.BoxFetcherConfig.AuthMethod
All Implemented Interfaces:
Serializable, Comparable<BoxFetcherConfig.AuthMethod>, Constable
Enclosing class:
BoxFetcherConfig

public static enum BoxFetcherConfig.AuthMethod extends Enum<BoxFetcherConfig.AuthMethod>
How the fetcher gets the access token it calls Box with.
  • Enum Constant Details

    • ACCESS_TOKEN

      public static final BoxFetcherConfig.AuthMethod ACCESS_TOKEN
      The access token given as accessToken, or as the password of the credentials, is used as is. Box access tokens expire, so this suits a token issued to last or a short test.
    • CLIENT_CREDENTIALS

      public static final BoxFetcherConfig.AuthMethod CLIENT_CREDENTIALS
      A Box application using Client Credentials Grant: the credentials hold its client ID (user name) and client secret (password), and enterpriseId says which enterprise to act in. A new access token is requested when the last one expires.
  • Method Details

    • values

      public static BoxFetcherConfig.AuthMethod[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static BoxFetcherConfig.AuthMethod valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null