Package 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	Description
ApiKeysApi	apiKeysApi
ApIsApi	apIsApi
ApplicationKeysApi	applicationKeysApi
ApplicationsApi	applicationsApi
static final String	appName
static final String	appOwner
static final String	callBackURL
CommentsApi	commentsApi
static final String	grantType
GraphQlPoliciesApi	graphQlPoliciesApi
KeyManagersCollectionApi	keyManagersCollectionApi
McpServersApi	mcpServersApi
static final String	password
RatingsApi	ratingsApi
SdKsApi	sdKsApi
String	storeURL
SubscriptionsApi	subscriptionIndividualApi
TagsApi	tagsApi
String	tenantDomain
static final String	testNameProperty
ThrottlingPoliciesApi	throttlingPoliciesApi
static final String	tokenScope
TopicsApi	topicsApi
UnifiedSearchApi	unifiedSearchApi
static final String	username
UsersApi	usersApi
WebhooksApi	webhooksApi

Constructor Summary

Constructors

Constructor	Description
RestAPIStoreImpl(String tenantDomain, String storeURL)
RestAPIStoreImpl(String username, String password, String tenantDomain, String storeURL)

Method Summary

Modifier and Type	Method	Description
ApplicationDTO	addApplication(String application, String tier, String callbackUrl, String description)	Add application
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, String category, String replyTo)	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
ApiResponse<ApplicationDTO>	applicationsPostWithHttpInfo(String application, String tier, String description)	Add application
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	changePassword(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)
ApiResponse<ApplicationDTO>	createApplicationWithHttpInfo(String appName, String description, String throttleTier, ApplicationDTO.TokenTypeEnum tokenType)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	createApplicationWithOrganization(String appName, String description, String throttleTier, ApplicationDTO.TokenTypeEnum tokenType, List<String> groups)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	createApplicationWithOrganizationSharing(String appName, String description, String throttleTier, ApplicationDTO.TokenTypeEnum tokenType, ApplicationDTO.VisibilityEnum orgVisibility)
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)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	deleteApplicationWithHttpResponse(String applicationId)
ApiResponse<Void>	downloadWSDLSchemaDefinitionOfAPI(String apiId, String environmentName)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	editComment(String commentId, String apiId, String comment, String category)	Get Comment from given API
APIKeyDTO	generateAPIKeys(String applicationId, String keyType, int validityPeriod, String permittedIP, String permittedReferer, String keyName)
ApplicationKeyDTO	generateKeys(String applicationId, String validityTime, String callBackUrl, ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum, ArrayList<String> scopes, List<String> grantTypes)
ApplicationKeyDTO	generateKeys(String applicationId, String validityTime, String callBackUrl, ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum, ArrayList<String> scopes, List<String> grantTypes, String keyManager)
ApplicationKeyDTO	generateKeys(String applicationId, String validityTime, String callBackUrl, ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum, List<String> scopes, List<String> grantTypes, Map<String,Object> additionalProperties, String keyManager)
ApplicationKeyDTO	generateKeysWithAdditionalProperties(String applicationId, String validityTime, String callBackUrl, ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum, List<String> scopes, List<String> grantTypes, Map<String,Object> additionalProperties)
ApiResponse<ApplicationKeyDTO>	generateKeysWithApiResponse(String applicationId, String validityTime, String callBackUrl, ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum, List<String> scopes, List<String> grantTypes, Map<String,Object> additionalProperties, String keyManager)
ApiResponse<ApplicationKeyDTO>	generateKeysWithHttpInfo(String applicationId, String validityTime, String callBackUrl, ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum, ArrayList<String> scopes, List<String> grantTypes, String keyManager)
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
String	getAccessToken()
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
APIListDTO	getAllMCPServers(Integer limit, Integer offset, String xWSO2Tenant, String query)
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.
SubscriptionListDTO	getAllSubscriptionsOfApplication(String applicationId, String tenantDomain)	Get All subscriptions for an application.
TagListDTO	getAllTags()	Get all API tags
APIDTO	getAPI(String apiId)	Get api which are published
APIDTO	getAPI(String apiId, String tenantDomain)	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
APIKeyListDTO	getAPIKeys(String applicationId, String keyType)
APIListDTO	getAPIListFromStoreAsAnonymousUser(String tenantDomain)
APIListDTO	getAPIs(int offset, int limit)	Get APIs for the given limit and offset values
APIListDTO	getAPIs(int offset, int limit, String tenantDomain, String query)	Get APIs for the given limit, offset values and query
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
ApplicationDTO	getApplicationById(String applicationId, String tenantDomain)	Get application by ID
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getApplicationByIdWithHttpResponse(String applicationId)	Get application by ID with Http response details
ApplicationKeyDTO	getApplicationKeyByKeyMappingId(String applicationId, String keyMappingId)
ApplicationKeyListDTO	getApplicationKeysByAppId(String jwtAppId)
ApiResponse<ApplicationKeyDTO>	getApplicationKeysByKeyType(String applicationId, String keyType)	Regenerate consumer secret of an application
ApplicationKeyListDTO	getApplicationOauthKeys(String applicationUUID, String tenantDomain)
ThrottlingPolicyListDTO	getApplicationPolicies(String tenantDomain)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getApplications()	Get application
ApplicationListDTO	getApplications(String applicationName)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getComment(String commentId, String apiId, String tenantDomain, boolean includeCommentorInfo, Integer limit, Integer offset)	Get Comment from given API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getComments(String apiId, String tenantDomain, boolean includeCommentorInfo, Integer limit, Integer offset)	Get all the comments from given API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getGraphQLComplexityResponse(String apiId)	Method to retrieve the GraphQL Complexity Details
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getGraphQLSchemaTypeListResponse(String apiId)	Method to retrieve the GraphQL Schema Type List
KeyManagerListDTO	getKeyManagers()
KeyManagerListDTO	getKeyManagers(String tenantDomain)
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	getReplies(String commentId, String apiId, String tenantDomain, boolean includeCommentorInfo, Integer limit, Integer offset)	Get replies of a comment from given API
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	getTopics(String apiId, String tenantDomain)
OrganizationInfoDTO	getUserOrganization()
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getWebhooks(String apiId, String applicationId, String tenantDomain)
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
ApplicationKeyDTO	mapConsumerKeyWithApplication(String consumerKey, String consumerSecret, String appid, String keyManager)
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
ApplicationKeyReGenerateResponseDTO	regenerateSecretByKeyMappingId(String applicationId, String keyMappingId)	Regenerate Consumer Secret by key mapping ID
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(SubscriptionDTO subscriptionDTO)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeSubscriptionWithHttpInfo(String subscriptionId)
ApiResponse<Void>	resetApplicationThrottlePolicy(String applicationId, String userId)	Reset Application Throttle policy for given application and user
void	revokeAPIKey(String applicationId, String apiKey)
void	revokeAPIKeyByKeyUUID(String applicationId, String keyType, String keyUUID)
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
void	setAccessToken(String accessToken)
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
SubscriptionDTO	subscribeToAPI(String apiID, String appID, String tier)
SubscriptionDTO	subscribeToAPI(String apiID, String appID, String tier, String tenantDomain)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	subscribeToAPIWithResponse(String apiID, String appID, String tier)
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)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateApplicationByID(String applicationId, String appName, String description, String throttleTier, Map<String,String> attributes)	Updates an existing application with the provided details and custom attributes.
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	updateApplicationByID(String applicationId, String appName, String description, String throttleTier, ApplicationDTO.TokenTypeEnum tokenType, List<String> groups)	Update shared Application by ID with the organization
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateApplicationByID(String applicationId, String appName, String description, String throttleTier, ApplicationDTO.TokenTypeEnum tokenType, ApplicationDTO.VisibilityEnum orgVisibility)
ApplicationKeyDTO	updateApplicationKeyByKeyMappingId(String applicationId, String keyMappingId, ApplicationKeyDTO applicationKeyDTO)
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
SubscriptionDTO	updateSubscriptionToAPI(String apiID, String appID, String existingTier, String requestedTier, SubscriptionDTO.StatusEnum subscriptionStatus, String subscriptionId, String xWso2Tenant)	Update subscription to an API of a specific tenant

