es.upv.i3m.grycap.im

Class InfrastructureManager

java.lang.Object

es.upv.i3m.grycap.im.InfrastructureManager

public class InfrastructureManager
extends Object

This class offers the user an API to communicate with the Infrastructure Manager.

Constructor Summary

Constructors

Constructor and Description
InfrastructureManager(String targetUrl, AuthorizationHeader authorizationHeader) Create a new IM client.
InfrastructureManager(String targetUrl, Path authFile) Create a new IM client.
InfrastructureManager(String targetUrl, String authorizationHeader) Create a new IM client.

Method Summary

Modifier and Type	Method and Description
InfrastructureUris	addResource(String infId, String radlFile, BodyContentType bodyContentType, boolean... context) Add the resources specified in the body contents to the infrastructure with ID 'infId'.
VirtualMachineInfo	alterVm(String infId, String vmId, String radlFile, BodyContentType bodyContentType) Change the features of the virtual machine with ID 'vmId' in the infrastructure with with ID 'infId', specified by the RADL document specified in the body contents. Return a RADL with information about the virtual machine, like GetVMInfo.
InfrastructureUri	createInfrastructure(String infrastructureDefinition, BodyContentType bodyContentType) Create and configure an infrastructure with the requirements specified in the document of the body contents. If success, it is returned the URI of the new infrastructure.
void	destroyInfrastructure(String infId) Undeploy the virtual machines associated to the infrastructure with ID 'infId'.
Property	getInfrastructureContMsg(String infId) Return the contextualization log associated to the infrastructure with ID 'infId'.
InfrastructureUris	getInfrastructureInfo(String infId) Return a list of URIs referencing the virtual machines associated to the infrastructure with ID 'infId'.
InfrastructureUris	getInfrastructureList() Return a list of URIs referencing the infrastructures associated to the IM user.
InfOutputValues	getInfrastructureOutputs(String infId) Return a class that includes the outputs defined in the TOSCA document.
Property	getInfrastructureRadl(String infId) Return a json with the original RADL specified to create the infrastructure with ID 'infId'.
InfrastructureState	getInfrastructureState(String infId) Return a JSON with the infrastructure and virtual machines states. The JSON has a 'vm_states' array describing the states of all the machines of the infrastructure and a 'state' that describes the general state of the infrastructure ( e.g.
VirtualMachineInfo	getVmInfo(String infId, String vmId) Return information about the virtual machine with ID vmId associated to the infrastructure with ID infId.
Property	getVmProperty(String infId, String vmId, VmProperties vmProperty) Return property 'propertyName' from to the virtual machine with ID 'vmId' associated to the infrastructure with ID 'infId'.
void	reconfigure(String infId) Perform the reconfigure action in all the virtual machines in the the infrastructure with ID 'infID'. This method starts the contextualization process again. To reconfigure the VMs see the reconfigure methods that include the 'radl' parameter.
void	reconfigure(String infId, String radlFile, BodyContentType bodyContentType) Perform the reconfigure action in all the virtual machines of the infrastructure with ID 'infID.' It updates the configuration of the infrastructure as indicated in the 'radlFile'.
void	reconfigure(String infId, String radlFile, BodyContentType bodyContentType, List<Integer> vmList) Perform the reconfigure action in all the virtual machines of the infrastructure with ID 'infID.' It updates the configuration of the infrastructure as indicated in the 'radlFile'.
void	removeResource(String infId, List<String> vmIds, boolean... context) Undeploy the virtual machine with ID 'vmId' associated to the infrastructure with ID 'infId'.
void	removeResource(String infId, String vmId, boolean... context) Undeploy the virtual machine with ID vmId associated to the infrastructure with ID 'infId'. The context parameter is optional and is a flag to specify if the contextualization step will be launched just after the VM addition. As default the contextualization flag is set to True.
void	startInfrastructure(String infId) Resume all the virtual machines associated to the infrastructure with ID 'infId', previously stopped with the 'stopInfrastructure' method.
void	startVm(String infId, String vmId) Perform the 'start' action in the virtual machine with ID 'vmId' associated to the infrastructure with ID 'infId'.
void	stopInfrastructure(String infId) Stop (but do not undeploy) all the virtual machines associated to the infrastructure with ID 'infId'.
void	stopVm(String infId, String vmId) Perform the 'stop' action in the virtual machine with ID 'vmId' associated to the infrastructure with ID 'infId'.

Methods inherited from class java.lang.Object

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

Constructor Detail

InfrastructureManager

public InfrastructureManager(String targetUrl,
                             Path authFile)
                      throws ImClientException

Create a new IM client.

Parameters:

targetUrl - : the URL where the REST API of the IM is defined

authFile - : the authorization file

Throws:

ImClientException

InfrastructureManager

public InfrastructureManager(String targetUrl,
                             String authorizationHeader)
                      throws ImClientException

Create a new IM client.

Parameters:

targetUrl - : the URL where the REST API of the IM is defined

authorizationHeader - : string with the authorization content

Throws:

ImClientException

InfrastructureManager

public InfrastructureManager(String targetUrl,
                             AuthorizationHeader authorizationHeader)
                      throws ImClientException

Create a new IM client.

Parameters:

targetUrl - : the URL where the REST API of the IM is defined

authorizationHeader - : AuthorizationHeader with the authorization content

Throws:

ImClientException

Method Detail

createInfrastructure

public InfrastructureUri createInfrastructure(String infrastructureDefinition,
                                              BodyContentType bodyContentType)
                                       throws ImClientException

Create and configure an infrastructure with the requirements specified in the document of the body contents.
If success, it is returned the URI of the new infrastructure.

Parameters:

infrastructureDefinition - : file with the virtual machine properties and configuration

bodyContentType - : set the body content type. Can be RADL, RADL_JSON or TOSCA.

Returns:

: URI of the new infrastructure

Throws:

ImClientException

getInfrastructureList

public InfrastructureUris getInfrastructureList()
                                         throws ImClientException

Return a list of URIs referencing the infrastructures associated to the IM user.

Throws:

ImClientException

getInfrastructureInfo

public InfrastructureUris getInfrastructureInfo(String infId)
                                         throws ImClientException

Return a list of URIs referencing the virtual machines associated to the infrastructure with ID 'infId'.

Parameters:

infId - : infrastructure id

Throws:

ImClientException

getVmInfo

public VirtualMachineInfo getVmInfo(String infId,
                                    String vmId)
                             throws ImClientException

Return information about the virtual machine with ID vmId associated to the infrastructure with ID infId.

Parameters:

infId - : infrastructure id

vmId - : virtual machine id

Returns:

: POJO with the vm info.

Throws:

ImClientException

getVmProperty

public Property getVmProperty(String infId,
                              String vmId,
                              VmProperties vmProperty)
                       throws ImClientException

Return property 'propertyName' from to the virtual machine with ID 'vmId' associated to the infrastructure with ID 'infId'.

Parameters:

infId - : infrastructure id

vmId - : virtual machine id

vmProperty - : VM property to retrieve from the virtual machine

Throws:

ImClientException

getInfrastructureContMsg

public Property getInfrastructureContMsg(String infId)
                                  throws ImClientException

Return the contextualization log associated to the infrastructure with ID 'infId'.

Parameters:

infId - : infrastructure id

Throws:

ImClientException

getInfrastructureRadl

public Property getInfrastructureRadl(String infId)
                               throws ImClientException

Return a json with the original RADL specified to create the infrastructure with ID 'infId'.

Parameters:

infId - : infrastructure id

Throws:

ImClientException

getInfrastructureState

public InfrastructureState getInfrastructureState(String infId)
                                           throws ImClientException

Return a JSON with the infrastructure and virtual machines states.
The JSON has a 'vm_states' array describing the states of all the machines of the infrastructure and a 'state' that describes the general state of the infrastructure ( e.g. {"vm_states": {"144838424585": "running"}, "state": "running"} ).

Parameters:

infId - : infrastructure id

Returns:

: json with the infrastructure state

Throws:

ImClientException

destroyInfrastructure

public void destroyInfrastructure(String infId)
                           throws ImClientException

Undeploy the virtual machines associated to the infrastructure with ID 'infId'.

Parameters:

infId - : infrastructure id

Throws:

ImClientException

addResource

public InfrastructureUris addResource(String infId,
                                      String radlFile,
                                      BodyContentType bodyContentType,
                                      boolean... context)
                               throws ImClientException

Add the resources specified in the body contents to the infrastructure with ID 'infId'. The RADL restrictions are the same as in RPC-XML AddResource
If success, it is returned a list of URIs of the new virtual machines.
The context parameter is optional and is a flag to specify if the contextualization step will be launched just after the VM addition.
If not specified the contextualization flag is set to True.

Parameters:

infId - : infrastructure id

radlFile - : file with the virtual machine properties and configuration

bodyContentType - : set the body content type. Can be RADL, RADL_JSON or TOSCA.

context - : flag to specify if the contextualization step will be launched just after the VM addition

Returns:

: list of URIs of the new virtual machines

Throws:

ImClientException

removeResource

public void removeResource(String infId,
                           List<String> vmIds,
                           boolean... context)
                    throws ImClientException

Undeploy the virtual machine with ID 'vmId' associated to the infrastructure with ID 'infId'.
The context parameter is optional and is a flag to specify if the contextualization step will be launched just after the VM addition.
As default the contextualization flag is set to True.

Parameters:

infId - : infrastructure id

vmIds - : list of virtual machine ids

context - : flag to specify if the contextualization step will be launched just after the VM addition

Throws:

ImClientException - : exception in the IM client

removeResource

public void removeResource(String infId,
                           String vmId,
                           boolean... context)
                    throws ImClientException

Undeploy the virtual machine with ID vmId associated to the infrastructure with ID 'infId'.
The context parameter is optional and is a flag to specify if the contextualization step will be launched just after the VM addition.
As default the contextualization flag is set to True.

Parameters:

infId - : infrastructure id

vmId - : virtual machine id

context - : flag to specify if the contextualization step will be launched just after the VM addition

Throws:

ImClientException

stopInfrastructure

public void stopInfrastructure(String infId)
                        throws ImClientException

Stop (but do not undeploy) all the virtual machines associated to the infrastructure with ID 'infId'. They can be resumed by the 'startInfrastructure' method.

Parameters:

infId - : infrastructure id

Throws:

ImClientException

startInfrastructure

public void startInfrastructure(String infId)
                         throws ImClientException

Resume all the virtual machines associated to the infrastructure with ID 'infId', previously stopped with the 'stopInfrastructure' method.

Parameters:

infId - : infrastructure id

Throws:

ImClientException

stopVm

public void stopVm(String infId,
                   String vmId)
            throws ImClientException

Perform the 'stop' action in the virtual machine with ID 'vmId' associated to the infrastructure with ID 'infId'.

Parameters:

infId - : infrastructure id

vmId - : virtual machine id

Throws:

ImClientException

startVm

public void startVm(String infId,
                    String vmId)
             throws ImClientException

Perform the 'start' action in the virtual machine with ID 'vmId' associated to the infrastructure with ID 'infId'.

Parameters:

infId - : infrastructure id

vmId - : virtual machine id

Throws:

ImClientException

alterVm

public VirtualMachineInfo alterVm(String infId,
                                  String vmId,
                                  String radlFile,
                                  BodyContentType bodyContentType)
                           throws ImClientException

Change the features of the virtual machine with ID 'vmId' in the infrastructure with with ID 'infId', specified by the RADL document specified in the body contents.
Return a RADL with information about the virtual machine, like GetVMInfo.

Parameters:

infId - : infrastructure id

vmId - : virtual machine id

radlFile - : file with the virtual machine properties and configuration

bodyContentType - : set the body content type. Can be RADL or RADL_JSON

Returns:

: POJO with information about the virtual machine modified

Throws:

ImClientException

reconfigure

public void reconfigure(String infId)
                 throws ImClientException

Perform the reconfigure action in all the virtual machines in the the infrastructure with ID 'infID'.
This method starts the contextualization process again.
To reconfigure the VMs see the reconfigure methods that include the 'radl' parameter.

Parameters:

infId - : infrastructure id

Throws:

ImClientException

reconfigure

public void reconfigure(String infId,
                        String radlFile,
                        BodyContentType bodyContentType)
                 throws ImClientException

Perform the reconfigure action in all the virtual machines of the infrastructure with ID 'infID.' It updates the configuration of the infrastructure as indicated in the 'radlFile'. The RADL restrictions are the same as in RPC-XML Reconfigure
If no RADL is specified, the contextualization process is started again.

Parameters:

infId - : infrastructure id

radlFile - : file with the infrastructure properties and configuration

bodyContentType - : set the body content type. Can be RADL or RADL_JSON

Throws:

ImClientException

reconfigure

public void reconfigure(String infId,
                        String radlFile,
                        BodyContentType bodyContentType,
                        List<Integer> vmList)
                 throws ImClientException

Perform the reconfigure action in all the virtual machines of the infrastructure with ID 'infID.' It updates the configuration of the infrastructure as indicated in the 'radlFile'. The RADL restrictions are the same as in RPC-XML Reconfigure
If no RADL is specified, the contextualization process is started again.

Parameters:

infId - : infrastructure id

radlFile - : file with the infrastructure properties and configuration

bodyContentType - : set the body content type. Can be RADL or RADL_JSON

vmList - : comma separated list of IDs of the VMs to reconfigure. If not specified all the VMs will be reconfigured.

Throws:

ImClientException

getInfrastructureOutputs

public InfOutputValues getInfrastructureOutputs(String infId)
                                         throws ImClientException

Return a class that includes the outputs defined in the TOSCA document.

Parameters:

infId - : infrastructure id

Returns:

: InfrastructureStatus class with an internal map containing the outputs

Throws:

ImClientException