org.jclouds

Interface Context

All Superinterfaces:

AutoCloseable, Closeable, Location

All Known Subinterfaces:

RestContext<S,A>, VCloudDirectorContext

All Known Implementing Classes:

ContextImpl, RestContextImpl, VCloudDirectorContextImpl

public interface Context
extends Location, Closeable

Represents an authenticated context to the cloud.

Note

Please issue close() when you are finished with this context in order to release resources.

Author:

Adrian Cole

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes all connections, including executor service
Map<String,Credentials>	credentialStore() Deprecated.
String	getApiVersion() Deprecated.
String	getBuildVersion() Deprecated.
Map<String,Credentials>	getCredentialStore() Deprecated.
URI	getEndpoint() Deprecated.
String	getIdentity()
String	getName() Identifies the Context.
ProviderMetadata	getProviderMetadata()
Utils	getUtils()
Utils	utils()

Methods inherited from interface org.jclouds.domain.Location

getDescription, getId, getIso3166Codes, getMetadata, getParent, getScope

Method Detail

getName

String getName()

Identifies the Context. This is a unique name optionally specified by the user and safe to index on. The purpose of this property is to provide means to distinct between multiple contexts, without having to check multiple properties or have explicit knowledge of how the context was created.

Returns:

getCredentialStore

@Deprecated
@Beta
Map<String,Credentials> getCredentialStore()

Deprecated.

will be removed in jclouds 1.6

See Also:

Utils.getCredentialStore()

credentialStore

@Deprecated
@Beta
Map<String,Credentials> credentialStore()

Deprecated.

will be removed in jclouds 1.6

See Also:

Utils.credentialStore()

getProviderMetadata

ProviderMetadata getProviderMetadata()

Returns:

the providerMetadata used to create this context

See Also:

ContextBuilder.newBuilder(org.jclouds.providers.ProviderMetadata)

getIdentity

String getIdentity()

Returns:

the current login user, access key, email, or whatever the 'identity' field was building the context.

See Also:

ApiMetadata.getDefaultIdentity()

getEndpoint

@Deprecated
URI getEndpoint()

Deprecated.

will be removed in jclouds 1.6

See Also:

getProviderMetadata(), ProviderMetadata.getEndpoint()

getApiVersion

@Deprecated
String getApiVersion()

Deprecated.

will be removed in jclouds 1.6

See Also:

getProviderMetadata(), ProviderMetadata.getApiMetadata(), ApiMetadata.getVersion()

getBuildVersion

@Deprecated
@Nullable
String getBuildVersion()

Deprecated.

will be removed in jclouds 1.6

See Also:

getProviderMetadata(), ProviderMetadata.getApiMetadata(), ApiMetadata.getBuildVersion()

getUtils

Utils getUtils()

utils

Utils utils()

See Also:

getUtils()

close

void close()

Closes all connections, including executor service

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable