org.wso2.am.integration.test.impl

Class RestAPIPublisherImpl

java.lang.Object

org.wso2.am.integration.test.impl.RestAPIPublisherImpl

public class RestAPIPublisherImpl
extends Object

This util class performs the actions related to APIDTOobjects.

Field Summary

Fields

Modifier and Type	Field and Description
ApiAuditApi	apiAuditApi
ApiDocumentsApi	apiDocumentsApi
ApiLifecycleApi	apiLifecycleApi
ApiClient	apiPublisherClient
ApIsApi	apIsApi
static String	appName
static String	appOwner
static String	callBackURL
ClientCertificatesApi	clientCertificatesApi
EndpointCertificatesApi	endpointCertificatesApi
static String	grantType
GraphQlSchemaApi	graphQlSchemaApi
GraphQlSchemaIndividualApi	graphQlSchemaIndividualApi
static String	password
RolesApi	rolesApi
SubscriptionsApi	subscriptionsApi
String	tenantDomain
ThrottlingPoliciesApi	throttlingPoliciesApi
static String	tokenScope
UnifiedSearchApi	unifiedSearchApi
static String	username
ValidationApi	validationApi

Constructor Summary

Constructors

Constructor and Description
RestAPIPublisherImpl() Deprecated.
RestAPIPublisherImpl(String username, String password, String tenantDomain, String publisherURL)

Method Summary

Modifier and Type	Method and Description
APIDTO	addAPI(APICreationRequestBean apiCreationRequestBean)
APIDTO	addAPI(APIDTO apidto, String osVersion)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	addAPI(APIRequest apiRequest) \ This method is used to create an API.
APIDTO	addAPI(APIRequest apiRequest, String osVersion) \ This method is used to create an API.
APIProductDTO	addApiProduct(APIProductDTO apiProductDTO)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	addContentDocument(String apiId, String docId, String docContent) Adding a content to the document
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	addDocument(String apiId, DocumentDTO body) Adding a documentation
void	blockAPI(String apiId) This method is used to block the created API.
WorkflowResponseDTO	changeAPILifeCycleStatus(String apiId, String action)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	changeAPILifeCycleStatus(String apiId, String action, String lifecycleChecklist) This method is used to publish the created API.
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	changeAPILifeCycleStatusToPublish(String apiId, boolean isRequireReSubscription) Change the API Lifecycle status to Publish with the option of Re-subscription is required or not
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	checkValidEndpoint(String endpointUrl, String apiId) Check whether the Endpoint is valid
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	copyAPI(String newVersion, String apiId, Boolean isDefault) copy API from existing API
APIDTO	copyAPIWithReturnDTO(String newVersion, String apiId, Boolean isDefault)
String	createNewAPIVersion(String newVersion, String apiId, boolean defaultVersion) This method is used to create a new API of the existing API.
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	deleteAPI(String apiId) delete API
void	deleteAPIByID(String apiId)
void	deleteApiProduct(String apiProductId)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	deleteDocument(String apiId, String documentId) delete Document
void	deployPrototypeAPI(String apiId) This method is used to deploy the api as a prototype.
void	deprecateAPI(String apiId) This method is used to deprecate the created API.
APIProductListDTO	getAllApiProducts()
APIListDTO	getAllAPIs() Retrieve the All APIs available for the user in Publisher.
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getAPI(String apiId) Method to get API information
APIDTO	getAPIByID(String apiId, String tenantDomain)
APIProductDTO	getApiProduct(String apiProductId)
APIListDTO	getAPIs(int offset, int limit) This method is used to upload endpoint certificates Get APIs for the given limit and offset values
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getAuditApi(String apiId) Method to retrieve the Audit Report of an API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getDocumentContent(String apiId, String documentId) This method is used to get the content of API documents
DocumentListDTO	getDocuments(String apiId) This method is used to get documents Get Documents for the given limit and offset values
GraphQLSchemaDTO	getGraphqlSchemaDefinition(String apiId)
LifecycleHistoryDTO	getLifecycleHistory(String apiId)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getLifecycleStatus(String apiId)
LifecycleStateDTO	getLifecycleStatusDTO(String apiId)
SubscriptionListDTO	getSubscriptionByAPIID(String apiID) Get subscription of an API
String	getSwaggerByID(String apiId)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	getTierPermissionsPage() Retrieve the Tier Permission Page
ThrottlingPolicyListDTO	getTiers(String policyLevel) This method is used to get all throttling tiers.
APIDTO	importGraphqlSchemaDefinition(File file, String properties)
APIDTO	importOASDefinition(File file, String properties)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	removeDocumentation(String apiId, String docId) Remove document
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	revokeAccessToken(String accessToken, String consumerKey, String authUser) revoke access token
SearchResultListDTO	searchAPIs(String query) Retrieve the APIs according to the search query in Publisher.
APIDTO	updateAPI(APIDTO apidto) Update an API
APIDTO	updateAPI(APIDTO apidto, String apiId)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateAPI(APIRequest apiRequest, String apiId) Facilitate update API
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateContentDocument(String apiId, String docId, File docContent) Updating the document content using file
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateDocument(String apiId, String docId, DocumentDTO documentDTO) Update API document.
void	updateGraphqlSchemaDefinition(String apiId, String schemaDefinition)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updatePermissions(String tierName, String permissionType, String roles) update permissions to API access
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	updateResourceOfAPI(String apiId, String api) Update resources of API
String	updateSwagger(String apiId, String definition)
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	uploadCertificate(File certificate, String alias, String apiId, String tier) This method is used to upload certificates
org.wso2.carbon.automation.test.utils.http.client.HttpResponse	uploadEndpointCertificate(File certificate, String alias, String endpoint) This method is used to upload certificates
GraphQLValidationResponseDTO	validateGraphqlSchemaDefinition(File schemaDefinition)
OpenAPIDefinitionValidationResponseDTO	validateOASDefinition(File oasDefinition)
ApiResponse<Void>	validateRoles(String roleId) This method is used to validate roles.