Methods inherited from class java.lang.Object

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

Field Details

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

testNameProperty

public static final String testNameProperty

See Also:

• Constant Field Values

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

keyManagersCollectionApi

public KeyManagersCollectionApi keyManagersCollectionApi

graphQlPoliciesApi

public GraphQlPoliciesApi graphQlPoliciesApi

throttlingPoliciesApi

public ThrottlingPoliciesApi throttlingPoliciesApi

usersApi

public UsersApi usersApi

topicsApi

public TopicsApi topicsApi

webhooksApi

public WebhooksApi webhooksApi

mcpServersApi

public McpServersApi mcpServersApi

storeURL

public String storeURL

tenantDomain

public String tenantDomain

Constructor Details

RestAPIStoreImpl

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

RestAPIStoreImpl

public RestAPIStoreImpl(String tenantDomain,
 String storeURL)

Method Details

getAccessToken

public String getAccessToken()

setAccessToken

public void setAccessToken(String accessToken)

createApplication

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

Throws:

APIManagerIntegrationTestException

createApplicationWithHttpInfo

public ApiResponse<ApplicationDTO> createApplicationWithHttpInfo(String appName,
 String description,
 String throttleTier,
 ApplicationDTO.TokenTypeEnum tokenType)
                                                          throws ApiException

