org.wso2.am.integration.test.impl

Class RestAPIAdminImpl

java.lang.Object

org.wso2.am.integration.test.impl.RestAPIAdminImpl

public class RestAPIAdminImpl
extends Object

This util class performs the actions related to APIDTOobjects.

Field Summary

Fields

Modifier and Type	Field and Description
ApiClient	apiAdminClient
ApplicationPolicyCollectionApi	applicationPolicyCollectionApi
static String	appName
static String	appOwner
static String	callBackURL
static String	grantType
static String	password
String	tenantDomain
static String	tokenScope
static String	username
WorkflowCollectionApi	workflowCollectionApi
WorkflowsIndividualApi	workflowsIndividualApi

Constructor Summary

Constructors

Constructor and Description
RestAPIAdminImpl(String username, String password, String tenantDomain, String adminURl)

Method Summary

Modifier and Type	Method and Description
ApiResponse<AdvancedThrottlePolicyDTO>	addAdvancedThrottlingPolicy(AdvancedThrottlePolicyDTO advancedThrottlePolicyDTO) This method is used to create an advanced throttling policy.
ApiResponse<APICategoryDTO>	addApiCategory(APICategoryDTO apiCategoryDTO) This method is used to add an API category.
ApiResponse<ApplicationThrottlePolicyDTO>	addApplicationThrottlingPolicy(ApplicationThrottlePolicyDTO applicationThrottlePolicyDTO) This method is used to create an application throttling policy.
ApiResponse<CustomRuleDTO>	addCustomThrottlingPolicy(CustomRuleDTO customRuleDTO) This method is used to create an custom throttling policy.
ApiResponse<BlockingConditionDTO>	addDenyThrottlingPolicy(BlockingConditionDTO denyPolicyDTO) Creates an deny throttling policy.
ApiResponse<EnvironmentDTO>	addEnvironment(EnvironmentDTO environmentDTO) This method is used to add an environment.
ApiResponse<KeyManagerDTO>	addKeyManager(KeyManagerDTO keyManagerDTO)
ApiResponse<LabelDTO>	addLabel(LabelDTO labelDTO) This method is used to add a label.
ApiResponse<SubscriptionThrottlePolicyDTO>	addSubscriptionThrottlingPolicy(SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO) This method is used to create a subscription throttling policy.
ApiResponse<Void>	changeApplicationOwner(String newOwner, String applicationId) This method is used to change the owner of an application.
ApiResponse<Void>	deleteAdvancedThrottlingPolicy(String policyId) This method is used to delete an advanced throttling policy.
ApiResponse<Void>	deleteApiCategory(String uuid) This method is used to delete an API category.
ApiResponse<Void>	deleteApplicationThrottlingPolicy(String policyId) This method is used to delete an application throttling policy.
ApiResponse<Void>	deleteCustomThrottlingPolicy(String policyId) This method is used to delete a custom throttling policy.
ApiResponse<Void>	deleteDenyThrottlingPolicy(String policyId) Deletes a deny throttling policy.
ApiResponse<Void>	deleteEnvironment(String environmentId) This method is used to delete an environment.
void	deleteKeyManager(String uuid)
ApiResponse<Void>	deleteLabel(String labelId) This method is used to delete a label.
ApiResponse<Void>	deleteSubscriptionThrottlingPolicy(String policyId) This method is used to delete a subscription throttling policy.
ApiResponse<AdvancedThrottlePolicyDTO>	getAdvancedThrottlingPolicy(String policyId) This method is used to retrieve an advanced throttling policy.
ApiResponse<APICategoryListDTO>	getApiCategories() This method is used to retrieve all API categories.
ApiResponse<ApplicationListDTO>	getApplications(String user, Integer limit, Integer offset, String appTenantDomain) This method is used to retrieve applications.
ApiResponse<ApplicationThrottlePolicyDTO>	getApplicationThrottlingPolicy(String policyId) This method is used to retrieve an application throttling policy.
ApiResponse<CustomRuleDTO>	getCustomThrottlingPolicy(String policyId) This method is used to retrieve a custom throttling policy.
ApiResponse<BlockingConditionDTO>	getDenyThrottlingPolicy(String policyId) Retrieves a deny throttling policy.
ApiResponse<EnvironmentListDTO>	getEnvironments() This method is used to retrieve all environments.
KeyManagerDTO	getKeyManager(String uuid)
KeyManagerListDTO	getKeyManagers()
ApiResponse<LabelListDTO>	getLabels() This method is used to retrieve all labels.
SettingsDTO	getSettings()
ApiResponse<SubscriptionThrottlePolicyDTO>	getSubscriptionThrottlingPolicy(String policyId) This method is used to retrieve a subscription throttling policy.
HttpResponse	getWorkflowByExternalWorkflowReference(String externalWorkflowRef)
HttpResponse	getWorkflows(String workflowType)
ApiResponse<AdvancedThrottlePolicyDTO>	updateAdvancedThrottlingPolicy(String policyId, AdvancedThrottlePolicyDTO advancedThrottlePolicyDTO) This method is used to update an advanced throttling policy.
ApiResponse<APICategoryDTO>	updateApiCategory(String uuid, APICategoryDTO apiCategoryDTO) This method is used to update an API category
ApiResponse<ApplicationThrottlePolicyDTO>	updateApplicationThrottlingPolicy(String policyId, ApplicationThrottlePolicyDTO applicationThrottlePolicyDTO) This method is used to update an application throttling policy.
ApiResponse<CustomRuleDTO>	updateCustomThrottlingPolicy(String policyId, CustomRuleDTO customRuleDTO) This method is used to update a custom throttling policy.
ApiResponse<EnvironmentDTO>	updateEnvironment(String environmentId, EnvironmentDTO environmentDTO) This method is used to update an environment.
KeyManagerDTO	updateKeyManager(String uuid, KeyManagerDTO keyManagerDTO)
ApiResponse<LabelDTO>	updateLabel(String labelId, LabelDTO labelDTO) This method is used to update a label.
ApiResponse<SubscriptionThrottlePolicyDTO>	updateSubscriptionThrottlingPolicy(String policyId, SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO) This method is used to update a subscription throttling policy.
HttpResponse	updateWorkflowStatus(String workflowReferenceId)

