Package org.jclouds

Class Constants


  • public final class Constants
    extends Object
    Constants used in jclouds services.
    • Field Detail

      • PROPERTY_USER_THREADS

        public static final String PROPERTY_USER_THREADS
        Integer property. default (0)

        Amount of threads servicing the user requests and transformations

        See Also:
        Constant Field Values
      • PROPERTY_IO_WORKER_THREADS

        @Deprecated
        public static final String PROPERTY_IO_WORKER_THREADS
        Deprecated.
        No longer used. Will be removed in jclouds v2
        Integer property. default (20)

        Amount of threads servicing the I/O of http connections.

        See Also:
        Constant Field Values
      • PROPERTY_SCHEDULER_THREADS

        public static final String PROPERTY_SCHEDULER_THREADS
        Integer property. default (10)

        Amount of threads servicing scheduled tasks.

        See Also:
        Constant Field Values
      • PROPERTY_MAX_CONNECTIONS_PER_CONTEXT

        public static final String PROPERTY_MAX_CONNECTIONS_PER_CONTEXT
        Integer property. default (20)

        Limits the amount of connections per context.

        See Also:
        Constant Field Values
      • PROPERTY_MAX_SESSION_FAILURES

        public static final String PROPERTY_MAX_SESSION_FAILURES
        Integer property. default (2)

        Maximum amount of http session failures before a pool is disabled.

        See Also:
        Constant Field Values
      • PROPERTY_MAX_CONNECTION_REUSE

        public static final String PROPERTY_MAX_CONNECTION_REUSE
        Integer property. default (75)

        Maximum amount of times to re_use an http connection. Services like Amazon S3 throw errors if connections are reused too many times.

        See Also:
        Constant Field Values
      • PROPERTY_SO_TIMEOUT

        public static final String PROPERTY_SO_TIMEOUT
        int property. default (60000)

        How many milliseconds to wait before a socket connection times out. 0 means infinity.

        See Also:
        Constant Field Values
      • PROPERTY_CONNECTION_TIMEOUT

        public static final String PROPERTY_CONNECTION_TIMEOUT
        Long property. default (60000)

        How many milliseconds to wait before a connection times out. 0 means infinity.

        See Also:
        Constant Field Values
      • PROPERTY_SESSION_INTERVAL

        public static final String PROPERTY_SESSION_INTERVAL
        Long property. default (60)

        How many seconds to wait before creating a new session

        See Also:
        Constant Field Values
      • PROPERTY_PROXY_ENABLE_JVM_PROXY

        public static final String PROPERTY_PROXY_ENABLE_JVM_PROXY
        Boolean property.

        Whether or not jclouds is permitted to use the default proxy detected by the JVM and configured there using the usual Java settings:

        • java.net.useSystemProxies
        • java.net.httpProxyHost
        • java.net.httpProxyPort

        Defaults to true so that the Java standard way of setting proxies can be used. However if PROPERTY_PROXY_HOST is set that will always take priority when jclouds looks for a proxy. If this property is explicitly set false, then jclouds will not use a proxy irrespective of the java.net.* settings, unless PROPERTY_PROXY_HOST is set or PROPERTY_PROXY_SYSTEM is true.

        See Also:
        Constant Field Values
      • PROPERTY_PROXY_HOST

        public static final String PROPERTY_PROXY_HOST
        String property.

        Explicitly sets the host name of a proxy server.

        See Also:
        Constant Field Values
      • PROPERTY_PROXY_TYPE

        public static final String PROPERTY_PROXY_TYPE
        String property. default HTTP, valid options: HTTP, SOCKS.

        Explicitly sets the type of a proxy server.

        See Also:
        Proxy.Type, Constant Field Values
      • PROPERTY_PROXY_USER

        public static final String PROPERTY_PROXY_USER
        String property.

        Explicitly sets the user name credential for proxy authentication. This only applies when PROPERTY_PROXY_HOST is supplied.

        See Also:
        Constant Field Values
      • PROPERTY_PROXY_PASSWORD

        public static final String PROPERTY_PROXY_PASSWORD
        String property.

        Explicitly sets the password credential for proxy authentication. This only applies when PROPERTY_PROXY_HOST is supplied.

        See Also:
        Constant Field Values
      • PROPERTY_PROXY_FOR_SOCKETS

        public static final String PROPERTY_PROXY_FOR_SOCKETS
        Boolean property. Default true.

        If a proxy server is configured, it will be used for all types of schemes. Set to false to not use a proxy server for sockets (such as ssh access).

        See Also:
        Constant Field Values
      • PROPERTY_MAX_RETRIES

        public static final String PROPERTY_MAX_RETRIES
        Integer property.

        Commands are retried, if the problem on the server side was a resolvable conflict. However, the maximum tries of a single command is bounded.

        See Also:
        Constant Field Values
      • PROPERTY_RETRY_DELAY_START

        public static final String PROPERTY_RETRY_DELAY_START
        Long property.

        Commands are retried, if the problem on the server side was a resolvable conflict. However, the maximum tries of a single command is bounded. If PROPERTY_MAX_RETRIES is greater than zero, this property is used to determine the start delay. The delay is based on exponential backoff algorithm. Default value for this property is 50 milliseconds.

        See Also:
        Constant Field Values
      • PROPERTY_MAX_REDIRECTS

        public static final String PROPERTY_MAX_REDIRECTS
        Integer property.

        Commands are limited to only a certain amount of redirects.

        See Also:
        Constant Field Values
      • PROPERTY_REQUEST_TIMEOUT

        public static final String PROPERTY_REQUEST_TIMEOUT
        Long property.

        Maximum duration in milliseconds a single request can take before throwing an exception.

        See Also:
        Constant Field Values
      • PROPERTY_RELAX_HOSTNAME

        public static final String PROPERTY_RELAX_HOSTNAME
        Boolean property.

        allow mismatch between hostname and ssl certificate. Set to true in DNS_based services like Amazon S3.

        See Also:
        Constant Field Values
      • PROPERTY_TRUST_ALL_CERTS

        public static final String PROPERTY_TRUST_ALL_CERTS
        Boolean property.

        trust self-signed certs

        See Also:
        Constant Field Values
      • PROPERTY_LOGGER_WIRE_LOG_SENSITIVE_INFO

        public static final String PROPERTY_LOGGER_WIRE_LOG_SENSITIVE_INFO
        Boolean property.

        true to allow logging of sensitive information like passwords in the wire log default value is false

        See Also:
        Constant Field Values
      • LOGGER_HTTP_HEADERS

        public static final String LOGGER_HTTP_HEADERS
        Name of the logger that records all http headers from the client and the server.
        See Also:
        Constant Field Values
      • LOGGER_HTTP_WIRE

        public static final String LOGGER_HTTP_WIRE
        Name of the logger that records the content sent to and from the server.
        See Also:
        Constant Field Values
      • LOGGER_SIGNATURE

        public static final String LOGGER_SIGNATURE
        Name of the logger that records the steps of the request signing process of the HTTP_service.
        See Also:
        Constant Field Values
      • PROPERTY_PROVIDER

        public static final String PROPERTY_PROVIDER
        String property.

        Explicitly identifies a provider of an api

        See Also:
        Constant Field Values
      • PROPERTY_API

        public static final String PROPERTY_API
        String property.

        Explicitly identifies the name of a product that a provider may run

        See Also:
        Constant Field Values
      • PROPERTY_API_VERSION

        public static final String PROPERTY_API_VERSION
        String property. default empty string

        Explicitly identifies the version of an api.

        See Also:
        Constant Field Values
      • PROPERTY_BUILD_VERSION

        public static final String PROPERTY_BUILD_VERSION
        String property.

        Explicitly identifies the build that the server jclouds connects to is running. For example, for virtualbox, the api version may be 4.1.8 while the build version is 4.1.8r75467.

        See Also:
        Constant Field Values
      • PROPERTY_ENDPOINT

        public static final String PROPERTY_ENDPOINT
        String property.

        Explicitly identifies the most top-level endpoint to a service provider. This helps differentiate two providers of the same api, or a different environments providing the same api.

        See Also:
        Constant Field Values
      • PROPERTY_IDENTITY

        public static final String PROPERTY_IDENTITY
        String property.

        Explicitly sets the login identity into a provider

        See Also:
        Constant Field Values
      • PROPERTY_ISO3166_CODES

        public static final String PROPERTY_ISO3166_CODES
        String property. default("")

        comma-delimited iso 3166 codes; ex. US-CA,US

        See Also:
        Location#getIso3166Codes, Constant Field Values
      • PROPERTY_CREDENTIAL

        public static final String PROPERTY_CREDENTIAL
        String property.

        Explicitly sets the secret, which when combined with the identity, will create an authenticated subject or session

        See Also:
        Constant Field Values
      • PROPERTY_TIMEOUTS_PREFIX

        public static final String PROPERTY_TIMEOUTS_PREFIX
        Long properties

        Overrides timeouts on sync interfaces. Timeout value is in ms. Here's an example of an override for a single method:

        #10 seconds
        jclouds.timeouts.S3Client.bucketExists=10000

        Or for all methods:

        jclouds.timeouts.GridServerClient = 350000

        See Also:
        Constant Field Values
      • PROPERTY_OUTPUT_SOCKET_BUFFER_SIZE

        public static final String PROPERTY_OUTPUT_SOCKET_BUFFER_SIZE
        Integer property. Default (32768).

        Buffer size for socket write (currently honored only by the default Java URL HTTP client, JavaUrlHttpCommandExcecutorService).

        See Also:
        Constant Field Values
      • PROPERTY_PRETTY_PRINT_PAYLOADS

        public static final String PROPERTY_PRETTY_PRINT_PAYLOADS
        Boolean property. Default (true).

        Configures the response parsers to pretty print the payload when possible.

        See Also:
        Constant Field Values
      • PROPERTY_STRIP_EXPECT_HEADER

        public static final String PROPERTY_STRIP_EXPECT_HEADER
        When true, strip the Expect: 100-continue header. Useful when interacting with providers that don't properly support Expect headers. Defaults to false.
        See Also:
        Constant Field Values
      • PROPERTY_USER_AGENT

        public static final String PROPERTY_USER_AGENT
        String property.

        This will override the user agent header in http request.

        See Also:
        Constant Field Values
      • PROPERTY_CONNECTION_CLOSE_HEADER

        public static final String PROPERTY_CONNECTION_CLOSE_HEADER
        When true, add the Connection: close header. Useful when interacting with providers that don't properly support persistent connections. Defaults to false.
        See Also:
        Constant Field Values
      • PROPERTY_MAX_PARALLEL_DELETES

        public static final String PROPERTY_MAX_PARALLEL_DELETES
        The maximum number of blob deletes happening in parallel at any point in time.
        See Also:
        Constant Field Values
      • PROPERTY_IDEMPOTENT_METHODS

        public static final String PROPERTY_IDEMPOTENT_METHODS
        Comma-separated list of methods considered idempotent for purposes of retries. By default jclouds uses DELETE,GET,HEAD,OPTIONS,PUT.
        See Also:
        Constant Field Values
      • PROPERTY_MAX_RATE_LIMIT_WAIT

        public static final String PROPERTY_MAX_RATE_LIMIT_WAIT
        Maximum amount of time (in milliseconds) a request will wait until retrying if the rate limit is exhausted.

        Default value: 2 minutes.

        See Also:
        Constant Field Values