org.wso2.am.integration.test.impl

Class RestAPIStoreImpl

java.lang.Object

org.wso2.am.integration.test.impl.RestAPIStoreImpl

public class RestAPIStoreImpl
extends Object

This util class performs the actions related to APIDTOobjects.

Field Summary

Fields

Modifier and Type	Field and Description
ApiKeysApi	apiKeysApi
ApIsApi	apIsApi
ApplicationKeysApi	applicationKeysApi
ApplicationsApi	applicationsApi
static String	appName
static String	appOwner
static String	callBackURL
CommentsApi	commentsApi
static String	grantType
static String	password
RatingsApi	ratingsApi
SdKsApi	sdKsApi
String	storeURL
SubscriptionsApi	subscriptionIndividualApi
TagsApi	tagsApi
String	tenantDomain
static String	tokenScope
UnifiedSearchApi	unifiedSearchApi
static String	username

Constructor Summary

Constructors

Constructor and Description
RestAPIStoreImpl() Deprecated.
RestAPIStoreImpl(String tenantDomain, String storeURL)
RestAPIStoreImpl(String username, String password, String tenantDomain, String storeURL)

Method Summary

Modifier and Type	Method and Description
ApplicationDTO	addApplication(String application, String tier, String callbackUrl, String description) Add application
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	addApplicationWithCustomAttributes(String application, String tier, String callbackUrl, String description, String applicationAttributes) Add application with custom attributes
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	addApplicationWithGroup(String application, String tier, String callbackUrl, String description, String groupId) Add application with Group
ApplicationDTO	addApplicationWithTokenType(String application, String tier, String callbackUrl, String description, String tokenType) Add application with token type
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	addComment(String apiId, String comment) Add comment to given API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	addRating(String apiId, Integer rating, String tenantDomain) Add rating into api
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	changePassword(String username, String currentPassword, String newPassword) Change password of the user
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	cleanUpApplicationRegistrationByApplicationId(String applicationId, String keyType) Clean up application registration by ID
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	createApplication(String appName, String description, String throttleTier, ApplicationDTO.TokenTypeEnum tokenType)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	createApplicationWithCustomAttribute(String appName, String description, String throttleTier, ApplicationDTO.TokenTypeEnum tokenType, Map<String,String> attribute)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	createSubscription(String apiId, String applicationId, String subscriptionTier)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	deleteApplication(String applicationId)
APIKeyDTO	generateAPIKeys(String applicationId, String keyType, int validityPeriod)
ApplicationKeyDTO	generateKeys(String applicationId, String validityTime, String callBackUrl, ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum, ArrayList<String> scopes, List<String> grantTypes)
ApiResponse<byte[]>	generateSDKUpdated(String apiId, String language) Generate SDK for a given programming language
ApiResponse<byte[]>	generateSDKUpdated(String apiId, String language, String tenantDomain) Generate SDK for a given programming language
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	generateUserAccessKey(String consumeKey, String consumerSecret, String messageBody, URL tokenEndpointURL) Generate user access key
APIListDTO	getAllAPIs()
APIListDTO	getAllAPIs(String tenantDomain)
ApplicationListDTO	getAllApps()
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getAllDocumentationOfAPI(String apiName, String version, String provider) Method to retrieve all documents of given api
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getAllPaginatedPublishedAPIs(String tenant, int start, int end) Gell all paginated published apis for a given tenant
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getAllPaginatedPublishedAPIs(String tenant, String start, String end) Get all paginated published API for a given tenant
APIListDTO	getAllPublishedAPIs() Get all published apis
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getAllPublishedAPIs(String tenant) Get all published APIs for tenant
SubscriptionListDTO	getAllSubscriptionsOfApplication(String applicationId) Get All subscriptions for an application.
TagListDTO	getAllTags() Get all API tags
APIDTO	getAPI(String apiId) Get api which are published
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getApiEndpointUrls(String apiName, String version, String provider) Method to retrieve all endpoint urls
APIListDTO	getAPIListFromStoreAsAnonymousUser(String tenantDomain)
APIListDTO	getAPIs(int offset, int limit) Get APIs for the given limit and offset values
APIListDTO	getAPIsFilteredWithTags(String apiTag) Get the web page with filtered API when click the API Tag link
ApplicationDTO	getApplicationById(String applicationId) Get application by ID
ApiResponse<ApplicationKeyDTO>	getApplicationKeysByKeyType(String applicationId, String keyType) Regenerate consumer secret of an application
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getApplicationPage() Get application page
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getApplications() Get application
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getComment(String commentId, String apiId, String tenantDomain) Get Comment from given API
APIListDTO	getPrototypedAPIs(String tenant) Get Prototyped APIs in Store
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getPublishedAPIsByApplication(String applicationName) Get application details by given name
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getPublishedAPIsByApplicationId(String applicationName, int applicationId) Get application details by given name
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getRecentlyAddedAPIs(String tenant, String limit) Get recently added APIs by tenant
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getSubscribedAPIs(String applicationName) Get subscribed Apis by application name
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getSubscribedAPIs(String applicationName, String domain) Get subscribed APIs for the specific Application
SubscriptionListDTO	getSubscription(String apiId, String applicationId, String apiType, String groupId)
String	getSwaggerByID(String apiId, String tenantDomain)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getSwaggerDocument(String userName, String apiName, String apiVersion, String executionMode) This method will return swagger document of given api name and version
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	isCommentActivated() Check whether commenting is enabled
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	isRatingActivated() Check if API rating activated
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	logout() API Store logout
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	regenerateConsumerSecret(String clientId) Regenerate consumer secret.
ApiResponse<ApplicationKeyReGenerateResponseDTO>	regenerateConsumerSecret(String applicationId, String keyType) Regenerate consumer secret of an application
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeAPISubscription(String API, String version, String provider, String applicationId) Unsubscribe from API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeAPISubscriptionByApplicationName(String API, String version, String provider, String applicationName) Unsubscribe from API by application name
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeAPISubscriptionByName(String API, String version, String provider, String appName) Unsubscribe from API
void	removeApplicationById(String applicationId) Delete application by Id
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeComment(String commentId, String apiId) Remove comment in given API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeRating(String apiId, String tenantDomain) Remove rating from given API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeRatingFromAPI(String apiName, String version, String provider) Remove rating of given API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeSubscription(String subscriptionId)
SearchResultListDTO	searchAPIs(String query) Retrieve the APIs according to the search query in Publisher.
SearchResultListDTO	searchAPIs(String query, String tenantDomain) Retrieve the APIs according to the search query in Publisher.
APIListDTO	searchPaginatedAPIs(int limit, int offset, String tenantDomain, String query) Get the web page with filtered API when click the API Tag link
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	signUp(String userName, String password, String firstName, String lastName, String email) API Store sign up
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	signUpforTenant(String userName, String password, String claims) API Store sign up
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	signUpWithOrganization(String userName, String password, String firstName, String lastName, String email, String organization) API Store sign up with organization
SubscriptionDTO	subscribeToAPI(String apiID, String appID, String tier)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	subscribeToAPI(SubscriptionRequest subscriptionRequest) Subscribe and API.
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateApplication(String applicationOld, String applicationNew, String callbackUrlNew, String descriptionNew, String tier) Update given application
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateApplicationById(int applicationId, String applicationOld, String applicationNew, String callbackUrlNew, String descriptionNew, String tier) Update given application
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateApplicationByID(String applicationId, String appName, String description, String throttleTier, ApplicationDTO.TokenTypeEnum tokenType)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateClientApplication(String application, String keyType, String authorizedDomains, String retryAfterFailure, String jsonParams, String callbackUrl) Update given Auth application
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateClientApplicationById(String applicationId, ApplicationDTO applicationDTO) Update given Auth application
ApiResponse<ApplicationKeyDTO>	updateKeys(String applicationId, String keyType, ApplicationKeyDTO applicationKeyDTO) Regenerate consumer secret of an application
void	waitForSwaggerDocument(String userName, String apiName, String apiVersion, String expectedResponse, String executionMode) Wait for swagger document until its updated.