Throws:

ApiException

createApplicationWithOrganization

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse createApplicationWithOrganization(String appName,
 String description,
 String throttleTier,
 ApplicationDTO.TokenTypeEnum tokenType,
 List<String> groups)

createApplicationWithOrganizationSharing

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse createApplicationWithOrganizationSharing(String appName,
 String description,
 String throttleTier,
 ApplicationDTO.TokenTypeEnum tokenType,
 ApplicationDTO.VisibilityEnum orgVisibility)
                                                                                                        throws APIManagerIntegrationTestException

Throws:

APIManagerIntegrationTestException

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)
                                                                                                    throws APIManagerIntegrationTestException

Throws:

APIManagerIntegrationTestException

deleteApplication

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

deleteApplicationWithHttpResponse

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse deleteApplicationWithHttpResponse(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)

updateApplicationByID

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

updateApplicationByID

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

updateApplicationByID

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

Update shared Application by ID with the organization

updateApplicationByID

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateApplicationByID(String applicationId,
 String appName,
 String description,
 String throttleTier,
 Map<String,String> attributes)

Updates an existing application with the provided details and custom attributes.

Parameters:

applicationId - The unique identifier of the application to be updated.

appName - The new name of the application.

description - The updated description of the application.

throttleTier - The throttling policy (application tier) to be applied to the application.

attributes - A map containing custom application attributes to be associated with the application.

Returns:

HttpResponse containing the response body and HTTP status code. Returns status code 200 if the application update is successful. If an error occurs, the response will contain the error body and the corresponding HTTP status code returned by the API.

createSubscription

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

Throws:

APIManagerIntegrationTestException

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(SubscriptionDTO subscriptionDTO)
                                                                                  throws ApiException,
APIManagerIntegrationTestException

Throws:

ApiException

APIManagerIntegrationTestException

removeSubscriptionWithHttpInfo

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse removeSubscriptionWithHttpInfo(String subscriptionId)

generateKeys

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

Throws:

ApiException

APIManagerIntegrationTestException

generateKeys

public ApplicationKeyDTO generateKeys(String applicationId,
 String validityTime,
 String callBackUrl,
 ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum,
 List<String> scopes,
 List<String> grantTypes,
 Map<String,Object> additionalProperties,
 String keyManager)
                               throws ApiException,
APIManagerIntegrationTestException

Throws:

ApiException

APIManagerIntegrationTestException

generateKeysWithAdditionalProperties

public ApplicationKeyDTO generateKeysWithAdditionalProperties(String applicationId,
 String validityTime,
 String callBackUrl,
 ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum,
 List<String> scopes,
 List<String> grantTypes,
 Map<String,Object> additionalProperties)
                                                       throws ApiException,
APIManagerIntegrationTestException

Throws:

ApiException

APIManagerIntegrationTestException

generateKeysWithApiResponse

public ApiResponse<ApplicationKeyDTO> generateKeysWithApiResponse(String applicationId,
 String validityTime,
 String callBackUrl,
 ApplicationKeyGenerateRequestDTO.KeyTypeEnum keyTypeEnum,
 List<String> scopes,
 List<String> grantTypes,
 Map<String,Object> additionalProperties,
 String keyManager)
                                                           throws ApiException

Throws:

ApiException

generateAPIKeys

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

Throws:

ApiException