Methods inherited from class java.lang.Object

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

Field Detail

apiAdminClient

public ApiClient apiAdminClient

workflowCollectionApi

public WorkflowCollectionApi workflowCollectionApi

workflowsIndividualApi

public WorkflowsIndividualApi workflowsIndividualApi

applicationPolicyCollectionApi

public ApplicationPolicyCollectionApi applicationPolicyCollectionApi

appName

public static final String appName

See Also:

Constant Field Values

callBackURL

public static final String callBackURL

See Also:

Constant Field Values

tokenScope

public static final String tokenScope

See Also:

Constant Field Values

appOwner

public static final String appOwner

See Also:

Constant Field Values

grantType

public static final String grantType

See Also:

Constant Field Values

username

public static final String username

See Also:

Constant Field Values

password

public static final String password

See Also:

Constant Field Values

tenantDomain

public String tenantDomain

Constructor Detail

RestAPIAdminImpl

public RestAPIAdminImpl(String username,
                        String password,
                        String tenantDomain,
                        String adminURl)

Method Detail

addApiCategory

public ApiResponse<APICategoryDTO> addApiCategory(APICategoryDTO apiCategoryDTO)
                                           throws ApiException

This method is used to add an API category.

Parameters:

apiCategoryDTO - API category DTO to be added

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while adding the new API category.

updateApiCategory

public ApiResponse<APICategoryDTO> updateApiCategory(String uuid,
                                                     APICategoryDTO apiCategoryDTO)
                                              throws ApiException

