...
- getCartridgeInfo
- getPendingInstanceCount
- getRegisteredCartridges
- registerService
- startInstance
- terminateAllInstances
- terminateInstance
- terminateLastlySpawnedInstance
| Anchor | ||
|---|---|---|
|
...
|
getCartridgeInfo
| Code Block | ||
|---|---|---|
| ||
public CartridgeInfo getCartridgeInfo(String cartridgeType) throws UnregisteredCartridgeException; |
...
Exception Thrown | Description |
UnregisteredCartridgeException | Occurs when the cartridge type requested by this service is not registered. |
| Anchor | ||
|---|---|---|
|
...
|
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. |
...
| Anchor | ||
|---|---|---|
|
...
|
getRegisteredCartridges
| Code Block | ||
|---|---|---|
| ||
public String[] getRegisteredCartridges(); |
...
Return Value | Description |
String | This will return an array containing the types of registered cartridges. |
...
| Anchor | ||||
|---|---|---|---|---|
|
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
| 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. |
| Anchor | ||
|---|---|---|
|
...
|
terminateAllInstances
| Code Block | ||
|---|---|---|
| ||
public boolean terminateAllInstances(String domainName, String subDomainName); |
...
Return Value | Description |
boolean | "True" or "false" will be returned to indicate whether all the instances were terminated successfully or not. |
| Anchor | ||
|---|---|---|
|
...
|
terminateInstance
| Code Block | ||
|---|---|---|
| ||
public boolean terminateInstance(String domainName, String subDomainName); |
...
Return Value | Description |
boolean | "True" or "false" will be returned to indicate whether an instance was terminated successfully or not. |
| Anchor | ||
|---|---|---|
|
...
|
terminateLastlySpawnedInstance
| Code Block | ||
|---|---|---|
| ||
public boolean terminateLastlySpawnedInstance(String domainName, String subDomainName); |
...
Return Value | Description |
boolean | "True" or "false" will be returned to indicate whether the termination was successfully or not. |
| Anchor | ||
|---|---|---|
|
...
|
unregisterService
| Code Block | ||
|---|---|---|
| ||
public boolean unregisterService(String domain, String subDomain) throws UnregisteredServiceException; |
...