getAPIKeys

public APIKeyListDTO getAPIKeys(String applicationId,
 String keyType)
                         throws ApiException

Throws:

ApiException

revokeAPIKey

public void revokeAPIKey(String applicationId,
 String apiKey)
                  throws ApiException

Throws:

ApiException

revokeAPIKeyByKeyUUID

public void revokeAPIKeyByKeyUUID(String applicationId,
 String keyType,
 String keyUUID)
                           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

regenerateSecretByKeyMappingId

public ApplicationKeyReGenerateResponseDTO regenerateSecretByKeyMappingId(String applicationId,
 String keyMappingId)
                                                                   throws ApiException

Regenerate Consumer Secret by key mapping ID

Parameters:

applicationId - ID of the application

keyMappingId - Keymapping Id

Returns:

APIResponse of re-generate request

Throws:

Exception

ApiException

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.

getAPI

public APIDTO getAPI(String apiId,
 String tenantDomain)
              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

getAPIs

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

Get APIs for the given limit, offset values and query

Parameters:

offset - starting position

limit - maximum number of APIs to return

tenantDomain - tenant domain

query - search query

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.

getApplicationByIdWithHttpResponse

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

Get application by ID with Http response details

Returns:

- http response of get of application

getApplicationById

public ApplicationDTO getApplicationById(String applicationId,
 String tenantDomain)
                                  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,
APIManagerIntegrationTestException

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

applicationsPostWithHttpInfo

public ApiResponse<ApplicationDTO> applicationsPostWithHttpInfo(String application,
 String tier,
 String description)
                                                         throws ApiException,
APIManagerIntegrationTestException

Add application

Parameters:

application - - application name

tier - - throttling tier

description - - description of app

Returns:

- http response of add application

Throws:

APIManagerIntegrationTestException - - if fails to add application

ApiException

addApplicationWithTokenType

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

Add application with token type

Parameters:

application - - application name

tier - - throttling tier

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

resetApplicationThrottlePolicy

public ApiResponse<Void> resetApplicationThrottlePolicy(String applicationId,
 String userId)
                                                 throws APIManagerIntegrationTestException

Reset Application Throttle policy for given application and user

Parameters:

applicationId - - uuid of the application

userId - - username for which the policy should be reset

Returns:

- http response of reset application throttle policy

Throws:

APIManagerIntegrationTestException

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

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.

getAllSubscriptionsOfApplication

public SubscriptionListDTO getAllSubscriptionsOfApplication(String applicationId,
 String tenantDomain)
                                                     throws ApiException

Get All subscriptions for an application.

Parameters:

applicationId - application

tenantDomain - requestedTenant

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,
 String category,
 String replyTo)
                                                                          throws ApiException

Add comment to given API

Parameters:

apiId - - api Id

comment - - comment to add

category - - category of the comment

replyTo - - comment id of the root comment to add replies

Returns:

- http response of add comment

Throws:

ApiException - - throws if add comment fails

getComment

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

Get Comment from given API

Parameters:

commentId - - comment Id

apiId - - api Id

tenantDomain - - tenant domain

limit - - for pagination

offset - - for pagination

Returns:

- http response get comment

Throws:

ApiException - - throws if get comment fails

getComments

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getComments(String apiId,
 String tenantDomain,
 boolean includeCommentorInfo,
 Integer limit,
 Integer offset)
                                                                           throws ApiException

Get all the comments from given API

Parameters:

apiId - - api Id

tenantDomain - - tenant domain

limit - - for pagination

offset - - for pagination

Returns:

- http response get comment

Throws:

ApiException - - throws if get comment fails

getTopics

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

getWebhooks

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

Throws:

ApiException

getReplies

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse getReplies(String commentId,
 String apiId,
 String tenantDomain,
 boolean includeCommentorInfo,
 Integer limit,
 Integer offset)
                                                                          throws ApiException

Get replies of a comment from given API

Parameters:

commentId - - comment Id

apiId - - api Id

tenantDomain - - tenant domain

limit - - for pagination

offset - - for pagination

Returns:

- http response get comment

Throws:

ApiException - - throws if get comment fails

editComment

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

Get Comment from given API

Parameters:

commentId - - comment Id

apiId - - api Id

comment - - comment to add

category - - category of the comment

Returns:

- http response get comment

Throws:

ApiException - - throws if get 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

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 SubscriptionDTO subscribeToAPI(String apiID,
 String appID,
 String tier)
                               throws ApiException,
APIManagerIntegrationTestException

Throws:

ApiException

APIManagerIntegrationTestException

subscribeToAPI

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

Throws:

ApiException

APIManagerIntegrationTestException

subscribeToAPIWithResponse

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse subscribeToAPIWithResponse(String apiID,
 String appID,
 String tier)
                                                                                          throws ApiException,
APIManagerIntegrationTestException

Throws:

ApiException

APIManagerIntegrationTestException

updateSubscriptionToAPI

public SubscriptionDTO updateSubscriptionToAPI(String apiID,
 String appID,
 String existingTier,
 String requestedTier,
 SubscriptionDTO.StatusEnum subscriptionStatus,
 String subscriptionId,
 String xWso2Tenant)
                                        throws ApiException,
APIManagerIntegrationTestException

Update subscription to an API of a specific tenant

Parameters:

apiID - API ID

appID - Application ID

existingTier - Existing subscription Tier

requestedTier - Requested subscription Tier

subscriptionStatus - subscription status

subscriptionId - Subscription ID

xWso2Tenant - Tenant Domain

Returns:

SubscriptionDTO

Throws:

ApiException - If an API exception occurs.

APIManagerIntegrationTestException

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

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

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 currentPassword,
 String newPassword)
                                                                              throws ApiException

Change password of the user

Parameters:

currentPassword - current password of the user

newPassword - new password of the user

Returns:

Throws:

ApiException - if failed to change password

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

downloadWSDLSchemaDefinitionOfAPI

public ApiResponse<Void> downloadWSDLSchemaDefinitionOfAPI(String apiId,
 String environmentName)
                                                    throws ApiException

Throws:

ApiException

getKeyManagers

public KeyManagerListDTO getKeyManagers()
                                 throws ApiException

Throws:

ApiException

getKeyManagers

public KeyManagerListDTO getKeyManagers(String tenantDomain)
                                 throws ApiException

Throws:

ApiException

getApplicationKeyByKeyMappingId

public ApplicationKeyDTO getApplicationKeyByKeyMappingId(String applicationId,
 String keyMappingId)
                                                  throws ApiException

Throws:

ApiException

updateApplicationKeyByKeyMappingId

public ApplicationKeyDTO updateApplicationKeyByKeyMappingId(String applicationId,
 String keyMappingId,
 ApplicationKeyDTO applicationKeyDTO)
                                                     throws ApiException

Throws:

ApiException

getApplicationKeysByAppId

public ApplicationKeyListDTO getApplicationKeysByAppId(String jwtAppId)
                                                throws ApiException

Throws:

ApiException

mapConsumerKeyWithApplication

public ApplicationKeyDTO mapConsumerKeyWithApplication(String consumerKey,
 String consumerSecret,
 String appid,
 String keyManager)
                                                throws ApiException

Throws:

ApiException

getGraphQLComplexityResponse

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

Method to retrieve the GraphQL Complexity Details

Parameters:

apiId - apiId of the API

Returns:

HttpResponse response

Throws:

ApiException

getGraphQLSchemaTypeListResponse

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

Method to retrieve the GraphQL Schema Type List

Parameters:

apiId - apiId of the API

Returns:

HttpResponse response

Throws:

ApiException

getApplicationPolicies

public ThrottlingPolicyListDTO getApplicationPolicies(String tenantDomain)
                                               throws ApiException

Throws:

ApiException

generateKeys

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

Throws:

ApiException

APIManagerIntegrationTestException

generateKeysWithHttpInfo

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

Throws:

ApiException

getAllMCPServers

public APIListDTO getAllMCPServers(Integer limit,
 Integer offset,
 String xWSO2Tenant,
 String query)
                            throws ApiException

Throws:

ApiException

getApplicationOauthKeys

public ApplicationKeyListDTO getApplicationOauthKeys(String applicationUUID,
 String tenantDomain)
                                              throws ApiException

Throws:

ApiException

getApplications

public ApplicationListDTO getApplications(String applicationName)
                                   throws ApiException

Throws:

ApiException

getUserOrganization

public OrganizationInfoDTO getUserOrganization()
                                        throws ApiException

Throws:

ApiException