org.wso2.carbon.apimgt.importexport.utils

Class APIExportUtil

java.lang.Object

org.wso2.carbon.apimgt.importexport.utils.APIExportUtil

public class APIExportUtil
extends Object

This is the util class which consists of all the functions for exporting API

Method Summary

Modifier and Type	Method and Description
static void	createDirectory(String path) Create directory at the given path
static void	exportAPIDocumentation(List<org.wso2.carbon.apimgt.api.model.Documentation> docList, org.wso2.carbon.apimgt.api.model.APIIdentifier apiIdentifier, org.wso2.carbon.registry.api.Registry registry) Retrieve documentation for the exporting API and store it in the archive directory FILE, INLINE and URL documentations are handled
static void	exportSequences(org.wso2.carbon.apimgt.api.model.API api, org.wso2.carbon.apimgt.api.model.APIIdentifier apiIdentifier, org.wso2.carbon.registry.api.Registry registry) Retrieve available custom sequences and API specific sequences for API export
static void	exportWSDL(org.wso2.carbon.apimgt.api.model.APIIdentifier apiIdentifier, org.wso2.carbon.registry.api.Registry registry) Retrieve WSDL for the exporting API and store it in the archive directory
static org.wso2.carbon.apimgt.api.APIProvider	getProvider(String userName) Retrieve API provider
static org.wso2.carbon.registry.api.Registry	getRegistry() Retrieve registry for the current tenant
static javax.ws.rs.core.Response	retrieveApiToExport(org.wso2.carbon.apimgt.api.model.APIIdentifier apiID, String userName) This method retrieves all meta information and registry resources required for an API to recreate
static void	setArchiveBasePath(String path) Set base path where exporting archive should be generated

Methods inherited from class java.lang.Object

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

Method Detail

setArchiveBasePath

public static void setArchiveBasePath(String path)

Set base path where exporting archive should be generated

Parameters:

path - Temporary directory location

getProvider

public static org.wso2.carbon.apimgt.api.APIProvider getProvider(String userName)
                                                          throws APIExportException

Retrieve API provider

Parameters:

userName - User name

Returns:

APIProvider Provider of the supplied user name

Throws:

APIExportException - If an error occurs while retrieving the provider

getRegistry

public static org.wso2.carbon.registry.api.Registry getRegistry()

Retrieve registry for the current tenant

Returns:

Registry registry of the current tenant

retrieveApiToExport

public static javax.ws.rs.core.Response retrieveApiToExport(org.wso2.carbon.apimgt.api.model.APIIdentifier apiID,
                                                            String userName)
                                                     throws APIExportException

This method retrieves all meta information and registry resources required for an API to recreate

Parameters:

apiID - Identifier of the exporting API

userName - User name of the requester

Returns:

HttpResponse indicating whether resource retrieval got succeed or not

Throws:

APIExportException - If an error occurs while retrieving API related resources

exportAPIDocumentation

public static void exportAPIDocumentation(List<org.wso2.carbon.apimgt.api.model.Documentation> docList,
                                          org.wso2.carbon.apimgt.api.model.APIIdentifier apiIdentifier,
                                          org.wso2.carbon.registry.api.Registry registry)
                                   throws APIExportException

Retrieve documentation for the exporting API and store it in the archive directory FILE, INLINE and URL documentations are handled

Parameters:

apiIdentifier - ID of the requesting API

registry - Current tenant registry

docList - documentation list of the exporting API

Throws:

APIExportException - If an error occurs while retrieving documents from the registry or storing in the archive directory

exportWSDL

public static void exportWSDL(org.wso2.carbon.apimgt.api.model.APIIdentifier apiIdentifier,
                              org.wso2.carbon.registry.api.Registry registry)
                       throws APIExportException

Retrieve WSDL for the exporting API and store it in the archive directory

Parameters:

apiIdentifier - ID of the requesting API

registry - Current tenant registry

Throws:

APIExportException - If an error occurs while retrieving WSDL from the registry or storing in the archive directory

exportSequences

public static void exportSequences(org.wso2.carbon.apimgt.api.model.API api,
                                   org.wso2.carbon.apimgt.api.model.APIIdentifier apiIdentifier,
                                   org.wso2.carbon.registry.api.Registry registry)
                            throws APIExportException

Retrieve available custom sequences and API specific sequences for API export

Parameters:

api - exporting API

apiIdentifier - ID of the requesting API

registry - current tenant registry

Throws:

APIExportException - If an error occurs while exporting sequences

createDirectory

public static void createDirectory(String path)
                            throws APIExportException

Create directory at the given path

Parameters:

path - Path of the directory

Throws:

APIExportException - If directory creation failed