Methods inherited from class java.lang.Object

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

Field Detail

apIsApi

public ApIsApi apIsApi

applicationsApi

public ApplicationsApi applicationsApi

subscriptionIndividualApi

public SubscriptionsApi subscriptionIndividualApi

applicationKeysApi

public ApplicationKeysApi applicationKeysApi

commentsApi

public CommentsApi commentsApi

ratingsApi

public RatingsApi ratingsApi

tagsApi

public TagsApi tagsApi

sdKsApi

public SdKsApi sdKsApi

apiKeysApi

public ApiKeysApi apiKeysApi

unifiedSearchApi

public UnifiedSearchApi unifiedSearchApi

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

storeURL

public String storeURL

tenantDomain

public String tenantDomain

Constructor Detail

RestAPIStoreImpl

@Deprecated
public RestAPIStoreImpl()

Deprecated.

RestAPIStoreImpl

public RestAPIStoreImpl(String username,
                        String password,
                        String tenantDomain,
                        String storeURL)

RestAPIStoreImpl

public RestAPIStoreImpl(String tenantDomain,
                        String storeURL)

Method Detail

createApplication

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse createApplication(String appName,
                                                                                        String description,
                                                                                        String throttleTier,
                                                                                        ApplicationDTO.TokenTypeEnum tokenType)

