org.jclouds
Interface Constants


public interface Constants

Constants used in jclouds services.

Author:
Adrian Cole

Field Summary
static String LOGGER_HTTP_HEADERS
          Name of the logger that records all http headers from the client and the server.
static String LOGGER_HTTP_WIRE
          Name of the logger that records the content sent to and from the server.
static String LOGGER_SIGNATURE
          Name of the logger that records the steps of the request signing process of the HTTP_service.
static String PROPERTY_API
          String property.
static String PROPERTY_API_VERSION
          String property.
static String PROPERTY_BUILD_VERSION
          String property.
static String PROPERTY_CONNECTION_TIMEOUT
          Long property.
static String PROPERTY_CREDENTIAL
          String property.
static String PROPERTY_ENDPOINT
          String property.
static String PROPERTY_IDENTITY
          String property.
static String PROPERTY_IO_WORKER_THREADS
          Integer property.
static String PROPERTY_ISO3166_CODES
          String property.
static String PROPERTY_MAX_CONNECTION_REUSE
          Integer property.
static String PROPERTY_MAX_CONNECTIONS_PER_CONTEXT
          Integer property.
static String PROPERTY_MAX_CONNECTIONS_PER_HOST
          Integer property.
static String PROPERTY_MAX_REDIRECTS
          Integer property.
static String PROPERTY_MAX_RETRIES
          Integer property.
static String PROPERTY_MAX_SESSION_FAILURES
          Integer property.
static String PROPERTY_PROVIDER
          String property.
static String PROPERTY_PROXY_HOST
          String property.
static String PROPERTY_PROXY_PASSWORD
          String property.
static String PROPERTY_PROXY_PORT
          Integer property.
static String PROPERTY_PROXY_SYSTEM
          Boolean property.
static String PROPERTY_PROXY_USER
          String property.
static String PROPERTY_RELAX_HOSTNAME
          Boolean property.
static String PROPERTY_REQUEST_TIMEOUT
          Long property.
static String PROPERTY_RETRY_DELAY_START
          Long property.
static String PROPERTY_SESSION_INTERVAL
          Long property.
static String PROPERTY_SO_TIMEOUT
          int property.
static String PROPERTY_TIMEOUTS_PREFIX
          Long properties

Overrides timeouts on sync interfaces.

static String PROPERTY_TRUST_ALL_CERTS
          Boolean property.
static String PROPERTY_USER_THREADS
          Integer property.
 

Field Detail

PROPERTY_USER_THREADS

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

static final String PROPERTY_IO_WORKER_THREADS
Integer property. default (20)

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

See Also:
Constant Field Values

PROPERTY_MAX_CONNECTIONS_PER_CONTEXT

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_CONNECTIONS_PER_HOST

static final String PROPERTY_MAX_CONNECTIONS_PER_HOST
Integer property. default (0)

Limits the amount of connections per host. 0 means indirectly limited by PROPERTY_MAX_CONNECTIONS_PER_CONTEXT.

See Also:
Constant Field Values

PROPERTY_MAX_SESSION_FAILURES

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

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

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

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

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_SYSTEM

static final String PROPERTY_PROXY_SYSTEM
Boolean property.

Whether or not to use the proxy setup from the underlying operating system.

See Also:
Constant Field Values

PROPERTY_PROXY_HOST

static final String PROPERTY_PROXY_HOST
String property.

Explicitly sets the host name of a HTTP proxy server.

See Also:
Constant Field Values

PROPERTY_PROXY_PORT

static final String PROPERTY_PROXY_PORT
Integer property.

Explicitly sets the port number of a HTTP proxy server.

See Also:
Constant Field Values

PROPERTY_PROXY_USER

static final String PROPERTY_PROXY_USER
String property.

Explicitly sets the user name credential for proxy authentication.

See Also:
Constant Field Values

PROPERTY_PROXY_PASSWORD

static final String PROPERTY_PROXY_PASSWORD
String property.

Explicitly sets the password credential for proxy authentication.

See Also:
Constant Field Values

PROPERTY_MAX_RETRIES

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

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

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

static final String PROPERTY_REQUEST_TIMEOUT
Long property.

longest time a single request can take before throwing an exception.

See Also:
Constant Field Values

PROPERTY_RELAX_HOSTNAME

static final String PROPERTY_RELAX_HOSTNAME
Boolean property.

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

See Also:
Constant Field Values

PROPERTY_TRUST_ALL_CERTS

static final String PROPERTY_TRUST_ALL_CERTS
Boolean property.

trust self-signed certs

See Also:
Constant Field Values

LOGGER_HTTP_HEADERS

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

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

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

static final String PROPERTY_PROVIDER
String property.

Explicitly identifies a provider of an api

See Also:
Constant Field Values

PROPERTY_API

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

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

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. Or a vcloud endpoint may be api version 1.0 while the build is 1.5.0.0.124312

See Also:
Constant Field Values

PROPERTY_ENDPOINT

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

static final String PROPERTY_IDENTITY
String property.

Explicitly sets the login identity into a provider

See Also:
Constant Field Values

PROPERTY_ISO3166_CODES

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

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

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


Copyright © 2009-2012 jclouds. All Rights Reserved.