Methods inherited from class java.lang.Object

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

Field Detail

apIsApi

public ApIsApi apIsApi

apiDocumentsApi

public ApiDocumentsApi apiDocumentsApi

throttlingPoliciesApi

public ThrottlingPoliciesApi throttlingPoliciesApi

clientCertificatesApi

public ClientCertificatesApi clientCertificatesApi

endpointCertificatesApi

public EndpointCertificatesApi endpointCertificatesApi

graphQlSchemaApi

public GraphQlSchemaApi graphQlSchemaApi

graphQlSchemaIndividualApi

public GraphQlSchemaIndividualApi graphQlSchemaIndividualApi

apiLifecycleApi

public ApiLifecycleApi apiLifecycleApi

rolesApi

public RolesApi rolesApi

validationApi

public ValidationApi validationApi

subscriptionsApi

public SubscriptionsApi subscriptionsApi

apiAuditApi

public ApiAuditApi apiAuditApi

unifiedSearchApi

public UnifiedSearchApi unifiedSearchApi

apiPublisherClient

public ApiClient apiPublisherClient

appName

public static final String appName

See Also:

Constant Field Values

callBackURL

public static final String callBackURL

See Also:

Constant Field Values

tokenScope

public static final String tokenScope

See Also:

Constant Field Values

appOwner

public static final String appOwner

See Also:

Constant Field Values

grantType

public static final String grantType

See Also:

Constant Field Values

username

public static final String username

See Also:

Constant Field Values

password

public static final String password

See Also:

Constant Field Values

tenantDomain

public String tenantDomain

Constructor Detail

RestAPIPublisherImpl

@Deprecated
public RestAPIPublisherImpl()

Deprecated.

RestAPIPublisherImpl

public RestAPIPublisherImpl(String username,
                            String password,
                            String tenantDomain,
                            String publisherURL)

Method Detail

addAPI

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse addAPI(APIRequest apiRequest)
                                                                      throws ApiException

\ This method is used to create an API.

Parameters:

apiRequest -

Returns:

HttpResponse

Throws:

ApiException - throws of an error occurred when creating the API.

addAPI

public APIDTO addAPI(APIRequest apiRequest,
                     String osVersion)
              throws ApiException

\ This method is used to create an API.

Parameters:

apiRequest -

Returns:

HttpResponse

Throws:

ApiException - throws of an error occurred when creating the API.

addAPI

public APIDTO addAPI(APIDTO apidto,
                     String osVersion)
              throws ApiException

Throws:

ApiException

createNewAPIVersion

public String createNewAPIVersion(String newVersion,
                                  String apiId,
                                  boolean defaultVersion)
                           throws ApiException

This method is used to create a new API of the existing API.

Parameters:

newVersion - new API version

apiId - old API ID

defaultVersion - is this the

Returns:

apiID of the newly created api version.

Throws:

ApiException - Throws if an error occurs when creating the new API version.

changeAPILifeCycleStatus

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse changeAPILifeCycleStatus(String apiId,
                                                                                               String action,
                                                                                               String lifecycleChecklist)
                                                                                        throws ApiException

This method is used to publish the created API.

Parameters:

action - API id that need to published.

apiId - API id that need to published. return ApiResponse change response.

Throws:

ApiException - throws if an error occurred when publishing the API.

changeAPILifeCycleStatus

public WorkflowResponseDTO changeAPILifeCycleStatus(String apiId,
                                                    String action)
                                             throws ApiException

Throws:

ApiException

deprecateAPI

public void deprecateAPI(String apiId)
                  throws ApiException

This method is used to deprecate the created API.

Parameters:

apiId - API id that need to published.

Throws:

ApiException - throws if an error occurred when publishing the API.

deployPrototypeAPI

public void deployPrototypeAPI(String apiId)
                        throws ApiException

This method is used to deploy the api as a prototype.

Parameters:

apiId - API id that need to be prototyped.

Throws:

ApiException - throws if an error occurred when publishing the API.

blockAPI

public void blockAPI(String apiId)
              throws ApiException

This method is used to block the created API.

Parameters:

apiId - API id that need to published.

Throws:

ApiException - throws if an error occurred when publishing the API.

getLifecycleStatus

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

Throws:

ApiException

getLifecycleStatusDTO

public LifecycleStateDTO getLifecycleStatusDTO(String apiId)
                                        throws ApiException

Throws:

ApiException

getLifecycleHistory

public LifecycleHistoryDTO getLifecycleHistory(String apiId)
                                        throws ApiException

Throws:

ApiException

copyAPI

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse copyAPI(String newVersion,
                                                                              String apiId,
                                                                              Boolean isDefault)
                                                                       throws ApiException

copy API from existing API

Parameters:

newVersion - - new version of the API

apiId - - existing API Id

isDefault - - make the default version

Returns:

- http response object

Throws:

APIManagerIntegrationTestException - - Throws if error occurred at API copy operation

ApiException

copyAPIWithReturnDTO

public APIDTO copyAPIWithReturnDTO(String newVersion,
                                   String apiId,
                                   Boolean isDefault)
                            throws ApiException

Parameters:

newVersion -

apiId -

isDefault -

Returns:

Throws:

ApiException

updateAPI

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateAPI(APIRequest apiRequest,
                                                                                String apiId)
                                                                         throws ApiException

Facilitate update API

Parameters:

apiRequest - - constructed API request object

Returns:

http response object

Throws:

APIManagerIntegrationTestException - - throws if update API fails

ApiException

updateAPI

public APIDTO updateAPI(APIDTO apidto,
                        String apiId)
                 throws ApiException

Throws:

ApiException

getAPI

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

Method to get API information

Parameters:

apiId - - API id

Returns:

http response object

Throws:

ApiException - - Throws if api information cannot be retrieved.

deleteAPI

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

delete API

Parameters:

apiId - - API id

Returns:

http response object

Throws:

ApiException - - Throws if API delete fails

deleteAPIByID

public void deleteAPIByID(String apiId)
                   throws ApiException

Parameters:

apiId -

Throws:

ApiException

removeDocumentation

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

Remove document

Parameters:

apiId - - API id

docId - - document id

Returns:

http response object

Throws:

ApiException - - Throws if remove API document fails

revokeAccessToken

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse revokeAccessToken(String accessToken,
                                                                                        String consumerKey,
                                                                                        String authUser)
                                                                                 throws APIManagerIntegrationTestException

revoke access token

Parameters:

accessToken - - access token already received

consumerKey - - consumer key returned

authUser - - user name

Returns:

http response object

Throws:

APIManagerIntegrationTestException - - throws if access token revoke fails

updatePermissions

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updatePermissions(String tierName,
                                                                                        String permissionType,
                                                                                        String roles)
                                                                                 throws APIManagerIntegrationTestException

update permissions to API access

Parameters:

tierName - - name of api throttling tier

permissionType - - permission type

roles - - roles of permission

Returns:

http response object

Throws:

APIManagerIntegrationTestException - - throws if permission update fails

updateResourceOfAPI

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateResourceOfAPI(String apiId,
                                                                                          String api)
                                                                                   throws APIManagerIntegrationTestException

Update resources of API

Parameters:

apiId - - API Id

Returns:

http response object

Throws:

APIManagerIntegrationTestException - - throws if API resource update fails

checkValidEndpoint

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse checkValidEndpoint(String endpointUrl,
                                                                                         String apiId)
                                                                                  throws APIManagerIntegrationTestException,
                                                                                         ApiException

Check whether the Endpoint is valid

Parameters:

endpointUrl - url of the endpoint

apiId - id of the api which the endpoint to be validated

Returns:

HttpResponse - Response of the getAPI request

Throws:

APIManagerIntegrationTestException - - Check for valid endpoint fails.

ApiException

changeAPILifeCycleStatusToPublish

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse changeAPILifeCycleStatusToPublish(String apiId,
                                                                                                        boolean isRequireReSubscription)
                                                                                                 throws ApiException

Change the API Lifecycle status to Publish with the option of Re-subscription is required or not

Parameters:

apiId - - API ID

isRequireReSubscription - - true if Re-subscription is required else false.

Returns:

HttpResponse - Response of the API publish event

Throws:

APIManagerIntegrationTestException - - Exception Throws in checkAuthentication() and when do the REST service calls to do the lifecycle change.

ApiException

getTierPermissionsPage

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

Retrieve the Tier Permission Page

Returns:

HttpResponse - Response that contains the Tier Permission Page

Throws:

APIManagerIntegrationTestException - - Exception throws from checkAuthentication() method and HTTPSClientUtils.doGet() method call

addDocument

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse addDocument(String apiId,
                                                                                  DocumentDTO body)
                                                                           throws ApiException

Adding a documentation

Parameters:

apiId - - Id of the API.

body - - document Body.

Returns:

HttpResponse - Response with Document adding result.

Throws:

ApiException - - Exception throws if error occurred when adding document.

addContentDocument

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse addContentDocument(String apiId,
                                                                                         String docId,
                                                                                         String docContent)
                                                                                  throws ApiException

Adding a content to the document

Parameters:

apiId - - Id of the API.

docId - - document Id.

docContent - - document content

Returns:

HttpResponse - Response with Document adding result.

Throws:

ApiException - - Exception throws if error occurred when adding document.

updateContentDocument

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateContentDocument(String apiId,
                                                                                            String docId,
                                                                                            File docContent)
                                                                                     throws ApiException

Updating the document content using file

Parameters:

apiId - - Id of the API.

docId - - document Id.

docContent - - file content

Returns:

HttpResponse - Response with Document adding result.

Throws:

ApiException - - Exception throws if error occurred when adding document.

updateDocument

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse updateDocument(String apiId,
                                                                                     String docId,
                                                                                     DocumentDTO documentDTO)
                                                                              throws ApiException

Update API document.

Parameters:

apiId - api Id

docId - document Id

documentDTO - documentation object.

Returns:

Throws:

ApiException - Exception throws if error occurred when updating document.

getDocuments

public DocumentListDTO getDocuments(String apiId)
                             throws ApiException

This method is used to get documents Get Documents for the given limit and offset values

Parameters:

apiId - apiId

Returns:

Documents for the given limit and offset values

Throws:

ApiException

getDocumentContent

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

This method is used to get the content of API documents

Parameters:

apiId - UUID of the API

documentId - UUID of the API document

Returns:

Throws:

ApiException

deleteDocument

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

delete Document

Parameters:

apiId - - API id

documentId - - API id

Returns:

http response object

Throws:

ApiException - - Throws if API delete fails

getAllAPIs

public APIListDTO getAllAPIs()
                      throws APIManagerIntegrationTestException,
                             ApiException

