com.oracle.cloud.compute.jenkins.client

Class JaxrsComputeCloudClient

java.lang.Object

com.oracle.cloud.compute.jenkins.client.JaxrsComputeCloudClient

All Implemented Interfaces:

ComputeCloudClient, AutoCloseable

public class JaxrsComputeCloudClient
extends Object
implements ComputeCloudClient

An implementation of ComputeCloudClient using the JAX-RS client API.

Constructor Summary

Constructors

Constructor and Description
JaxrsComputeCloudClient(URI apiEndpoint, ComputeCloudUser user, String password, javax.ws.rs.client.Client client)

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 ComputeCloudClient.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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JaxrsComputeCloudClient

public JaxrsComputeCloudClient(URI apiEndpoint,
                               ComputeCloudUser user,
                               String password,
                               javax.ws.rs.client.Client client)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Description copied from interface: ComputeCloudClient

Closes the client connection.

Specified by:

close in interface ComputeCloudClient

Specified by:

close in interface AutoCloseable

authenticate

public void authenticate()
                  throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

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

Specified by:

authenticate in interface ComputeCloudClient

Throws:

ComputeCloudClientUnauthorizedException - if authentication failed

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getShapes

public Collection<Shape> getShapes()
                            throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

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

Specified by:

getShapes in interface ComputeCloudClient

Returns:

the collection of available Shape objects

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

getSecurityLists

public Collection<SecurityList> getSecurityLists()
                                          throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

Retrieves the security lists

Specified by:

getSecurityLists in interface ComputeCloudClient

Returns:

the collection of SecurityList

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

getSSHKeys

public Collection<SSHKey> getSSHKeys()
                              throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

Retrieves the SSH keys of the current user.

Specified by:

getSSHKeys in interface ComputeCloudClient

Returns:

the collection of SSHKey

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

getSSHKey

public SSHKey getSSHKey(String name)
                 throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

Retrieves an SSH key of the current user.

Specified by:

getSSHKey in interface ComputeCloudClient

Parameters:

name - of SSH key

Returns:

the SSH key, or null if not found

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

getImageLists

public Collection<ImageList> getImageLists(ImageListSourceType sourceType)
                                    throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

Retrieve the list of imagelist according to source type

Specified by:

getImageLists in interface ComputeCloudClient

Returns:

the collection of ImageList

Throws:

ComputeCloudClientException - if an error occurs communicating with the endpoint server

getImageListEntries

public Collection<ImageListEntry> getImageListEntries(String imageListName)
                                               throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

Retrieves imagelist entries for a specified imagelist

Specified by:

getImageListEntries in interface ComputeCloudClient

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

createInstanceOrchestration

public void createInstanceOrchestration(String name,
                                        ComputeCloudInstanceOrchestrationConfig params)
                                 throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

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

Specified by:

createInstanceOrchestration in interface ComputeCloudClient

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

public InstanceOrchestration getInstanceOrchestration(String name)
                                               throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

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

Specified by:

getInstanceOrchestration in interface ComputeCloudClient

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

public void startOrchestration(String name)
                        throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

Starts an orchestration with the specified name.

Specified by:

startOrchestration in interface ComputeCloudClient

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

public void stopOrchestration(String name)
                       throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

Stops an orchestration with the specified name.

Specified by:

stopOrchestration in interface ComputeCloudClient

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

public void deleteOrchestration(String name)
                         throws ComputeCloudClientException

Description copied from interface: ComputeCloudClient

Deletes an orchestration with the specified name.

Specified by:

deleteOrchestration in interface ComputeCloudClient

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