GroupManagerAPI (snoozecommon 2.0.0 API)

All Known Implementing Classes:

RESTletGroupManagerCommunicator
```
public interface GroupManagerAPI
```
Group manager resource interface.

Author:

Eugen Feller

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addVirtualMachineAfterMigration(VirtualMachineMetaData virtualMachine)` Request to add a new virtual machine after a successful migration.
`AssignedGroupManager`	`assignLocalController(LocalControllerDescription localControllerDescription)` Assign local controller to a group manager.
`boolean`	`destroyVirtualMachine(VirtualMachineLocation location)` Routine to shutdown a virtual machine.
`VirtualMachineDiscoveryResponse`	`discoverVirtualMachine(String virtualMachineId)` Routine to discover the group manager hosting a virtual machine.
`boolean`	`dropVirtualMachineMetaData(VirtualMachineLocation virtualMachineLocation)` Drops virtual machine met data.
`GroupLeaderRepositoryInformation`	`getGroupLeaderRepositoryInformation(int numberOfMonitoringEntries)` Routine the group leader information.
`GroupManagerDescription`	`getGroupManagerDescription(String groupManagerId)` Gets a groupManager description from the groupLeader.
`GroupManagerRepositoryInformation`	`getGroupManagerRepositoryInformation(int numberOfMonitoringEntries)` Return the group leader information.
`LocalControllerDescription`	`getLocalControllerDescription(String localControllerId)` Gets a local controller description form a group manager.
`LocalControllerList`	`getLocalControllerList()` Gets the list of local controllers.
`VirtualClusterSubmissionResponse`	`getVirtualClusterResponse(String taskIdentifier)` Returns the virtual cluster response.
`VirtualMachineMetaData`	`getVirtualMachineMetaData(MetaDataRequest request)` Routine to get virtual machine meta data.
`VirtualMachineSubmissionResponse`	`getVirtualMachineSubmissionResponse(String taskIdentifier)` Returns the virtual machine response.
`String`	`hasLocalController(NetworkAddress localControllerAddress)` Checks if local controller exists.
`boolean`	`hasVirtualMachine(VirtualMachineLocation location)` Checks if a virtual machine is active on a particular local controller.
`boolean`	`joinGroupLeader(GroupManagerDescription groupManagerDescription)` Handles the join request of a group manager.
`boolean`	`joinGroupManager(LocalControllerDescription localControllerDescription)` Routine to join the group manager.
`boolean`	`migrateVirtualMachine(MigrationRequest migrationRequest)` Migrate a virtual machine.
`boolean`	`rebootVirtualMachine(VirtualMachineLocation location)` Routine to reboot a virtual machine.
`VirtualMachineMetaData`	`resizeVirtualMachine(ResizeRequest resizeRequest)` Resize a virtual machine.
`boolean`	`resumeEnergySaver()` Resumes the energy saver.
`boolean`	`resumeVirtualMachine(VirtualMachineLocation location)` Routine to resume a virtual machine.
`String`	`searchVirtualMachine(String virtualMachineId)` Returns the local controller identifier of a virtual machine.
`boolean`	`shutdownVirtualMachine(VirtualMachineLocation location)` Routine to shutdown a virtual machine.
`boolean`	`startReconfiguration()` starts a reconfiguration.
`String`	`startVirtualCluster(VirtualClusterSubmissionRequest virtualClusterDescription)` Dispatches the virtual cluster submission request.
`String`	`startVirtualMachines(VirtualMachineSubmissionRequest submissionRequest)` Starts virtual machines on the group manager.
`boolean`	`suspendEnergySaver()` Suspends the energy saver.
`boolean`	`suspendVirtualMachine(VirtualMachineLocation location)` Routine to suspend a virtual machine.

- Method Detail
  - startVirtualCluster
```
@Post(value="?startVirtualCluster")
String startVirtualCluster(VirtualClusterSubmissionRequest virtualClusterDescription)
```
    Dispatches the virtual cluster submission request. (called by the client)
    
    Parameters:
    virtualClusterDescription - The virtual cluster description
    
    Returns:
    The virtual cluster mapping
  - getVirtualMachineSubmissionResponse
```
@Post(value="?getVirtualMachineSubmissionResponse")
VirtualMachineSubmissionResponse getVirtualMachineSubmissionResponse(String taskIdentifier)
```
    Returns the virtual machine response.
    
    Parameters:
    taskIdentifier - The task identifier
    
    Returns:
    The virtual machine submission response
  - getVirtualClusterResponse
```
@Post(value="?getVirtualClusterResponse")
VirtualClusterSubmissionResponse getVirtualClusterResponse(String taskIdentifier)
```
    Returns the virtual cluster response.
    
    Parameters:
    taskIdentifier - The task identifier
    
    Returns:
    The virtual cluster response
  - joinGroupLeader
```
@Post(value="?joinGroupLeader")
boolean joinGroupLeader(GroupManagerDescription groupManagerDescription)
```
    Handles the join request of a group manager. (called by a group manager)
    
    Parameters:
    groupManagerDescription - The group manager description
    
    Returns:
    true if everything ok, false otherwise
  - joinGroupManager
```
@Post(value="?joinGroupManager")
boolean joinGroupManager(LocalControllerDescription localControllerDescription)
```
    Routine to join the group manager. (called by a local controller)
    
    Parameters:
    localControllerDescription - The local controller description
    
    Returns:
    true if everything ok, false otherwise
  - assignLocalController
```
@Post(value="?assignLocalController")
AssignedGroupManager assignLocalController(LocalControllerDescription localControllerDescription)
```
    Assign local controller to a group manager. (called by the local controller)
    
    Parameters:
    localControllerDescription - The local controller description
    
    Returns:
    The local controller assignment
  - discoverVirtualMachine
```
@Post(value="?discoverVirtualMachine")
VirtualMachineDiscoveryResponse discoverVirtualMachine(String virtualMachineId)
```
    Routine to discover the group manager hosting a virtual machine.
    
    Parameters:
    virtualMachineId - The virtual machine identifier
    
    Returns:
    The local controller information
  - getGroupLeaderRepositoryInformation
```
@Post(value="?getGroupLeaderRepositoryInformation")
GroupLeaderRepositoryInformation getGroupLeaderRepositoryInformation(int numberOfMonitoringEntries)
```
    Routine the group leader information.
    
    Parameters:
    numberOfMonitoringEntries - The number of monitoring entries
    
    Returns:
    The group leader repository information
  - getGroupManagerRepositoryInformation
```
@Post(value="?getGroupManagerRepositoryInformation")
GroupManagerRepositoryInformation getGroupManagerRepositoryInformation(int numberOfMonitoringEntries)
```
    Return the group leader information.
    
    Parameters:
    numberOfMonitoringEntries - The number of monitoring entries
    
    Returns:
    The group manager repository information
  - startVirtualMachines
```
@Post(value="?startVirtualMachines")
String startVirtualMachines(VirtualMachineSubmissionRequest submissionRequest)
```
    Starts virtual machines on the group manager.
    
    Parameters:
    submissionRequest - The virtual machine submission request
    
    Returns:
    The task identifier
  - suspendVirtualMachine
```
@Post(value="?suspendVirtualMachine")
boolean suspendVirtualMachine(VirtualMachineLocation location)
```
    Routine to suspend a virtual machine.
    
    Parameters:
    location - The virtual machine location
    
    Returns:
    true if everything ok, false otherwise
  - resumeVirtualMachine
```
@Post(value="?resumeVirtualMachine")
boolean resumeVirtualMachine(VirtualMachineLocation location)
```
    Routine to resume a virtual machine.
    
    Parameters:
    location - The virtual machine location
    
    Returns:
    true if everything ok, false otherwise
  - shutdownVirtualMachine
```
@Post(value="?shutdownVirtualMachine")
boolean shutdownVirtualMachine(VirtualMachineLocation location)
```
    Routine to shutdown a virtual machine.
    
    Parameters:
    location - The virtual machine location
    
    Returns:
    true if everything ok, false otherwise
  - rebootVirtualMachine
```
@Post(value="?rebootVirtualMachine")
boolean rebootVirtualMachine(VirtualMachineLocation location)
```
    Routine to reboot a virtual machine.
    
    Parameters:
    location - The virtual machine location
    
    Returns:
    true if everything ok, false otherwise
  - destroyVirtualMachine
```
@Post(value="?destroyVirtualMachine")
boolean destroyVirtualMachine(VirtualMachineLocation location)
```
    Routine to shutdown a virtual machine.
    
    Parameters:
    location - The management request
    
    Returns:
    true if everything ok, false otherwise
  - searchVirtualMachine
```
@Post(value="?searchVirtualMachine")
String searchVirtualMachine(String virtualMachineId)
```
    Returns the local controller identifier of a virtual machine.
    
    Parameters:
    virtualMachineId - The virtual machine identifier
    
    Returns:
    The local controller identifier
  - hasVirtualMachine
```
@Post(value="?hasVirtualMachine")
boolean hasVirtualMachine(VirtualMachineLocation location)
```
    Checks if a virtual machine is active on a particular local controller.
    
    Parameters:
    location - The virtual machine location
    
    Returns:
    true if everything ok, false otherwise
  - getVirtualMachineMetaData
```
@Post(value="?getVirtualMachineMetaData")
VirtualMachineMetaData getVirtualMachineMetaData(MetaDataRequest request)
```
    Routine to get virtual machine meta data.
    
    Parameters:
    request - The meta data request
    
    Returns:
    The virtual machine information
  - suspendEnergySaver
```
@Get(value="?suspendEnergySaver")
boolean suspendEnergySaver()
```
    Suspends the energy saver.
    
    Returns:
    true if everything ok, false otherwise
  - resumeEnergySaver
```
@Get(value="?resumeEnergySaver")
boolean resumeEnergySaver()
```
    Resumes the energy saver.
    
    Returns:
    true if everything ok, false otherwise
  - dropVirtualMachineMetaData
```
@Post(value="?dropVirtualMachineMetaData")
boolean dropVirtualMachineMetaData(VirtualMachineLocation virtualMachineLocation)
```
    Drops virtual machine met data.
    
    Parameters:
    virtualMachineLocation - The virtual machine location
    
    Returns:
    true if everything ok, false otherwise
  - hasLocalController
```
@Post(value="?hasLocalController")
String hasLocalController(NetworkAddress localControllerAddress)
```
    Checks if local controller exists.
    
    Parameters:
    localControllerAddress - The lcoal controller address
    
    Returns:
    The previous identifier, null otherwise
  - migrateVirtualMachine
```
@Post(value="?migrateVirtualMachine")
boolean migrateVirtualMachine(MigrationRequest migrationRequest)
```
    Migrate a virtual machine. (call by the client)
    
    Parameters:
    migrationRequest - The client migration Request
    
    Returns:
    true if ok false otherwise
  - getLocalControllerList
```
@Get(value="?getLocalControllerList")
LocalControllerList getLocalControllerList()
```
    Gets the list of local controllers.
    
    Returns:
    The local controller list
  - resizeVirtualMachine
```
@Post(value="?resizeVirtualMachine")
VirtualMachineMetaData resizeVirtualMachine(ResizeRequest resizeRequest)
```
    Resize a virtual machine.
    
    Parameters:
    resizeRequest - The resize request.
    
    Returns:
    true if ok false otherwise
  - addVirtualMachineAfterMigration
```
@Post(value="?addVirtualMachineAfterMigration")
boolean addVirtualMachineAfterMigration(VirtualMachineMetaData virtualMachine)
```
    Request to add a new virtual machine after a successful migration.
    
    Parameters:
    virtualMachine - The virtual machine meta data.
    
    Returns:
    true iff everything is ok.
  - getGroupManagerDescription
```
@Post(value="?getGroupManagerDescription")
GroupManagerDescription getGroupManagerDescription(String groupManagerId)
```
    Gets a groupManager description from the groupLeader.
    
    Parameters:
    groupManagerId - group manager Id.
    
    Returns:
    Group manager Description.
  - getLocalControllerDescription
```
@Post(value="?getLocalControllerDescription")
LocalControllerDescription getLocalControllerDescription(String localControllerId)
```
    Gets a local controller description form a group manager.
    
    Parameters:
    localControllerId - local controller id.
    
    Returns:
    Local Controller Description.
  - startReconfiguration
```
@Post(value="?startReconfiguration")
boolean startReconfiguration()
```
    starts a reconfiguration.
    
    Returns:
    True if everything is ok.

Interface GroupManagerAPI

Method Summary

Method Detail

startVirtualCluster

getVirtualMachineSubmissionResponse

getVirtualClusterResponse

joinGroupLeader

joinGroupManager

assignLocalController

discoverVirtualMachine

getGroupLeaderRepositoryInformation

getGroupManagerRepositoryInformation

startVirtualMachines

suspendVirtualMachine

resumeVirtualMachine

shutdownVirtualMachine

rebootVirtualMachine

destroyVirtualMachine

searchVirtualMachine

hasVirtualMachine

getVirtualMachineMetaData

suspendEnergySaver

resumeEnergySaver

dropVirtualMachineMetaData

hasLocalController

migrateVirtualMachine

getLocalControllerList

resizeVirtualMachine

addVirtualMachineAfterMigration

getGroupManagerDescription

getLocalControllerDescription

startReconfiguration