Retrieve the All APIs available for the user in Publisher.

Returns:

HttpResponse - Response that contains all available APIs for the user

Throws:

APIManagerIntegrationTestException - - Exception throws from checkAuthentication() method and HTTPSClientUtils.doGet() method call

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

getAPIs

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

This method is used to upload endpoint certificates 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

uploadEndpointCertificate

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse uploadEndpointCertificate(File certificate,
                                                                                                String alias,
                                                                                                String endpoint)
                                                                                         throws ApiException

This method is used to upload certificates

Parameters:

certificate - certificate

alias - alis

endpoint - endpoint.

Returns:

Throws:

ApiException - if an error occurred while uploading the certificate.

getTiers

public ThrottlingPolicyListDTO getTiers(String policyLevel)
                                 throws ApiException

This method is used to get all throttling tiers.

Parameters:

- - API or resource

Returns:

- Response that contains all the available tiers

Throws:

ApiException

validateRoles

public ApiResponse<Void> validateRoles(String roleId)
                                throws ApiException

This method is used to validate roles.

Parameters:

roleId - role Id

Returns:

HttpResponse

Throws:

APIManagerIntegrationTestException

ApiException

getSwaggerByID

public String getSwaggerByID(String apiId)
                      throws ApiException

Throws:

ApiException

updateSwagger

public String updateSwagger(String apiId,
                            String definition)
                     throws ApiException

Throws:

ApiException

validateOASDefinition

public OpenAPIDefinitionValidationResponseDTO validateOASDefinition(File oasDefinition)
                                                             throws ApiException

Throws:

ApiException

getAPIByID

public APIDTO getAPIByID(String apiId,
                         String tenantDomain)
                  throws ApiException

Throws:

ApiException

importOASDefinition

public APIDTO importOASDefinition(File file,
                                  String properties)
                           throws ApiException

Throws:

ApiException

validateGraphqlSchemaDefinition

public GraphQLValidationResponseDTO validateGraphqlSchemaDefinition(File schemaDefinition)
                                                             throws ApiException

Throws:

ApiException

importGraphqlSchemaDefinition

public APIDTO importGraphqlSchemaDefinition(File file,
                                            String properties)
                                     throws ApiException

Throws:

ApiException

getGraphqlSchemaDefinition

public GraphQLSchemaDTO getGraphqlSchemaDefinition(String apiId)
                                            throws ApiException

Throws:

ApiException

updateGraphqlSchemaDefinition

public void updateGraphqlSchemaDefinition(String apiId,
                                          String schemaDefinition)
                                   throws ApiException

Throws:

ApiException

addAPI

public APIDTO addAPI(APICreationRequestBean apiCreationRequestBean)
              throws ApiException

Throws:

ApiException

uploadCertificate

public org.wso2.carbon.automation.test.utils.http.client.HttpResponse uploadCertificate(File certificate,
                                                                                        String alias,
                                                                                        String apiId,
                                                                                        String tier)
                                                                                 throws ApiException

This method is used to upload certificates

Parameters:

certificate - certificate

alias - alis

Returns:

Throws:

ApiException - if an error occurred while uploading the certificate.

updateAPI

public APIDTO updateAPI(APIDTO apidto)
                 throws ApiException

Update an API

Parameters:

apidto -

Returns:

Throws:

ApiException

getSubscriptionByAPIID

public SubscriptionListDTO getSubscriptionByAPIID(String apiID)
                                           throws ApiException

Get subscription of an API

Parameters:

apiID -

Returns:

Throws:

ApiException

getAllApiProducts

public APIProductListDTO getAllApiProducts()
                                    throws ApiException

Throws:

ApiException

getApiProduct

public APIProductDTO getApiProduct(String apiProductId)
                            throws ApiException

Throws:

ApiException

addApiProduct

public APIProductDTO addApiProduct(APIProductDTO apiProductDTO)
                            throws ApiException

Throws:

ApiException

deleteApiProduct

public void deleteApiProduct(String apiProductId)
                      throws ApiException

Throws:

ApiException

getAuditApi

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

Method to retrieve the Audit Report of an API

Parameters:

apiId - apiId of the API

Returns:

HttpResponse response

Throws:

ApiException