...
...
getCartridgeInfo
| Code Block |
|---|
|
public CartridgeInfo getCartridgeInfo(String cartridgeType) throws UnregisteredCartridgeException; |
Method description
Calling this method will return information on the given cartridge if present, otherwise this will return a null value.
...
Exception Thrown | Description |
UnregisteredCartridgeException | Occurs when the cartridge type requested by this service is not registered.
|
...
getPendingInstanceCount
| Code Block |
|---|
|
public int getPendingInstanceCount(String domainName, String subDomainName); |
...
Return Value
| Description |
|---|
int | The number of pending instances for this domain is returned. This will return zero if there are no instances for this domain. |
...
...
getRegisteredCartridges
| Code Block |
|---|
|
public String[] getRegisteredCartridges(); |
...
Return Value
| Description |
String | This will return an array containing the types of registered cartridges. |
...
| Anchor |
|---|
| #registerService |
|---|
| #registerService |
|---|
|
registerService
| Code Block |
|---|
|
public boolean registerService(String domain, String subDomain, String tenantRange, String cartridgeType,
String hostName, Properties properties, byte[] payload) throws UnregisteredCartridgeException; |
...
Exception Thrown | Description |
UnregisteredCartridgeException | Occurs when the cartridge type requested by this service is not registered.
|
...
| Anchor |
|---|
| #startInstance |
|---|
| #startInstance |
|---|
|
startInstance
| Code Block |
|---|
|
public String startInstance(String domainName, String subDomainName); |
...
Return Value
| Description |
String | The public IP which is associated with the newly started instance will be returned.
|
...
terminateAllInstances
| Code Block |
|---|
|
public boolean terminateAllInstances(String domainName, String subDomainName); |
Method
...
description
Calling this method will result in the termination of all instances belonging to the provided service domain and sub-domain.
...
Return Value
| Description |
boolean | "True" or "false" will be returned to indicate whether all the instances were terminated successfully or not. |
...
terminateInstance
| Code Block |
|---|
|
public boolean terminateInstance(String domainName, String subDomainName); |
Method description
Calling this method results in the termination of an instance belonging to the provided service domain and sub-domain .
...
Return Value
| Description |
boolean | "True" or "false" will be returned to indicate whether an instance was terminated successfully or not. |
| Anchor |
|---|
| terminateLastlySpawnedInstance |
|---|
|
...
| | terminateLastlySpawnedInstance |
|---|
|
terminateLastlySpawnedInstance
| Code Block |
|---|
|
public boolean terminateLastlySpawnedInstance(String domainName, String subDomainName); |
Method description
Calling this method will result in the termination of the lastly spawned instance that belongs to the service domain and sub-domain provided .
...
Return Value
| Description |
boolean | "True" or "false" will be returned to indicate whether the termination was successfully or not. |
...
unregisterService
| Code Block |
|---|
|
public boolean unregisterService(String domain, String subDomain) throws UnregisteredServiceException; |
Method description
Calling this method will result in deregistering the service cluster that is represented by the mentioned domain and sub-domain .
...