createApplicationWithCustomAttribute

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse createApplicationWithCustomAttribute(String appName,
                                                                                                           String description,
                                                                                                           String throttleTier,
                                                                                                           ApplicationDTO.TokenTypeEnum tokenType,
                                                                                                           Map<String,String> attribute)

deleteApplication

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse deleteApplication(String applicationId)

getAllApps

public ApplicationListDTO getAllApps()
                              throws ApiException

Throws:

ApiException

updateApplicationByID

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateApplicationByID(String applicationId,
                                                                                            String appName,
                                                                                            String description,
                                                                                            String throttleTier,
                                                                                            ApplicationDTO.TokenTypeEnum tokenType)

createSubscription

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse createSubscription(String apiId,
                                                                                         String applicationId,
                                                                                         String subscriptionTier)

getSubscription

public SubscriptionListDTO getSubscription(String apiId,
                                           String applicationId,
                                           String apiType,
                                           String groupId)
                                    throws ApiException

Throws:

ApiException

removeSubscription

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse removeSubscription(String subscriptionId)
                                                                                  throws ApiException

Throws:

ApiException

generateKeys

public ApplicationKeyDTO generateKeys(String applicationId,
                                      String validityTime,
                                      String callBackUrl,
                                      ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum,
                                      ArrayList<String> scopes,
                                      List<String> grantTypes)
                               throws ApiException

Throws:

ApiException

generateAPIKeys

public APIKeyDTO generateAPIKeys(String applicationId,
                                 String keyType,
                                 int validityPeriod)
                          throws ApiException

Throws:

ApiException

updateKeys

public ApiResponse<ApplicationKeyDTO> updateKeys(String applicationId,
                                                 String keyType,
                                                 ApplicationKeyDTO applicationKeyDTO)
                                          throws Exception

Regenerate consumer secret of an application

Parameters:

applicationId - - ID of the application

keyType - - PRODUCTION or SANDBOX

applicationKeyDTO - - application DTO to be updated

Returns:

- APIResponse of update request

Throws:

ApiException - - throws if update keys fails.

Exception

regenerateConsumerSecret

public ApiResponse<ApplicationKeyReGenerateResponseDTO> regenerateConsumerSecret(String applicationId,
                                                                                 String keyType)
                                                                          throws Exception

Regenerate consumer secret of an application

Parameters:

applicationId - - ID of the application

keyType - - PRODUCTION or SANDBOX

Returns:

- APIResponse of re-generate request

Throws:

ApiException - - throws if consumer secret re-generationx fails.

Exception

getApplicationKeysByKeyType

public ApiResponse<ApplicationKeyDTO> getApplicationKeysByKeyType(String applicationId,
                                                                  String keyType)
                                                           throws Exception

Regenerate consumer secret of an application

Parameters:

applicationId - - ID of the application

keyType - - PRODUCTION or SANDBOX

Returns:

- APIResponse of get application keys request

Throws:

ApiException - - throws if get application keys fails.

Exception

getAPI

public APIDTO getAPI(String apiId)
              throws ApiException

Get api which are published

Returns:

- http response of get API post request

Throws:

ApiException - - throws if API information retrieval fails.

getAllPublishedAPIs

public APIListDTO getAllPublishedAPIs()
                               throws APIManagerIntegrationTestException

Get all published apis

Returns:

- http response of get all published apis

Throws:

APIManagerIntegrationTestException - - throws if getting publish APIs fails

getAllAPIs

public APIListDTO getAllAPIs()
                      throws ApiException

