GatewayCmdUtils (Micro Gateway Code Generator 3.0.2 API)

java.lang.Object
- org.wso2.apimgt.gateway.cli.utils.GatewayCmdUtils

public class GatewayCmdUtils
extends Object

Constructor Summary

Constructors
Constructor and Description

GatewayCmdUtils()

Constructors
Constructor and Description
`GatewayCmdUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`copyAndReplaceFolder(String source, String destination)` This function deletes the existing destination folder and recursively copy all the sub folder and files from source to destination file paths.
`static void`	`copyFilesToSources(String sourcePath, String destinationPath)` Copy files to resources directory
`static void`	`copyFolder(String source, String destination)` This function recursively copy all the sub folder and files from source to destination file paths
`static void`	`createDeploymentConfig(String projectName, String deploymentConfPath)` Create initial deployment configuration file.
`static File`	`createDirectory(String path, boolean overwrite)` Creates a new folder if not exists
`static File`	`createFile(String path, String fileName, boolean overwrite)` Create new file in a given location.
`static void`	`createGenDirectoryStructure(String genDirPath)` Create directory structure for projects /gen directory.
`static void`	`createProjectStructure(String projectName)` Create a project structure for a particular project name.
`static CliLauncherException`	`createUsageException(String errorMsg)` Create usage exception
`static String`	`decrypt(String value, String secret)` Decrypt given value with provided secret
`static void`	`deleteProject(String projectPath)` Delete project folder
`static String`	`encrypt(String value, String secret)` Encrypt given value with provided secret
`static String`	`getCLIHome()` Get cli home location
`static String`	`getCLILibPath()` Get cli library location
`static CodeGenerationContext`	`getCodeGenerationContext()`
`static Config`	`getConfig()`
`static ContainerConfig`	`getContainerConfig()`
`static APICorsConfigurationDTO`	`getDefaultCorsConfig()`
`static String`	`getDefinitionsLocation()` Get filters folder location
`static String`	`getDeploymentConfigLocation(String projectName)` Returns location of the deployment configuration file of given project
`static String`	`getFiltersFolderLocation()` Get filters folder location
`static String`	`getLoggingPropertiesFileLocation()` Get resources file directory path
`static String`	`getMainConfigLocation()` Returns location of the main configuration file of given project root
`static String`	`getProjectAPIFilesDirectoryPath(String projectName)` Returns path to the /API-Files of a given project in the current working directory
`static String`	`getProjectDirectoryPath(String projectName)` Returns path to the given project in the current working directory
`static String`	`getProjectExtensionsDirectoryPath(String projectName)` Returns path to the /extensions of a given project in the current working directory
`static String`	`getProjectGenAPIDefinitionPath(String projectName)` Returns path to the /gen/api-definition of a given project in the current working directory
`static String`	`getProjectGenDirectoryPath(String projectName)` Returns path to the /gen of a given project in the current working directory
`static String`	`getProjectGenSrcDirectoryPath(String projectName)` Returns path to the /gen/src of a given project in the current working directory
`static String`	`getProjectGenSrcInterceptorsDirectoryPath(String projectName)` Returns path to the /gen/src/interceptors of a given project in the current working directory
`static String`	`getProjectGenSwaggerPath(String projectName, String apiId)` Returns path to the /gen/api-definition of a given project in the current working directory
`static String`	`getProjectGenSwaggerPath(String projectName, String apiId, String extensionType)` Returns path to the /gen/api-definition of a given project in the current working directory
`static String`	`getProjectGrpcDirectoryPath()` Returns path to the /grpc_service/client of a given project in the current working directory
`static String`	`getProjectGrpcSoloDirectoryPath()` Returns path to the /grpc_service of a given project in the current working directory
`static String`	`getProjectInterceptorsDirectoryPath(String projectName)` Returns path to the /interceptors of a given project in the current working directory
`static String`	`getProjectSwaggerFilePath(String projectName, String apiId)` Returns the path to the swagger for a defined version of an API
`static String`	`getProjectTargetGenDirectoryPath(String projectName)` Returns path to the /target/gen of a given project in the current working directory
`static String`	`getResourceFolderLocation()` Get resources file directory path
`static String`	`getUnixPath(String path)` Replace backslashes `\` in windows path string with forward slashes `/`
`static String`	`getUserDir()` Returns current user dir
`static String`	`loadStoredResourceHashes(String projectName)` Load the stored resource hash content from the CLI temp folder
`static void`	`printVerbose(String msg)` To print the message if verbose flag is set
`static String`	`promptForTextInput(PrintStream outStream, String msg)` Prompts for a test input.
`static String`	`readFileAsString(String path, boolean inResource)` Read file as string
`static void`	`saveConfig(Config config, String configPath)`
`static void`	`saveSwaggerDefinition(String projectName, String apiDefinition, String apiId, String extension)` Save openAPI definition (developer first approach)
`static void`	`saveSwaggerDefinitionForMultipleAPIs(String projectName, List<ExtendedAPI> apis)` Save swagger definition for multiple APIs.
`static void`	`setCodeGenerationContext(CodeGenerationContext codeGenerationContext)`
`static void`	`setConfig(Config configFromFile)`
`static void`	`setContainerConfig(ContainerConfig containerConfig)`
`static void`	`storeResourceHashesFileContent(String content, String projectName)` Saves the resource hash content to the CLI temp folder
`static void`	`writeContent(String content, File file)` Write content to a specified file

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GatewayCmdUtils
```
public GatewayCmdUtils()
```
- Method Detail
  - getConfig
```
public static Config getConfig()
```
  - setConfig
```
public static void setConfig(Config configFromFile)
```
  - getCodeGenerationContext
```
public static CodeGenerationContext getCodeGenerationContext()
```
  - setCodeGenerationContext
```
public static void setCodeGenerationContext(CodeGenerationContext codeGenerationContext)
```
  - readFileAsString
```
public static String readFileAsString(String path,
                                      boolean inResource)
                               throws IOException
