| Note |
|---|
This page is under construction. |
WSO2 CC exposes a service which has the following interface:
...
- getCartridgeInfo
- getPendingInstanceCount
- getRegisteredCartridges
- registerService
- startInstance
- terminateAllInstances
- terminateInstance
- terminateLastlySpawnedInstance
| Anchor | ||
|---|---|---|
|
...
|
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. |
| 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(); |
Method
...
description
Calling
...
this
...
method
...
will
...
result
...
in
...
returning
...
the
...
types
...
of
...
Cartridges
...
registered
...
in
...
the
...
Cloud
...
Controller.
...
Return value description
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; |
Method description
A service cluster is uniquely identified by it's domain and sub-domain combination. This method registers the details of a newly created service cluster and it will override any existing service clusters.
Parameter description
| Parameter | Description |
|---|---|
domain | Service cluster domain. |
subDomain | Service cluster sub-domain. |
tenantRange | Tenant range (for example: '1-10' or '2'). |
cartridgeType | The registered cartridge type of the new service. |
hostName | Host name of this service instance. |
properties | Set of properties related to this service definition. |
payload | The payload that is passed to the instance the instance to be started. Payload shouldn't The payload should not contain XML tags. |
Return value description
...
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); |
Method description
An instance belonging to the provided service domain will be started up upon calling this method.
...
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); |
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. |
| Anchor | ||
|---|---|---|
|
...
|
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
| 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. |
| Anchor | ||
|---|---|---|
|
...
|
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 .
...