Returns:

Throws:

ApiException

getAllAPIs

public APIListDTO getAllAPIs(String tenantDomain)
                      throws ApiException

Returns:

Throws:

ApiException

searchAPIs

public SearchResultListDTO searchAPIs(String query)
                               throws ApiException

Retrieve the APIs according to the search query in Publisher.

Parameters:

query - - The query on which the APIs needs to be filtered

Returns:

SearchResultListDTO - The search results of the query

Throws:

ApiException

searchAPIs

public SearchResultListDTO searchAPIs(String query,
                                      String tenantDomain)
                               throws ApiException

Retrieve the APIs according to the search query in Publisher.

Parameters:

query - - The query on which the APIs needs to be filtered

tenantDomain - - The tenant domain on which the APIs needs to be filtered

Returns:

SearchResultListDTO - The search results of the query

Throws:

ApiException

getAPIs

public APIListDTO getAPIs(int offset,
                          int limit)
                   throws ApiException

Get APIs for the given limit and offset values

Parameters:

offset - starting position

limit - maximum number of APIs to return

Returns:

APIs for the given limit and offset values

Throws:

ApiException

getApplicationById

public ApplicationDTO getApplicationById(String applicationId)
                                  throws ApiException

Get application by ID

Returns:

- http response of get of application

Throws:

ApiException - - throws if get application fails.

getPublishedAPIsByApplication

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getPublishedAPIsByApplication(String applicationName)
                                                                                             throws APIManagerIntegrationTestException

Get application details by given name

Parameters:

applicationName - - application name

Returns:

- http response of get application request

Throws:

APIManagerIntegrationTestException - - throws if get application by name fails

getPublishedAPIsByApplicationId

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getPublishedAPIsByApplicationId(String applicationName,
                                                                                                      int applicationId)
                                                                                               throws APIManagerIntegrationTestException

Get application details by given name

Parameters:

applicationName - - application name

Returns:

- http response of get application request

Throws:

APIManagerIntegrationTestException - - throws if get application by name fails

addRating

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse addRating(String apiId,
                                                                                Integer rating,
                                                                                String tenantDomain)
                                                                         throws ApiException

Add rating into api

Parameters:

apiId - - api Id

rating - - api rating

tenantDomain - - tenant domain

Returns:

- http response of add rating request

Throws:

ApiException - - throws if rating of api fails

removeRating

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse removeRating(String apiId,
                                                                                   String tenantDomain)

Remove rating from given API

Parameters:

apiId - - api Id

tenantDomain - - tenant domain

Throws:

ApiException - - throws if remove rating fails

removeRatingFromAPI

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse removeRatingFromAPI(String apiName,
                                                                                          String version,
                                                                                          String provider)
                                                                                   throws APIManagerIntegrationTestException

Remove rating of given API

Parameters:

apiName - - name of api

version - - api version

provider - - provider of api

Returns:

- http response of remove rating request

Throws:

APIManagerIntegrationTestException - - Throws if remove API rating fails

isRatingActivated

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse isRatingActivated()
                                                                                 throws APIManagerIntegrationTestException

Check if API rating activated

Returns:

- http response of rating activated request

Throws:

APIManagerIntegrationTestException - - Throws if rating status cannot be retrieved

getAllDocumentationOfAPI

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getAllDocumentationOfAPI(String apiName,
                                                                                               String version,
                                                                                               String provider)
                                                                                        throws APIManagerIntegrationTestException

Method to retrieve all documents of given api

Parameters:

apiName - - name of api

version - - api version

provider - - provider of api

Returns:

- http response of get all documentation of APIs

Throws:

APIManagerIntegrationTestException - - throws if retrieval of API documentation fails

getApiEndpointUrls

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getApiEndpointUrls(String apiName,
                                                                                         String version,
                                                                                         String provider)
                                                                                  throws APIManagerIntegrationTestException

Method to retrieve all endpoint urls

Throws:

APIManagerIntegrationTestException

getAllPaginatedPublishedAPIs

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getAllPaginatedPublishedAPIs(String tenant,
                                                                                                   String start,
                                                                                                   String end)
                                                                                            throws APIManagerIntegrationTestException

Get all paginated published API for a given tenant

Parameters:

tenant - - tenant name

start - - starting index

end - - closing index

Returns:

- http response of paginated published APIs

