org.wso2.carbon.apimgt.importexport.utils

Class APIImportUtil

java.lang.Object

org.wso2.carbon.apimgt.importexport.utils.APIImportUtil

public final class APIImportUtil
extends Object

This class provides the functions utilized to import an API from an API archive.

Constructor Summary

Constructors

Constructor and Description
APIImportUtil()

Method Summary

Modifier and Type	Method and Description
static String	extractArchive(File sourceFile, String destination) This method decompresses API the archive
static void	importAPI(String pathToArchive, String currentUser, boolean isDefaultProviderAllowed) This method imports an API
static void	initializeProvider(String currentUserName) This method initializes the Provider when there is a direct request to import an API
static void	transferFile(InputStream uploadedInputStream, String newFileName, String storageLocation) This method uploads a given file to specified location

Methods inherited from class java.lang.Object

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

Constructor Detail

APIImportUtil

public APIImportUtil()

Method Detail

initializeProvider

public static void initializeProvider(String currentUserName)
                               throws APIExportException

This method initializes the Provider when there is a direct request to import an API

Parameters:

currentUserName - the current logged in user

Throws:

APIExportException - if provider cannot be initialized

transferFile

public static void transferFile(InputStream uploadedInputStream,
                                String newFileName,
                                String storageLocation)
                         throws APIImportException

This method uploads a given file to specified location

Parameters:

uploadedInputStream - input stream of the file

newFileName - name of the file to be created

storageLocation - destination of the new file

Throws:

APIImportException - if the file transfer fails

extractArchive

public static String extractArchive(File sourceFile,
                                    String destination)
                             throws APIImportException

This method decompresses API the archive

Parameters:

sourceFile - The archive containing the API

destination - location of the archive to be extracted

Returns:

Name of the extracted directory

Throws:

APIImportException - If the decompressing fails

importAPI

public static void importAPI(String pathToArchive,
                             String currentUser,
                             boolean isDefaultProviderAllowed)
                      throws APIImportException

This method imports an API

Parameters:

pathToArchive - location of the extracted folder of the API

currentUser - the current logged in user

isDefaultProviderAllowed - decision to keep or replace the provider

Throws:

APIImportException - if there is an error in importing an API