org.wso2.carbon.apimgt.samples.utils

Class SampleUtils

java.lang.Object

org.wso2.carbon.apimgt.samples.utils.SampleUtils

public class SampleUtils
extends Object

This util class performs the actions related to API objects.

Constructor Summary

Constructors

Constructor and Description
SampleUtils()

Method Summary

Modifier and Type	Method and Description
static void	blockAPI(String apiId) This method is used to block the created API.
static String	createApi(String apiName, String version, String context, ArrayList<String> visibleRoles, ArrayList<String> visibleTenants, API.SubscriptionAvailabilityEnum subscriptionAvailabilityEnum, String hostname, String port, ArrayList<String> tags) This method is used to create an API.
static String	createApiForTenant(String apiName, String version, String context, API.VisibilityEnum visibilityEnum, ArrayList<String> visibleRoles, ArrayList<String> visibleTenants, API.SubscriptionAvailabilityEnum subscriptionAvailabilityEnum, String hostname, String port, ArrayList<String> tags, String tenantDomain, String adminUsername, String adminPassword) This method is used to create an API for a tenant.
static String	createApplication(String appName, String description, String throttleTier)
static String	createNewAPIVersion(String newVersion, String apiId) This method is used to create a new API of the existing API.
static String	createSubscription(String apiId, String applicationId, String subscriptionTier, Subscription.StatusEnum statusEnum)
static void	deprecateAPI(String apiId) This method is used to deprecate the created API.
static ApplicationKey	generateKeys(String applicationId, String validityTime, String callBackUrl, ApplicationKeyGenerateRequest.KeyTypeEnum keyTypeEnum, ArrayList<String> scopes, ArrayList<String> allowDomains, ArrayList<String> grantTypes)
static void	publishAPI(String apiId) This method is used to publish the created API.
static void	publishAPI(String apiId, String tenantDomain, String adminUsername, String adminPassword) This methos id used to publish the created API for tenants.
static void	rejectAPI(String apiId) This method is used to reject the created API.

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleUtils

public SampleUtils()

Method Detail

createApi

public static String createApi(String apiName,
                               String version,
                               String context,
                               ArrayList<String> visibleRoles,
                               ArrayList<String> visibleTenants,
                               API.SubscriptionAvailabilityEnum subscriptionAvailabilityEnum,
                               String hostname,
                               String port,
                               ArrayList<String> tags)
                        throws ApiException

This method is used to create an API.

Parameters:

apiName - API name.

version - API version.

context - API context.

visibleRoles - visible roles of the API.

visibleTenants - visible tenants of the API.

subscriptionAvailabilityEnum - subscription visible tenants if the API.

hostname - host name of the API Manager instance that needs to create the API.

port - port of the API Manager instance that need to create the API.

tags - tags that need to be added to the API.

Returns:

Id of the created API.

Throws:

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

createApiForTenant

public static String createApiForTenant(String apiName,
                                        String version,
                                        String context,
                                        API.VisibilityEnum visibilityEnum,
                                        ArrayList<String> visibleRoles,
                                        ArrayList<String> visibleTenants,
                                        API.SubscriptionAvailabilityEnum subscriptionAvailabilityEnum,
                                        String hostname,
                                        String port,
                                        ArrayList<String> tags,
                                        String tenantDomain,
                                        String adminUsername,
                                        String adminPassword)
                                 throws ApiException

This method is used to create an API for a tenant.

Parameters:

apiName - API name.

version - API version.

context - API context.

visibleRoles - visible roles of the API.

visibleTenants - visible tenants of the API.

subscriptionAvailabilityEnum - subscription visible tenants if the API.

hostname - host name of the API Manager instance that needs to create the API.

port - port of the API Manager instance that need to create the API.

tags - tags that need to be added to the API.

tenantDomain - tenant domain name

adminUsername - tenant admin username

adminPassword - tenant admin password

Returns:

Id of the created API.

Throws:

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

createNewAPIVersion

public static String createNewAPIVersion(String newVersion,
                                         String apiId)
                                  throws ApiException

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

Parameters:

newVersion - new API version

apiId - old API ID

Returns:

apiID of the newly created api version.

Throws:

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

publishAPI

public static void publishAPI(String apiId)
                       throws ApiException

This method is used to publish the created API.

Parameters:

apiId - API id that need to published.

Throws:

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

deprecateAPI

public static 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.

blockAPI

public static 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.

rejectAPI

public static void rejectAPI(String apiId)
                      throws ApiException

This method is used to reject the created API.

Parameters:

apiId - API id that need to published.

Throws:

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

publishAPI

public static void publishAPI(String apiId,
                              String tenantDomain,
                              String adminUsername,
                              String adminPassword)
                       throws ApiException

This methos id used to publish the created API for tenants.

Parameters:

apiId - API id that need to published.

Throws:

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

createApplication

public static String createApplication(String appName,
                                       String description,
                                       String throttleTier)

createSubscription

public static String createSubscription(String apiId,
                                        String applicationId,
                                        String subscriptionTier,
                                        Subscription.StatusEnum statusEnum)
                                 throws ApiException

Throws:

ApiException

generateKeys

public static ApplicationKey generateKeys(String applicationId,
                                          String validityTime,
                                          String callBackUrl,
                                          ApplicationKeyGenerateRequest.KeyTypeEnum keyTypeEnum,
                                          ArrayList<String> scopes,
                                          ArrayList<String> allowDomains,
                                          ArrayList<String> grantTypes)
                                   throws ApiException

Throws:

ApiException