Throws:

APIManagerIntegrationTestException - - throws if paginated apis cannot be retrieved.

cleanUpApplicationRegistrationByApplicationId

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse cleanUpApplicationRegistrationByApplicationId(String applicationId,
                                                                                                                    String keyType)
                                                                                                             throws APIManagerIntegrationTestException,
                                                                                                                    ApiException

Clean up application registration by ID

Parameters:

applicationId - - application ID

keyType - - key type

Returns:

- http response of paginated published APIs

Throws:

APIManagerIntegrationTestException - - throws if paginated apis cannot be retrieved.

ApiException

getAllPaginatedPublishedAPIs

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getAllPaginatedPublishedAPIs(String tenant,
                                                                                                   int start,
                                                                                                   int end)
                                                                                            throws APIManagerIntegrationTestException

Gell all paginated published apis for a given tenant

Parameters:

tenant - - tenant name

start - - starting index

end - - ending index

Throws:

APIManagerIntegrationTestException

getAllPublishedAPIs

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getAllPublishedAPIs(String tenant)
                                                                                   throws APIManagerIntegrationTestException

Get all published APIs for tenant

Parameters:

tenant - - tenant name

Returns:

- http response of published API

Throws:

APIManagerIntegrationTestException - - throws if published API retrieval fails.

addApplication

public ApplicationDTO addApplication(String application,
                                     String tier,
                                     String callbackUrl,
                                     String description)
                              throws ApiException

Add application

Parameters:

application - - application name

tier - - throttling tier

callbackUrl - - callback url

description - - description of app

Returns:

- http response of add application

Throws:

APIManagerIntegrationTestException - - if fails to add application

ApiException

addApplicationWithGroup

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse addApplicationWithGroup(String application,
                                                                                              String tier,
                                                                                              String callbackUrl,
                                                                                              String description,
                                                                                              String groupId)
                                                                                       throws APIManagerIntegrationTestException

Add application with Group

Parameters:

application - - application name

tier - - throttling tier

callbackUrl - - callback url

description - - description of app

groupId - - group to share

Returns:

- http response of add application

Throws:

APIManagerIntegrationTestException - - if fails to add application

addApplicationWithTokenType

public ApplicationDTO addApplicationWithTokenType(String application,
                                                  String tier,
                                                  String callbackUrl,
                                                  String description,
                                                  String tokenType)
                                           throws ApiException

Add application with token type

Parameters:

application - - application name

tier - - throttling tier

callbackUrl - - callback url

description - - description of app

tokenType - - token type of app (JWT ot DEFAULT)

Returns:

- ApplicationDTO of add application

Throws:

APIManagerIntegrationTestException - - if fails to add application

ApiException

getApplications

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getApplications()
                                                                               throws APIManagerIntegrationTestException

Get application

Returns:

- http response of get applications

Throws:

APIManagerIntegrationTestException - - throws if applications cannot be retrieved.

removeApplicationById

public void removeApplicationById(String applicationId)
                           throws ApiException

Delete application by Id

Parameters:

applicationId - - application Id

Throws:

APIManagerIntegrationTestException - - throws if remove application fails

ApiException

updateApplication

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateApplication(String applicationOld,
                                                                                        String applicationNew,
                                                                                        String callbackUrlNew,
                                                                                        String descriptionNew,
                                                                                        String tier)
                                                                                 throws APIManagerIntegrationTestException

Update given application

Parameters:

applicationOld - - application name old

applicationNew - - new application name

callbackUrlNew - - call back url

descriptionNew - - updated description

tier - - access tier

Returns:

- http response of update application

Throws:

APIManagerIntegrationTestException - - throws if update application fails

updateApplicationById

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateApplicationById(int applicationId,
                                                                                            String applicationOld,
                                                                                            String applicationNew,
                                                                                            String callbackUrlNew,
                                                                                            String descriptionNew,
                                                                                            String tier)
                                                                                     throws APIManagerIntegrationTestException

Update given application

Parameters:

applicationOld - - application name old

applicationNew - - new application name

callbackUrlNew - - call back url

descriptionNew - - updated description

tier - - access tier

Returns:

- http response of update application

Throws:

APIManagerIntegrationTestException - - throws if update application fails

