org.wso2.carbon.rest.api.service

Class RestApiAdminService

java.lang.Object

org.wso2.carbon.rest.api.service.RestApiAdminService

public class RestApiAdminService
extends Object

Constructor Summary

Constructors

Constructor and Description
RestApiAdminService()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addApi(APIData apiData)
boolean	addApiForTenant(String apiData, String tenantDomain) Set the tenant domain when a publisher publishes his API in MT mode.
boolean	addApiFromString(String apiData)
boolean	deleteApi(String apiName)
APIData	getApiByName(String apiName)
APIData	getApiForTenant(String apiName, String tenantDomain) Set the tenant domain when a publisher tries to retrieve API his API in MT mode.
protected Lock	getLock()
boolean	updateApiForTenant(String apiName, String apiData, String tenantDomain) Set the tenant domain when a publisher updates his API in MT mode.
boolean	updateApiFromString(String apiName, String apiData)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestApiAdminService

public RestApiAdminService()

Method Detail

addApi

public boolean addApi(APIData apiData)
               throws APIException

Throws:

APIException

addApiFromString

public boolean addApiFromString(String apiData)
                         throws APIException

Throws:

APIException

addApiForTenant

public boolean addApiForTenant(String apiData,
                      String tenantDomain)
                        throws APIException

Set the tenant domain when a publisher publishes his API in MT mode. When publisher publishes the API, we login the gateway as super tenant. But we need to publish the API in the particular tenant domain.

Parameters:

apiData -

tenantDomain -

Returns:

Throws:

APIException

getApiForTenant

public APIData getApiForTenant(String apiName,
                      String tenantDomain)
                        throws APIException

Set the tenant domain when a publisher tries to retrieve API his API in MT mode. When publisher gets the API, we login the gateway as super tenant. But we need to get the API,which is in the particular tenant domain.

Parameters:

apiName -

tenantDomain -

Returns:

Throws:

APIException

getApiByName

public APIData getApiByName(String apiName)
                     throws APIException

Throws:

APIException

updateApiFromString

public boolean updateApiFromString(String apiName,
                          String apiData)
                            throws APIException

Throws:

APIException

updateApiForTenant

public boolean updateApiForTenant(String apiName,
                         String apiData,
                         String tenantDomain)
                           throws APIException

Set the tenant domain when a publisher updates his API in MT mode. When publisher updates the API, we login the gateway as super tenant. But we need to update the API,which is in the particular tenant domain.

Parameters:

apiName -

apiData -

Returns:

Throws:

APIException

deleteApi

public boolean deleteApi(String apiName)
                  throws APIException

Throws:

APIException

getLock

protected Lock getLock()
                throws APIException

Throws:

APIException