com.oracle.cloud.compute.jenkins.client

Interface ComputeCloudClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AutoAuthComputeCloudClient, CachingComputeCloudClient, JaxrsComputeCloudClient, ProxyComputeCloudClient

public interface ComputeCloudClient
extends AutoCloseable

Stateful connection to an endpoint server. Implementations are not safe for use by multiple threads by default.

Method Summary

Modifier and Type	Method and Description
void	authenticate() Authenticates the client and stores an authentication token to allow other methods to be called.
void	close() Closes the client connection.
void	createInstanceOrchestration(String name, ComputeCloudInstanceOrchestrationConfig params) Creates an orchestration with the specified name that contains a launchplan for an instance with the specified configuration.
void	deleteOrchestration(String name) Deletes an orchestration with the specified name.
Collection<ImageListEntry>	getImageListEntries(String imageListName) Retrieves imagelist entries for a specified imagelist
Collection<ImageList>	getImageLists(ImageListSourceType sourceType) Retrieve the list of imagelist according to source type
InstanceOrchestration	getInstanceOrchestration(String name) Gets a subset of properties from an instance orchestration created from createInstanceOrchestration(java.lang.String, com.oracle.cloud.compute.jenkins.client.ComputeCloudInstanceOrchestrationConfig)
Collection<SecurityList>	getSecurityLists() Retrieves the security lists
Collection<Shape>	getShapes() Retrieves the CPU and memory details of all the available shapes.
SSHKey	getSSHKey(String name) Retrieves an SSH key of the current user.
Collection<SSHKey>	getSSHKeys() Retrieves the SSH keys of the current user.
void	startOrchestration(String name) Starts an orchestration with the specified name.
void	stopOrchestration(String name) Stops an orchestration with the specified name.

Method Detail

close

void close()

Closes the client connection.

Specified by:

close in interface AutoCloseable

authenticate

void authenticate()
           throws ComputeCloudClientException

Authenticates the client and stores an authentication token to allow other methods to be called.

Throws:

ComputeCloudClientUnauthorizedException - if authentication failed

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getShapes

Collection<Shape> getShapes()
                     throws ComputeCloudClientException

Retrieves the CPU and memory details of all the available shapes. The resulting objects should be considered immutable.

Returns:

the collection of available Shape objects

Throws:

IllegalStateException - if authenticate() was not called

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getImageLists

Collection<ImageList> getImageLists(ImageListSourceType sourceType)
                             throws ComputeCloudClientException

Retrieve the list of imagelist according to source type

Parameters:

sourceType: - Oracle Public Image Customer Private Image

Returns:

the collection of ImageList

Throws:

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getImageListEntries

Collection<ImageListEntry> getImageListEntries(String imageListName)
                                        throws ComputeCloudClientException

Retrieves imagelist entries for a specified imagelist

Parameters:

imageListName - ImageList name which used to get related versions

Returns:

the collection of ImageListEntry

Throws:

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getSecurityLists

Collection<SecurityList> getSecurityLists()
                                   throws ComputeCloudClientException

Retrieves the security lists

Returns:

the collection of SecurityList

Throws:

IllegalStateException - if authenticate() was not called

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getSSHKeys

Collection<SSHKey> getSSHKeys()
                       throws ComputeCloudClientException

Retrieves the SSH keys of the current user.

Returns:

the collection of SSHKey

Throws:

IllegalStateException - if authenticate() was not called

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getSSHKey

SSHKey getSSHKey(String name)
          throws ComputeCloudClientException

Retrieves an SSH key of the current user.

Parameters:

name - of SSH key

Returns:

the SSH key, or null if not found

Throws:

IllegalStateException - if authenticate() was not called

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server

createInstanceOrchestration

void createInstanceOrchestration(String name,
                                 ComputeCloudInstanceOrchestrationConfig params)
                          throws ComputeCloudClientException

Creates an orchestration with the specified name that contains a launchplan for an instance with the specified configuration.

Parameters:

name - the orchestration name

params - the instance configuration

Throws:

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getInstanceOrchestration

InstanceOrchestration getInstanceOrchestration(String name)
                                        throws ComputeCloudClientException

Gets a subset of properties from an instance orchestration created from createInstanceOrchestration(java.lang.String, com.oracle.cloud.compute.jenkins.client.ComputeCloudInstanceOrchestrationConfig)

Parameters:

name - the orchestration name

Returns:

the InstanceOrchestration instance with the specified name

Throws:

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server

startOrchestration

void startOrchestration(String name)
                 throws ComputeCloudClientException

Starts an orchestration with the specified name.

Parameters:

name - the orchestration name

Throws:

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server

stopOrchestration

void stopOrchestration(String name)
                throws ComputeCloudClientException

Stops an orchestration with the specified name.

Parameters:

name - the orchestration name

Throws:

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server

deleteOrchestration

void deleteOrchestration(String name)
                  throws ComputeCloudClientException

Deletes an orchestration with the specified name.

Parameters:

name - the orchestration name

Throws:

ComputeCloudClientUnauthorizedException - if the authentication token has timed out or the user is not authorized

ComputeCloudClientException - if an error occurs communicating with the endpoint server