updateClientApplication

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateClientApplication(String application,
                                                                                              String keyType,
                                                                                              String authorizedDomains,
                                                                                              String retryAfterFailure,
                                                                                              String jsonParams,
                                                                                              String callbackUrl)
                                                                                       throws APIManagerIntegrationTestException

Update given Auth application

Parameters:

application - auth application name

keyType - type of the key

authorizedDomains - authorized domains

retryAfterFailure - retry after fail

jsonParams - json parameters for grant type

callbackUrl - call back url

Returns:

Http response of the update request

Throws:

APIManagerIntegrationTestException - APIManagerIntegrationTestException - throws if update application fail

updateClientApplicationById

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateClientApplicationById(String applicationId,
                                                                                                  ApplicationDTO applicationDTO)

Update given Auth application

Parameters:

applicationId - auth application id

applicationDTO - DTO of the application

Returns:

Http response of the update request

Throws:

APIManagerIntegrationTestException - APIManagerIntegrationTestException - throws if update application fail

regenerateConsumerSecret

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse regenerateConsumerSecret(String clientId)
                                                                                        throws APIManagerIntegrationTestException

Regenerate consumer secret.

Parameters:

clientId - Consumer Key of an application for which consumer secret need to be regenerate.

Returns:

Regenerated consumer secret.

Throws:

APIManagerIntegrationTestException - Throws if regeneration of consumer secret fail.

getAllSubscriptionsOfApplication

public SubscriptionListDTO getAllSubscriptionsOfApplication(String applicationId)
                                                     throws ApiException

Get All subscriptions for an application.

Parameters:

applicationId - application

Returns:

Throws:

ApiException - Throws if an error occurred when getting subscriptions.

getSubscribedAPIs

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getSubscribedAPIs(String applicationName)
                                                                                 throws APIManagerIntegrationTestException

Get subscribed Apis by application name

Parameters:

applicationName - - Application Name

Throws:

APIManagerIntegrationTestException

getSubscribedAPIs

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getSubscribedAPIs(String applicationName,
                                                                                        String domain)
                                                                                 throws APIManagerIntegrationTestException

Get subscribed APIs for the specific Application

Parameters:

applicationName - - Name of the Application of API in store

Returns:

- HttpResponse - Response with subscribed APIs

Throws:

APIManagerIntegrationTestException

removeAPISubscription

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse removeAPISubscription(String API,
                                                                                            String version,
                                                                                            String provider,
                                                                                            String applicationId)
                                                                                     throws APIManagerIntegrationTestException

Unsubscribe from API

Parameters:

API - - name of api

version - - api version

provider - - provider name

applicationId - - application id

Returns:

- http response of unsubscription request

Throws:

APIManagerIntegrationTestException - - Throws if unsubscription fails

removeAPISubscriptionByApplicationName

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse removeAPISubscriptionByApplicationName(String API,
                                                                                                             String version,
                                                                                                             String provider,
                                                                                                             String applicationName)
                                                                                                      throws APIManagerIntegrationTestException

Unsubscribe from API by application name

Parameters:

API - - name of api

version - - api version

provider - - provider name

applicationName - - application Name

Returns:

- http response of unsubscription request

Throws:

APIManagerIntegrationTestException - - Throws if unsubscription fails

removeAPISubscriptionByName

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse removeAPISubscriptionByName(String API,
                                                                                                  String version,
                                                                                                  String provider,
                                                                                                  String appName)
                                                                                           throws APIManagerIntegrationTestException

Unsubscribe from API

Parameters:

API - - name of api

version - - api version

provider - - provider name

appName - - application name

Returns:

- http response of unsubscription request

Throws:

APIManagerIntegrationTestException - - Throws if unsubscription fails

getAllTags

public TagListDTO getAllTags()
                      throws ApiException

Get all API tags

Returns:

- http response of get all api tags

Throws:

APIManagerIntegrationTestException - - throws if get all tags fails

ApiException

addComment

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse addComment(String apiId,
                                                                                 String comment)
                                                                          throws ApiException

Add comment to given API

Parameters:

apiId - - api Id

comment - - comment to add

Returns:

- http response of add comment

Throws:

ApiException - - throws if add comment fails

removeComment

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse removeComment(String commentId,
                                                                                    String apiId)
                                                                             throws ApiException

Remove comment in given API

Parameters:

commentId - - comment Id

apiId - - api Id

Throws:

ApiException - - throws if remove comment fails