This method is used to update an API category

Parameters:

uuid - UUID of the API category to be updated

apiCategoryDTO - API category DTO to be updated

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while updating the new API category.

getApiCategories

public ApiResponse<APICategoryListDTO> getApiCategories()
                                                 throws ApiException

This method is used to retrieve all API categories.

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while retrieving all API categories.

deleteApiCategory

public ApiResponse<Void> deleteApiCategory(String uuid)
                                    throws ApiException

This method is used to delete an API category.

Parameters:

uuid - uuid of the API category to be deleted.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while deleting the API category.

addKeyManager

public ApiResponse<KeyManagerDTO> addKeyManager(KeyManagerDTO keyManagerDTO)
                                         throws ApiException

Throws:

ApiException

getKeyManagers

public KeyManagerListDTO getKeyManagers()
                                 throws ApiException

Throws:

ApiException

getKeyManager

public KeyManagerDTO getKeyManager(String uuid)
                            throws ApiException

Throws:

ApiException

updateKeyManager

public KeyManagerDTO updateKeyManager(String uuid,
                                      KeyManagerDTO keyManagerDTO)
                               throws ApiException

Throws:

ApiException

deleteKeyManager

public void deleteKeyManager(String uuid)
                      throws ApiException

Throws:

ApiException

getSettings

public SettingsDTO getSettings()
                        throws ApiException

Throws:

ApiException

addApplicationThrottlingPolicy

public ApiResponse<ApplicationThrottlePolicyDTO> addApplicationThrottlingPolicy(ApplicationThrottlePolicyDTO applicationThrottlePolicyDTO)
                                                                         throws ApiException

This method is used to create an application throttling policy.

Parameters:

applicationThrottlePolicyDTO - Application throttling policy DTO to be added.

Returns:

API response returned by the API call.

Throws:

ApiException - if an error occurs while creating the application throttling policy.

getApplicationThrottlingPolicy

public ApiResponse<ApplicationThrottlePolicyDTO> getApplicationThrottlingPolicy(String policyId)
                                                                         throws ApiException

This method is used to retrieve an application throttling policy.

Returns:

API response returned by the API call.

Throws:

ApiException - if an error occurs while retrieving the application throttling policy.

updateApplicationThrottlingPolicy

public ApiResponse<ApplicationThrottlePolicyDTO> updateApplicationThrottlingPolicy(String policyId,
                                                                                   ApplicationThrottlePolicyDTO applicationThrottlePolicyDTO)
                                                                            throws ApiException

This method is used to update an application throttling policy.

Parameters:

policyId - Policy Id of the application throttling policy to be updated.

applicationThrottlePolicyDTO - Application throttling policy DTO which contains the update content.

Returns:

API response returned by the API call.

Throws:

ApiException - if an error occurs while updating the application throttling policy.

deleteApplicationThrottlingPolicy

public ApiResponse<Void> deleteApplicationThrottlingPolicy(String policyId)
                                                    throws ApiException

This method is used to delete an application throttling policy.

Parameters:

policyId - Policy Id of the application throttling policy to be deleted.

Returns:

API response returned by the API call.

Throws:

ApiException - if an error occurs while deleting the application throttling policy.

addSubscriptionThrottlingPolicy

public ApiResponse<SubscriptionThrottlePolicyDTO> addSubscriptionThrottlingPolicy(SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO)
                                                                           throws ApiException

This method is used to create a subscription throttling policy.

Parameters:

subscriptionThrottlePolicyDTO - Subscription throttling policy DTO to be added.

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while creating the new subscription throttling policy.

getSubscriptionThrottlingPolicy

public ApiResponse<SubscriptionThrottlePolicyDTO> getSubscriptionThrottlingPolicy(String policyId)
                                                                           throws ApiException

This method is used to retrieve a subscription throttling policy.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while retrieving the subscription throttling policy.

updateSubscriptionThrottlingPolicy

