org.openstack4j.openstack.internal

Class OSClientSession

java.lang.Object

org.openstack4j.openstack.internal.OSClientSession

All Implemented Interfaces:

EndpointTokenProvider, OSClient

public class OSClientSession
extends Object
implements OSClient, EndpointTokenProvider

A client which has been identified. Any calls spawned from this session will automatically utilize the original authentication that was successfully validated and authorized

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
BlockStorageService	blockStorage() Returns the Block Storage Service API
ComputeService	compute() Returns the Compute Service API
static OSClientSession	createSession(Access access)
static OSClientSession	createSession(Access access, Facing perspective, Config config)
Access	getAccess()
Config	getConfig()
static OSClientSession	getCurrent()
String	getEndpoint() Gets the current endpoint of the Identity service
String	getEndpoint(ServiceType service) Gets the endpoint for the specified ServiceType
Facing	getPerspective()
Set<ServiceType>	getSupportedServices() Gets the supported services.
Token	getToken() Gets the token that was assigned during authorization
String	getTokenId() Gets the token identifier
HeatService	heat() Returns the Heat Service API
IdentityService	identity() Returns the Identity Service API
ImageService	images() Returns the Image Service API
NetworkingService	networking() Returns the Networking Service API
ObjectStorageService	objectStorage() Returns the Object Storage Service API
OSClient	perspective(Facing perspective) Changes the Perspective for the current Session (Client)
OSClient	removeRegion() Removes the current region making all calls no longer resolving to region (if originally set otherwise no-op)
SaharaService	sahara() Returns the Sahara Service API
boolean	supportsBlockStorage() Determines if the Block Storage (Cinder) service is supported
boolean	supportsCompute() Determines if the Compute (Nova) service is supported
boolean	supportsHeat() Determines if the Orchestration (Heat) service is supported
boolean	supportsIdentity() Determines if the Identity (Keystone) service is supported
boolean	supportsImage() Determines if the Image (Glance) service is supported
boolean	supportsNetwork() Determines if the Network (Neutron) service is supported
boolean	supportsObjectStorage() Determines if the Object Storage (Swift) service is supported
TelemetryService	telemetry() Returns the Telemetry Service API
OSClient	useRegion(String region) Specifies the region that should be used for further invocations with this client.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createSession

public static OSClientSession createSession(Access access)

createSession

public static OSClientSession createSession(Access access,
                                            Facing perspective,
                                            Config config)

getCurrent

public static OSClientSession getCurrent()

useRegion

public OSClient useRegion(String region)

Specifies the region that should be used for further invocations with this client. If the region is invalid or doesn't exists execution errors will occur when invoking API calls and a RegionEndpointNotFoundException will be thrown

Specified by:

useRegion in interface OSClient

Parameters:

region - the region to use

Returns:

OSClient for method chaining

removeRegion

public OSClient removeRegion()

Removes the current region making all calls no longer resolving to region (if originally set otherwise no-op)

Specified by:

removeRegion in interface OSClient

Returns:

OSClient for method chaining

getSupportedServices

public Set<ServiceType> getSupportedServices()

Gets the supported services. A set of ServiceTypes will be returned identifying the OpenStack services installed and supported

Specified by:

getSupportedServices in interface OSClient

Returns:

the supported services

getPerspective

public Facing getPerspective()

Returns:

the current perspective

supportsCompute

public boolean supportsCompute()

Determines if the Compute (Nova) service is supported

Specified by:

supportsCompute in interface OSClient

Returns:

true, if supports compute

supportsIdentity

public boolean supportsIdentity()

Determines if the Identity (Keystone) service is supported

Specified by:

supportsIdentity in interface OSClient

Returns:

true, if supports identity

supportsNetwork

public boolean supportsNetwork()

Determines if the Network (Neutron) service is supported

Specified by:

supportsNetwork in interface OSClient

Returns:

true, if supports network

supportsImage

public boolean supportsImage()

Determines if the Image (Glance) service is supported

Specified by:

supportsImage in interface OSClient

Returns:

true, if supports image

supportsHeat

public boolean supportsHeat()

Determines if the Orchestration (Heat) service is supported

Specified by:

supportsHeat in interface OSClient

Returns:

true if supports Heat

supportsBlockStorage

public boolean supportsBlockStorage()

Determines if the Block Storage (Cinder) service is supported

Specified by:

supportsBlockStorage in interface OSClient

Returns:

true if supports Block Storage

supportsObjectStorage

public boolean supportsObjectStorage()

Determines if the Object Storage (Swift) service is supported

Specified by:

supportsObjectStorage in interface OSClient

Returns:

true if supports Object Storage

getToken

public Token getToken()

Gets the token that was assigned during authorization

Specified by:

getToken in interface OSClient

Returns:

the authentication token

getEndpoint

public String getEndpoint()

Gets the current endpoint of the Identity service

Specified by:

getEndpoint in interface OSClient

Returns:

the endpoint

getEndpoint

public String getEndpoint(ServiceType service)

Gets the endpoint for the specified ServiceType

Specified by:

getEndpoint in interface EndpointTokenProvider

Parameters:

service - the service to obtain the endpoint for

Returns:

the endpoint

getConfig

public Config getConfig()

Returns:

the original client configuration associated with this session

getTokenId

public String getTokenId()

Gets the token identifier

Specified by:

getTokenId in interface EndpointTokenProvider

Returns:

the auth token identifier

identity

public IdentityService identity()

Returns the Identity Service API

Specified by:

identity in interface OSClient

Returns:

the identity service

compute

public ComputeService compute()

Returns the Compute Service API

Specified by:

compute in interface OSClient

Returns:

the compute service

networking

public NetworkingService networking()

Returns the Networking Service API

Specified by:

networking in interface OSClient

Returns:

the networking service

images

public ImageService images()

Returns the Image Service API

Specified by:

images in interface OSClient

Returns:

the image service

getAccess

public Access getAccess()

Specified by:

getAccess in interface OSClient

Returns:

the authorized access entity which contains the authorized token, user details and service catalog

blockStorage

public BlockStorageService blockStorage()

Returns the Block Storage Service API

Specified by:

blockStorage in interface OSClient

Returns:

the block storage service

telemetry

public TelemetryService telemetry()

Returns the Telemetry Service API

Specified by:

telemetry in interface OSClient

Returns:

the telemetry service

heat

public HeatService heat()

Returns the Heat Service API

Specified by:

heat in interface OSClient

Returns:

the Heat service

objectStorage

public ObjectStorageService objectStorage()

Returns the Object Storage Service API

Specified by:

objectStorage in interface OSClient

Returns:

the object storage service

sahara

public SaharaService sahara()

Returns the Sahara Service API

Specified by:

sahara in interface OSClient

Returns:

the Sahara service

perspective

public OSClient perspective(Facing perspective)

Description copied from interface: OSClient

Changes the Perspective for the current Session (Client)

Specified by:

perspective in interface OSClient

Parameters:

perspective - the new perspective

Returns:

OSClient for method chaining