getComment

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getComment(String commentId,
                                                                                 String apiId,
                                                                                 String tenantDomain)
                                                                          throws ApiException

Get Comment from given API

Parameters:

commentId - - comment Id

apiId - - api Id

tenantDomain - - tenant domain

Returns:

- http response get comment

Throws:

ApiException - - throws if get comment fails

isCommentActivated

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse isCommentActivated()
                                                                                  throws APIManagerIntegrationTestException

Check whether commenting is enabled

Returns:

- http response of comment status

Throws:

APIManagerIntegrationTestException - - Throws if retrieving comment activation status fails.

getRecentlyAddedAPIs

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getRecentlyAddedAPIs(String tenant,
                                                                                           String limit)
                                                                                    throws APIManagerIntegrationTestException

Get recently added APIs by tenant

Parameters:

tenant - - tenant name

limit - - limit of result set

Returns:

- http response of recently added API request

Throws:

APIManagerIntegrationTestException - - throws if

getAPIsFilteredWithTags

public APIListDTO getAPIsFilteredWithTags(String apiTag)
                                   throws APIManagerIntegrationTestException,
                                          ApiException

Get the web page with filtered API when click the API Tag link

Parameters:

apiTag - - API tag the need ti filter the api.waitForSwaggerDocument

Returns:

HttpResponse - Response that contains the web page with filtered API when click the API Tag link

Throws:

APIManagerIntegrationTestException - - Exception throws when check the Authentication and HTTPSClientUtils.sendGetRequest() method call

ApiException

searchPaginatedAPIs

public APIListDTO searchPaginatedAPIs(int limit,
                                      int offset,
                                      String tenantDomain,
                                      String query)
                               throws ApiException

Get the web page with filtered API when click the API Tag link

Parameters:

limit - - number of APIs needs to be returned

offset - - offset where the APIs needs to be returned should start

tenantDomain - - tenant domain of which the APIs to be returned

query - - query that needs to be passed to the backend

Returns:

APIListDTO - The DTO which contains the list of matching APIs

Throws:

ApiException - - Exception throws when check the Authentication and HTTPSClientUtils.sendGetRequest() method call

subscribeToAPI

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse subscribeToAPI(SubscriptionRequest subscriptionRequest)
                                                                              throws APIManagerIntegrationTestException

Subscribe and API. This method return the response of the subscription server REST call.

Parameters:

subscriptionRequest - -SubscriptionRequest request instance with API subscription information.

Returns:

HttpResponse - Response f the subscription server REST call

Throws:

APIManagerIntegrationTestException - - Exception throws when check the Authentication and HTTPSClientUtils.doPost() method call.

subscribeToAPI

public SubscriptionDTO subscribeToAPI(String apiID,
                                      String appID,
                                      String tier)
                               throws ApiException

Throws:

ApiException

getAPIListFromStoreAsAnonymousUser

public APIListDTO getAPIListFromStoreAsAnonymousUser(String tenantDomain)
                                              throws ApiException

Parameters:

tenantDomain -

Returns:

Throws:

ApiException

logout

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse logout()
                                                                      throws APIManagerIntegrationTestException

API Store logout

Throws:

APIManagerIntegrationTestException

signUp

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse signUp(String userName,
                                                                             String password,
                                                                             String firstName,
                                                                             String lastName,
                                                                             String email)
                                                                      throws APIManagerIntegrationTestException

API Store sign up

Parameters:

userName - - store user name

password - -store password

firstName - - user first name

lastName - - user's last name

email - - user's email

Returns:

Throws:

APIManagerIntegrationTestException

signUpforTenant

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse signUpforTenant(String userName,
                                                                                      String password,
                                                                                      String claims)
                                                                               throws APIManagerIntegrationTestException

API Store sign up

Parameters:

userName - - store user name

password - -store password

claims - - tenants claims

Returns:

Throws:

APIManagerIntegrationTestException

signUpWithOrganization

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse signUpWithOrganization(String userName,
                                                                                             String password,
                                                                                             String firstName,
                                                                                             String lastName,
                                                                                             String email,
                                                                                             String organization)
                                                                                      throws APIManagerIntegrationTestException

API Store sign up with organization

Parameters:

userName - - store user name

password - -store password

firstName - - user first name

lastName - - user's last name

email - - user's email

organization - - user's organization

Returns:

Throws:

APIManagerIntegrationTestException

getPrototypedAPIs

public APIListDTO getPrototypedAPIs(String tenant)
                             throws APIManagerIntegrationTestException

Get Prototyped APIs in Store

Returns:

HttpResponse - Response with APIs which are deployed as a Prototyped APIs

Throws:

APIManagerIntegrationTestException

waitForSwaggerDocument

public void waitForSwaggerDocument(String userName,
                                   String apiName,
                                   String apiVersion,
                                   String expectedResponse,
                                   String executionMode)
                            throws IOException,
                                   XPathExpressionException

Wait for swagger document until its updated.

Parameters:

userName - - Name of the api provider

apiName - - API Name

apiVersion - - API Version

expectedResponse - - Expected response of the API

executionMode - - Mode of the test execution (Standalone or Platform)

Throws:

IOException - - Throws if Swagger document cannot be found

XPathExpressionException - - Throws if Swagger document cannot be found

getSwaggerDocument

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getSwaggerDocument(String userName,
                                                                                         String apiName,
                                                                                         String apiVersion,
                                                                                         String executionMode)
                                                                                  throws APIManagerIntegrationTestException

This method will return swagger document of given api name and version

Parameters:

userName - - User who request the swagger document

apiName - - Name of the API

apiVersion - - Version of the API

executionMode - - Mode of the test execution (Standalone or Platform)

Returns:

- HTTP Response of the GET swagger document request

Throws:

APIManagerIntegrationTestException - - Throws if swagger document GET request fails

getApplicationPage

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getApplicationPage()
                                                                                  throws APIManagerIntegrationTestException

Get application page

Returns:

- http response of get application

Throws:

APIManagerIntegrationTestException - - if fails to get application page

generateSDKUpdated

public ApiResponse<byte[]> generateSDKUpdated(String apiId,
                                              String language)
                                       throws ApiException,
                                              IOException

Generate SDK for a given programming language

Parameters:

apiId - The api id which the sdk should be downloaded.

language - The required sdk language.

Returns:

org.apache.http.HttpResponse for the SDK generation

Throws:

APIManagerIntegrationTestException - if failed to generate the SDK

ApiException

IOException

generateSDKUpdated

public ApiResponse<byte[]> generateSDKUpdated(String apiId,
                                              String language,
                                              String tenantDomain)
                                       throws ApiException,
                                              IOException

Generate SDK for a given programming language

Parameters:

apiId - The api id which the sdk should be downloaded.

language - The required sdk language.

tenantDomain - The tenant domain of the sdk to be generated

Returns:

org.apache.http.HttpResponse for the SDK generation

Throws:

APIManagerIntegrationTestException - if failed to generate the SDK

ApiException

IOException

changePassword

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse changePassword(String username,
                                                                                     String currentPassword,
                                                                                     String newPassword)
                                                                              throws APIManagerIntegrationTestException

Change password of the user

Parameters:

username - username of the user

currentPassword - current password of the user

newPassword - new password of the user

Returns:

Throws:

APIManagerIntegrationTestException - if failed to change password

addApplicationWithCustomAttributes

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse addApplicationWithCustomAttributes(String application,
                                                                                                         String tier,
                                                                                                         String callbackUrl,
                                                                                                         String description,
                                                                                                         String applicationAttributes)
                                                                                                  throws APIManagerIntegrationTestException

Add application with custom attributes

Parameters:

application - - application name

tier - - throttling tier

callbackUrl - - callback url

description - - description of app

applicationAttributes - - Json string of custom attributes defined by user

Returns:

- http response of add application

Throws:

APIManagerIntegrationTestException - - if fails to add application

getSwaggerByID

public String getSwaggerByID(String apiId,
                             String tenantDomain)
                      throws ApiException

Throws:

ApiException

generateUserAccessKey

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse generateUserAccessKey(String consumeKey,
                                                                                            String consumerSecret,
                                                                                            String messageBody,
                                                                                            URL tokenEndpointURL)
                                                                                     throws APIManagerIntegrationTestException

Generate user access key

Parameters:

consumeKey - - consumer key of user

consumerSecret - - consumer secret key

messageBody - - message body

tokenEndpointURL - - token endpoint url

Returns:

- http response of generate access token api call

Throws:

APIManagerIntegrationTestException - - throws if generating APIM access token fails