public ApiResponse<SubscriptionThrottlePolicyDTO> updateSubscriptionThrottlingPolicy(String policyId,
                                                                                     SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO)
                                                                              throws ApiException

This method is used to update a subscription throttling policy.

Parameters:

policyId - Policy Id of the subscription throttling policy to be updated.

subscriptionThrottlePolicyDTO - Subscription throttling policy DTO which contains the updated content.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while updating the subscription throttling policy.

deleteSubscriptionThrottlingPolicy

public ApiResponse<Void> deleteSubscriptionThrottlingPolicy(String policyId)
                                                     throws ApiException

This method is used to delete a subscription throttling policy.

Parameters:

policyId - Subscription throttling policy Id.

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while deleting the subscription throttling policy.

addCustomThrottlingPolicy

public ApiResponse<CustomRuleDTO> addCustomThrottlingPolicy(CustomRuleDTO customRuleDTO)
                                                     throws ApiException

This method is used to create an custom throttling policy.

Parameters:

customRuleDTO - Custom throttling policy DTO to be added.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while creating the custom throttling policy.

getCustomThrottlingPolicy

public ApiResponse<CustomRuleDTO> getCustomThrottlingPolicy(String policyId)
                                                     throws ApiException

This method is used to retrieve a custom throttling policy.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while retrieving the custom throttling policy.

updateCustomThrottlingPolicy

public ApiResponse<CustomRuleDTO> updateCustomThrottlingPolicy(String policyId,
                                                               CustomRuleDTO customRuleDTO)
                                                        throws ApiException

This method is used to update a custom throttling policy.

Parameters:

policyId - Policy Id of the custom throttling policy to be updated.

customRuleDTO - Custom throttling policy DTO which contains the updated content.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while updating the custom throttling policy.

deleteCustomThrottlingPolicy

public ApiResponse<Void> deleteCustomThrottlingPolicy(String policyId)
                                               throws ApiException

This method is used to delete a custom throttling policy.

Parameters:

policyId - Policy Id of the custom throttling policy to be deleted.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while deleting the custom throttling policy.

addDenyThrottlingPolicy

public ApiResponse<BlockingConditionDTO> addDenyThrottlingPolicy(BlockingConditionDTO denyPolicyDTO)
                                                          throws ApiException

Creates an deny throttling policy.

Parameters:

denyPolicyDTO - deny throttling policy DTO to be added.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while creating the deny throttling policy.

getDenyThrottlingPolicy

public ApiResponse<BlockingConditionDTO> getDenyThrottlingPolicy(String policyId)
                                                          throws ApiException

Retrieves a deny throttling policy.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while retrieving the deny throttling policy.

deleteDenyThrottlingPolicy

public ApiResponse<Void> deleteDenyThrottlingPolicy(String policyId)
                                             throws ApiException

Deletes a deny throttling policy.

Parameters:

policyId - policy id of the deny throttling policy to be deleted.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while deleting the deny throttling policy.

addAdvancedThrottlingPolicy

public ApiResponse<AdvancedThrottlePolicyDTO> addAdvancedThrottlingPolicy(AdvancedThrottlePolicyDTO advancedThrottlePolicyDTO)
                                                                   throws ApiException

This method is used to create an advanced throttling policy.

Parameters:

advancedThrottlePolicyDTO - Advanced throttling policy DTO to be added.

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while creating the new advanced policy.

getAdvancedThrottlingPolicy

public ApiResponse<AdvancedThrottlePolicyDTO> getAdvancedThrottlingPolicy(String policyId)
                                                                   throws ApiException

This method is used to retrieve an advanced throttling policy.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while retrieving the advanced throttling policy.

updateAdvancedThrottlingPolicy

public ApiResponse<AdvancedThrottlePolicyDTO> updateAdvancedThrottlingPolicy(String policyId,
                                                                             AdvancedThrottlePolicyDTO advancedThrottlePolicyDTO)
                                                                      throws ApiException