```
    Read file as string
    
    Parameters:
    
    path - to the file
    
    inResource - whether file is in resources directory of jar or not
    
    Returns:
    
    file content
    
    Throws:
    
    IOException - if file read went wrong
  - createUsageException
```
public static CliLauncherException createUsageException(String errorMsg)
```
    Create usage exception
    
    Parameters:
    
    errorMsg - error message
    
    Returns:
    
    created usage exception
  - encrypt
```
public static String encrypt(String value,
                             String secret)
```
    Encrypt given value with provided secret
    
    Parameters:
    
    value - value to encrypt
    
    secret - encryption key
    
    Returns:
    
    encrypted value
  - decrypt
```
public static String decrypt(String value,
                             String secret)
```
    Decrypt given value with provided secret
    
    Parameters:
    
    value - value to decrypt
    
    secret - decryption key
    
    Returns:
    
    decrypted value
  - getUserDir
```
public static String getUserDir()
```
    Returns current user dir
    
    Returns:
    
    current user dir
  - getCLIHome
```
public static String getCLIHome()
```
    Get cli home location
    
    Returns:
    
    cli home location
  - getCLILibPath
```
public static String getCLILibPath()
```
    Get cli library location
    
    Returns:
    
    cli lib location
  - getResourceFolderLocation
```
public static String getResourceFolderLocation()
```
    Get resources file directory path
    
    Returns:
    
    resources file directory path
  - getLoggingPropertiesFileLocation
```
public static String getLoggingPropertiesFileLocation()
```
    Get resources file directory path
    
    Returns:
    
    resources file directory path
  - getDefinitionsLocation
```
public static String getDefinitionsLocation()
```
    Get filters folder location
    
    Returns:
    
    filters folder location
  - getFiltersFolderLocation
```
public static String getFiltersFolderLocation()
```
    Get filters folder location
    
    Returns:
    
    filters folder location
  - createProjectStructure
```
public static void createProjectStructure(String projectName)
                                   throws IOException
```
    Create a project structure for a particular project name.
    
    Parameters:
    
    projectName - name of the project
    
    Throws:
    
    IOException
  - saveSwaggerDefinition
```
public static void saveSwaggerDefinition(String projectName,
                                         String apiDefinition,
                                         String apiId,
                                         String extension)
```
    Save openAPI definition (developer first approach)
    
    Parameters:
    
    projectName - project name
    
    apiDefinition - api Definition as String
  - saveSwaggerDefinitionForMultipleAPIs
```
public static void saveSwaggerDefinitionForMultipleAPIs(String projectName,
                                                        List<ExtendedAPI> apis)
```
    Save swagger definition for multiple APIs.
    
    Parameters:
    
    projectName - project name
    
    apis - API object List
  - loadStoredResourceHashes
```
public static String loadStoredResourceHashes(String projectName)
                                       throws IOException
```
    Load the stored resource hash content from the CLI temp folder
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    stored resource hash content from the CLI temp folder
    
    Throws:
    
    IOException - error while loading stored resource hash content
  - storeResourceHashesFileContent
```
public static void storeResourceHashesFileContent(String content,
                                                  String projectName)
                                           throws IOException
