META-INF.additional-spring-configuration-metadata.json Maven / Gradle / Ivy

Go to download
{
  "groups": [
    {
      "name": "stormpath"
    },
    {
      "name": "stormpath.client"
    },
    {
      "name": "stormpath.application"
    }
  ],
  "properties": [
    {
      "name": "stormpath.client.baseUrl",
      "type": "java.lang.String",
      "description": "The base URL the Stormpath Client will use when communicating with the Stormpath REST API.  If unspecified, the default value is https://api.stormpath.com/v1 but may be overridden when communicating with enterprise or private Stormpath deployments with custom domain names.  Note the '/v1' path at the end of the URL - a custom URL will almost always specify a version path after the domain name.",
      "defaultValue": "https://api.stormpath.com/v1"
    },
    {
      "name": "stormpath.client.connectionTimeout",
      "type": "java.lang.Integer",
      "description": "Sets both the timeout until a Stormpath Client connection is established as well as the connection socket timeout (i.e. a maximum period of inactivity between two consecutive data packets).  A timeout value of zero (the default) is interpreted as an infinite timeout.",
      "defaultValue": 0
    },
    {
      "name": "stormpath.enabled",
      "type": "java.lang.Boolean",
      "description": "A boolean flag that can disable all Stormpath Spring Boot starters.  This is mostly useful during testing or debugging, or if you want to compare behavior when Stormpath is enabled or disabled.",
      "defaultValue": true
    },
    {
      "name": "stormpath.client.apiKey.id",
      "type": "java.lang.String",
      "description": "The Stormpath API Key ID used by the Client to authenticate with the Stormpath REST API.  If unspecified, the value will be attempted to be read from the $HOME/.stormpath/apiKey.properties file.  If this file is not available or cannot be read, you must specify this configuration value in one of Spring Boot's accessible property definition locations as described here: http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html."
    },
    {
      "name": "stormpath.client.apiKey.secret",
      "type": "java.lang.String",
      "description": "The Stormpath API Key Secret used by the Client to authenticate with the Stormpath REST API.  IT IS STRONGLY RECOMMENDED THAT YOU DO NOT STORE THIS VALUE IN SOURCE CODE AS DOING SO IS A SECURITY RISK.  If unspecified, the value will be attempted to be read from the $HOME/.stormpath/apiKey.properties file.  If this file is not available or cannot be read, you must specify this configuration value in one of Spring Boot's accessible property definition locations as described here: http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html.  If external config is necessary, it is strongly recommended to use the STORMPATH_API_KEY_SECRET environment variable so this value is not committed to version control."
    },
    {
      "name": "stormpath.client.apiKey.file",
      "type": "java.lang.String",
      "description": "A Spring resource URL that points to the apiKey.properties file that contains the Client API Key ID and/or Secret.  This can be used to specify a configuration file for obtaining apiKey.properties instead of configuring them as Spring configuration properties if desired."
    },
    {
      "name": "stormpath.client.apiKey.fileIdPropertyName",
      "type": "java.lang.String",
      "description": "The name of the API Key ID property to read in the referenced apiKey.properties file.  Only used if reading a apiKey.properties resource specified via the stormpath.client.apiKey.file property, defaults to apiKey.id.",
      "defaultValue": "apiKey.id"
    },
    {
      "name": "stormpath.client.apiKey.fileSecretPropertyName",
      "type": "java.lang.String",
      "description": "The name of the API Key Secret property to read in the referenced apiKey.properties file.  Only used if reading a apiKey.properties resource specified via the stormpath.client.apiKey.file property, defaults to apiKey.secret.",
      "defaultValue": "apiKey.secret"
    },
    {
      "name": "stormpath.client.cacheManager.enabled",
      "type": "java.lang.Boolean",
      "description": "A boolean flag that can be used to disable the client's cache, defaults to true.",
      "defaultValue": true
    },
    {
      "name": "stormpath.client.cacheManager.defaultTtl",
      "type": "java.lang.Integer",
      "description": "A value that sets the default time to live (in seconds) for the client's cache, defaults to 300.",
      "defaultValue": 300
    },
    {
      "name": "stormpath.client.cacheManager.defaultTti",
      "type": "java.lang.Integer",
      "description": "A value that sets the default time to idle (in seconds) for the client's cache, defaults to 300.",
      "defaultValue": 300
    },
    {
      "name": "stormpath.application.href",
      "type": "java.lang.String",
      "description": "The fully qualified URL of the Application REST Resource in Stormpath that corresponds to the Spring Boot application being deployed.  If unspecified, the Client will attempt to find this Application for you automatically.  However, if you have more than one Application registered in Stormpath, you MUST specify this value otherwise the Client will not know which application to use."
    },
    {
      "name": "stormpath.client.authenticationScheme",
      "type": "java.lang.String",
      "description": "The authentication scheme the Client should use when communicating with the Stormpath REST API, either BASIC or SAUTHC1.  If unspecified, the default value is SAUTHC, the most secure optiona available.  BASIC is NOT recommended and should only be used in environments where SAUTCH1 is not possible (for example, users have indicated that BASIC is required when running on Google App Engine). ",
      "defaultValue": "SAUTHC1"
    },
    {
      "name": "stormpath.client.proxy.host",
      "type": "java.lang.String",
      "description": "The fully qualified host name or IP address of the proxy server to connect through when communicating with the Stormpath REST API.  This is disabled by default and only needs to be specified if you require outbound HTTP traffic to flow through a proxy server first (for example, in a corporate intranet)."
    },
    {
      "name": "stormpath.client.proxy.port",
      "type": "java.lang.String",
      "description": "The port on the proxy server to connect to when communicating with the Stormpath REST API.  This value is only used if stormpath.client.proxy.host is configured, and defaults to 80.",
      "defaultValue": 80
    },
    {
      "name": "stormpath.client.proxy.username",
      "type": "java.lang.String",
      "description": "Tbe username to use when connecting to the proxy server used when communicating with the Stormpath REST API.  Do not set this value if username/password authentication to the proxy server is not required.  This value is only read if stormpath.client.proxy.host is set."
    },
    {
      "name": "stormpath.client.proxy.password",
      "type": "java.lang.String",
      "description": "Tbe password to use when connecting to the proxy server used when communicating with the Stormpath REST API.  Do not set this value if username/password authentication to the proxy server is not required.  This value is only read if stormpath.client.proxy.host is set.  It is STRONGLY recommended that passwords not be set in files that are committed to version control - if you need to set this property, it is recommended to set the STORMPATH_PROXY_PASSWORD environment variable instead."
    }
  ]
}