This method is used to update an advanced throttling policy.

Parameters:

policyId - Policy Id of the advanced throttling policy to be updated.

advancedThrottlePolicyDTO - Advanced throttling policy DTO which contains the updated content.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while updating the advanced throttling policy.

deleteAdvancedThrottlingPolicy

public ApiResponse<Void> deleteAdvancedThrottlingPolicy(String policyId)
                                                 throws ApiException

This method is used to delete an advanced throttling policy.

Parameters:

policyId - Policy Id of the advanced throttling policy to be deleted.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while deleting the advanced throttling policy.

addLabel

public ApiResponse<LabelDTO> addLabel(LabelDTO labelDTO)
                               throws ApiException

This method is used to add a label.

Parameters:

labelDTO - Label DTO to be added.

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while adding the new label.

getLabels

public ApiResponse<LabelListDTO> getLabels()
                                    throws ApiException

This method is used to retrieve all labels.

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while retrieving all labels.

updateLabel

public ApiResponse<LabelDTO> updateLabel(String labelId,
                                         LabelDTO labelDTO)
                                  throws ApiException

This method is used to update a label.

Parameters:

labelId - Label Id of the label to be updated.

labelDTO - Label DTO which contains the updated content.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while updating the label.

deleteLabel

public ApiResponse<Void> deleteLabel(String labelId)
                              throws ApiException

This method is used to delete a label.

Parameters:

labelId - Label Id of the label to be updated.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while deleting the label.

addEnvironment

public ApiResponse<EnvironmentDTO> addEnvironment(EnvironmentDTO environmentDTO)
                                           throws ApiException

This method is used to add an environment.

Parameters:

environmentDTO - Environment DTO to be added.

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while adding the new environment.

getEnvironments

public ApiResponse<EnvironmentListDTO> getEnvironments()
                                                throws ApiException

This method is used to retrieve all environments.

Returns:

API response returned by the API call.

Throws:

ApiException - Throws if an error occurred while retrieving all environments of tenant.

updateEnvironment

public ApiResponse<EnvironmentDTO> updateEnvironment(String environmentId,
                                                     EnvironmentDTO environmentDTO)
                                              throws ApiException

This method is used to update an environment.

Parameters:

environmentId - Environment Id of the label to be updated.

environmentDTO - Environment DTO which contains the updated content.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while updating the environment.

deleteEnvironment

public ApiResponse<Void> deleteEnvironment(String environmentId)
                                    throws ApiException

This method is used to delete an environment.

Parameters:

environmentId - Environment Id of the label to be deleted.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while deleting the environment.

getApplications

public ApiResponse<ApplicationListDTO> getApplications(String user,
                                                       Integer limit,
                                                       Integer offset,
                                                       String appTenantDomain)
                                                throws ApiException

This method is used to retrieve applications.

Parameters:

user - Username of the application creator.

limit - Maximum number of applications to return.

offset - Starting point within the complete list of applications qualified.

appTenantDomain - Tenant domain of the applications to get.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while retrieving applications.

changeApplicationOwner

public ApiResponse<Void> changeApplicationOwner(String newOwner,
                                                String applicationId)
                                         throws ApiException

This method is used to change the owner of an application.

Parameters:

newOwner - New owner of the application.

applicationId - Application ID of the application.

Returns:

API response returned by API call.

Throws:

ApiException - if an error occurs while changing the owner of an application.

getWorkflowByExternalWorkflowReference

public HttpResponse getWorkflowByExternalWorkflowReference(String externalWorkflowRef)
                                                    throws ApiException

Throws:

ApiException

getWorkflows

public HttpResponse getWorkflows(String workflowType)
                          throws ApiException

Throws:

ApiException

updateWorkflowStatus

public HttpResponse updateWorkflowStatus(String workflowReferenceId)
                                  throws ApiException

Throws:

ApiException