Package com.elastisys.scale.cloudpool.openstack.driver.client

Class StandardOpenstackClient

java.lang.Object

com.elastisys.scale.cloudpool.openstack.driver.client.StandardOpenstackClient

All Implemented Interfaces:

OpenstackClient

public class StandardOpenstackClient
extends java.lang.Object
implements OpenstackClient

Standard implementation of the OpenstackClient interface.

Constructor Summary

Constructors

Constructor	Description
StandardOpenstackClient()

Method Summary

Modifier and Type	Method	Description
java.lang.String	assignFloatingIp(java.lang.String serverId)	Allocate a floating IP address and associate it with a given server.
com.elastisys.scale.commons.openstack.OSClientFactory	clientFactory()
void	configure(CloudApiSettings configuration)	Configures this OpenstackClient with cloud API access credentials and settings.
org.openstack4j.model.compute.Server	getServer(java.lang.String serverId)	Return meta data about a particular Server instance.
java.util.List<org.openstack4j.model.compute.Server>	getServers(java.lang.String tag, java.lang.String tagValue)	Retrieves all servers that match a given tag.
org.openstack4j.model.compute.Server	launchServer(java.lang.String serverName, ProvisioningTemplate provisioningDetails, java.util.Map<java.lang.String,java.lang.String> tags)	Launch a new server.
void	tagServer(java.lang.String serverId, java.util.Map<java.lang.String,java.lang.String> tags)	Adds meta data tags to a given server.
void	terminateServer(java.lang.String serverId)	Terminates a particular server.
void	untagServer(java.lang.String serverId, java.util.List<java.lang.String> tagKeys)	Removes a collection of meta data tags from a given server.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardOpenstackClient

public StandardOpenstackClient()

Method Detail

configure

public void configure(CloudApiSettings configuration)

Description copied from interface: OpenstackClient

Configures this OpenstackClient with cloud API access credentials and settings.

Specified by:

configure in interface OpenstackClient

Parameters:

configuration - API access credentials and settings.

getServers

public java.util.List<org.openstack4j.model.compute.Server> getServers(java.lang.String tag,
                                                                       java.lang.String tagValue)
                                                                throws org.openstack4j.api.exceptions.ResponseException

Description copied from interface: OpenstackClient

Retrieves all servers that match a given tag.

Specified by:

getServers in interface OpenstackClient

Parameters:

tag - A meta data tag that must be present on returned servers.

tagValue - The value for the meta data tag that must be present on returned servers.

Returns:

All Servers matching the filters.

Throws:

org.openstack4j.api.exceptions.ResponseException - On communication errors.

getServer

public org.openstack4j.model.compute.Server getServer(java.lang.String serverId)
                                               throws NotFoundException,
                                                      org.openstack4j.api.exceptions.ResponseException

Description copied from interface: OpenstackClient

Return meta data about a particular Server instance.

Specified by:

getServer in interface OpenstackClient

Parameters:

serverId - The identifier of the requested server.

Returns:

Server meta data.

Throws:

NotFoundException - if the server doesn't exist.

org.openstack4j.api.exceptions.ResponseException - On communication errors.

launchServer

public org.openstack4j.model.compute.Server launchServer(java.lang.String serverName,
                                                         ProvisioningTemplate provisioningDetails,
                                                         java.util.Map<java.lang.String,java.lang.String> tags)
                                                  throws org.openstack4j.api.exceptions.ResponseException

Description copied from interface: OpenstackClient

Launch a new server.

Specified by:

launchServer in interface OpenstackClient

Parameters:

serverName - The name to assign to the created server.

provisioningDetails - The provisioning details on how to launch the new server.

tags - Meta data tags to set on the launched server.

Returns:

The launched Server.

Throws:

org.openstack4j.api.exceptions.ResponseException - On communication errors.

assignFloatingIp

public java.lang.String assignFloatingIp(java.lang.String serverId)
                                  throws NotFoundException,
                                         org.openstack4j.api.exceptions.ResponseException

Description copied from interface: OpenstackClient

Allocate a floating IP address and associate it with a given server.

Specified by:

assignFloatingIp in interface OpenstackClient

Parameters:

serverId - The identifier of the server that will be assigned a floating IP address.

Returns:

The IP address that was assigned to the server.

Throws:

org.openstack4j.api.exceptions.ResponseException - On communication errors.

NotFoundException

terminateServer

public void terminateServer(java.lang.String serverId)
                     throws NotFoundException,
                            org.openstack4j.api.exceptions.ResponseException

Description copied from interface: OpenstackClient

Terminates a particular server.

Specified by:

terminateServer in interface OpenstackClient

Parameters:

serverId - Identifier of the server to be terminated.

Throws:

NotFoundException - if the server doesn't exist.

org.openstack4j.api.exceptions.ResponseException - On communication errors.

tagServer

public void tagServer(java.lang.String serverId,
                      java.util.Map<java.lang.String,java.lang.String> tags)
               throws org.openstack4j.api.exceptions.ResponseException

Description copied from interface: OpenstackClient

Adds meta data tags to a given server.

Specified by:

tagServer in interface OpenstackClient

Parameters:

serverId - Identifier of the server to be tagged.

tags - Meta data tags to set on the server.

Throws:

org.openstack4j.api.exceptions.ResponseException - On communication errors.

untagServer

public void untagServer(java.lang.String serverId,
                        java.util.List<java.lang.String> tagKeys)
                 throws org.openstack4j.api.exceptions.ResponseException

Description copied from interface: OpenstackClient

Removes a collection of meta data tags from a given server.

Specified by:

untagServer in interface OpenstackClient

Parameters:

serverId - Identifier of the server to be untagged.

Throws:

org.openstack4j.api.exceptions.ResponseException - On communication errors.

clientFactory

public com.elastisys.scale.commons.openstack.OSClientFactory clientFactory()