```
    Saves the resource hash content to the CLI temp folder
    
    Parameters:
    
    content - resource hash content
    
    projectName - name of the project
    
    Throws:
    
    IOException - error while saving resource hash content
  - getMainConfigLocation
```
public static String getMainConfigLocation()
```
    Returns location of the main configuration file of given project root
    
    Returns:
    
    path configuration file
  - getDeploymentConfigLocation
```
public static String getDeploymentConfigLocation(String projectName)
```
    Returns location of the deployment configuration file of given project
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to deployment configuration file
  - getProjectDirectoryPath
```
public static String getProjectDirectoryPath(String projectName)
```
    Returns path to the given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the given project in the current working directory
  - getProjectGenDirectoryPath
```
public static String getProjectGenDirectoryPath(String projectName)
```
    Returns path to the /gen of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the /src of a given project in the current working directory
  - getProjectTargetGenDirectoryPath
```
public static String getProjectTargetGenDirectoryPath(String projectName)
```
    Returns path to the /target/gen of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the /src of a given project in the current working directory
  - getProjectGenSrcDirectoryPath
```
public static String getProjectGenSrcDirectoryPath(String projectName)
```
    Returns path to the /gen/src of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the /src of a given project in the current working directory
  - getProjectExtensionsDirectoryPath
```
public static String getProjectExtensionsDirectoryPath(String projectName)
```
    Returns path to the /extensions of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the /extensions of a given project in the current working directory
  - getProjectInterceptorsDirectoryPath
```
public static String getProjectInterceptorsDirectoryPath(String projectName)
```
    Returns path to the /interceptors of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the /src of a given project in the current working directory
  - getProjectGenSrcInterceptorsDirectoryPath
```
public static String getProjectGenSrcInterceptorsDirectoryPath(String projectName)
```
    Returns path to the /gen/src/interceptors of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the /src of a given project in the current working directory
  - getProjectGenSwaggerPath
```
public static String getProjectGenSwaggerPath(String projectName,
                                              String apiId,
                                              String extensionType)
```
    Returns path to the /gen/api-definition of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    apiId - md5 hash value of apiName:apiVersion
    
    extensionType - The file extension type. (ex : yaml or json)
    
    Returns:
    
    path to the /gen/api-definition of a given project in the current working directory
  - getProjectGenSwaggerPath
```
public static String getProjectGenSwaggerPath(String projectName,
                                              String apiId)
```
    Returns path to the /gen/api-definition of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    apiId - md5 hash value of apiName:apiVersion * @return path to the /gen/api-definition of a given project in the current working directory
  - getProjectGenAPIDefinitionPath
```
public static String getProjectGenAPIDefinitionPath(String projectName)
```
    Returns path to the /gen/api-definition of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the /gen/api-definition of a given project in the current working directory
  - getProjectGrpcDirectoryPath
```
public static String getProjectGrpcDirectoryPath()
```
    Returns path to the /grpc_service/client of a given project in the current working directory
    
    Returns:
    
    path to the /grpc_service/client of a given project in the current working directory
  - getProjectGrpcSoloDirectoryPath
```
public static String getProjectGrpcSoloDirectoryPath()
```
    Returns path to the /grpc_service of a given project in the current working directory
    
    Returns:
    
    path to the /grpc_service of a given project in the current working directory
  - copyFolder
```
public static void copyFolder(String source,
                              String destination)
                       throws IOException
```
    This function recursively copy all the sub folder and files from source to destination file paths
    
    Parameters:
    
    source - source location
    
    destination - destination location
    
    Throws:
    
    IOException - error while copying folder to destination
  - copyAndReplaceFolder
```
public static void copyAndReplaceFolder(String source,
                                        String destination)
                                 throws IOException
```
    This function deletes the existing destination folder and recursively copy all the sub folder and files from source to destination file paths.
    
    Parameters:
    
    source - source location
    
    destination - destination location
    
    Throws:
    
    IOException - error while copying folder to destination
  - copyFilesToSources
```
public static void copyFilesToSources(String sourcePath,
                                      String destinationPath)
                               throws IOException
```
    Copy files to resources directory
    
    Parameters:
    
    sourcePath - source directory path
    
    destinationPath - destionation directory path
    
    Throws:
    
    IOException - if file copy went wrong
  - createDirectory
```
public static File createDirectory(String path,
                                   boolean overwrite)
                            throws IOException
```
    Creates a new folder if not exists
    
    Parameters:
    
    path - folder path
    
    overwrite - if `true` existing directory will be removed and new directory will be created in path.
    
    Returns:
    
    created directory
    
    Throws:
    
    IOException - Failed delete or create the directory in path
  - createFile
```
public static File createFile(String path,
                              String fileName,
                              boolean overwrite)
                       throws IOException
```
    Create new file in a given location.
    
    Parameters:
    
    path - location of the new file.
    
    overwrite - if `true` existing file with the same name will be replaced.
    
    fileName - name of the new file.
    
    Returns:
    
    created file
    
    Throws:
    
    IOException - Failed delete or create the file in path
  - writeContent
```
public static void writeContent(String content,
                                File file)
                         throws IOException
```
    Write content to a specified file
    
    Parameters:
    
    content - content to be written
    
    file - file object initialized with path
    
    Throws:
    
    IOException - error while writing content to file
  - createDeploymentConfig
```
public static void createDeploymentConfig(String projectName,
                                          String deploymentConfPath)
                                   throws IOException
```
    Create initial deployment configuration file. If external file is provided using 'deploymentConfPath', it will be taken as the deployment configuration. Otherwise, a default configuration will be copied.
    
    Parameters:
    
    projectName - project name
    
    deploymentConfPath - path to deployment config
    
    Throws:
    
    IOException - if file create went wrong
  - getContainerConfig
```
public static ContainerConfig getContainerConfig()
```
  - setContainerConfig
```
public static void setContainerConfig(ContainerConfig containerConfig)
```
  - saveConfig
```
public static void saveConfig(Config config,
                              String configPath)
```
  - getDefaultCorsConfig
```
public static APICorsConfigurationDTO getDefaultCorsConfig()
```
  - getUnixPath
```
public static String getUnixPath(String path)
```
    Replace backslashes `\` in windows path string with forward slashes `/`
    
    Parameters:
    
    path - Location of a resource (file or directory)
    
    Returns:
    
    {String} File path with unix style file separator
  - deleteProject
```
public static void deleteProject(String projectPath)
```
    Delete project folder
    
    Parameters:
    
    projectPath - project path
  - promptForTextInput
```
public static String promptForTextInput(PrintStream outStream,
                                        String msg)
```
    Prompts for a test input.
    
    Parameters:
    
    outStream - Print Stream
    
    msg - message
    
    Returns:
    
    user entered text
  - createGenDirectoryStructure
```
public static void createGenDirectoryStructure(String genDirPath)
                                        throws IOException
```
    Create directory structure for projects /gen directory.
    
    Parameters:
    
    genDirPath - path to project's /gen directory
    
    Throws:
    
    IOException
  - getProjectAPIFilesDirectoryPath
```
public static String getProjectAPIFilesDirectoryPath(String projectName)
```
    Returns path to the /API-Files of a given project in the current working directory
    
    Parameters:
    
    projectName - name of the project
    
    Returns:
    
    path to the /API-Files of a given project in the current working directory
  - getProjectSwaggerFilePath
```
public static String getProjectSwaggerFilePath(String projectName,
                                               String apiId)
```
    Returns the path to the swagger for a defined version of an API
    
    Parameters:
    
    projectName - name of the project
    
    apiId - md5 hash value of apiName:apiVersion
    
    Returns:
    
    path to the swagger for a defined version of an API
  - printVerbose
```
public static void printVerbose(String msg)
```
    To print the message if verbose flag is set
    
    Parameters:
    
    msg - Message

Class GatewayCmdUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GatewayCmdUtils

Method Detail

getConfig

setConfig

getCodeGenerationContext

setCodeGenerationContext

readFileAsString

createUsageException

encrypt

decrypt

getUserDir

getCLIHome

getCLILibPath

getResourceFolderLocation

getLoggingPropertiesFileLocation

getDefinitionsLocation

getFiltersFolderLocation

createProjectStructure

saveSwaggerDefinition

saveSwaggerDefinitionForMultipleAPIs

loadStoredResourceHashes

storeResourceHashesFileContent

getMainConfigLocation

getDeploymentConfigLocation

getProjectDirectoryPath

getProjectGenDirectoryPath

getProjectTargetGenDirectoryPath

getProjectGenSrcDirectoryPath

getProjectExtensionsDirectoryPath

getProjectInterceptorsDirectoryPath

getProjectGenSrcInterceptorsDirectoryPath

getProjectGenSwaggerPath

getProjectGenSwaggerPath

getProjectGenAPIDefinitionPath

getProjectGrpcDirectoryPath

getProjectGrpcSoloDirectoryPath

copyFolder

copyAndReplaceFolder

copyFilesToSources

createDirectory

createFile

writeContent

createDeploymentConfig

getContainerConfig

setContainerConfig

saveConfig

getDefaultCorsConfig

getUnixPath

deleteProject

promptForTextInput

createGenDirectoryStructure

getProjectAPIFilesDirectoryPath

getProjectSwaggerFilePath

printVerbose