com.axway.apim.apiimport

Class APIImportConfigAdapter

java.lang.Object

com.axway.apim.apiimport.APIImportConfigAdapter

public class APIImportConfigAdapter
extends Object

The APIConfig reflects the given API-Configuration plus the API-Definition, which is either a Swagger-File or a WSDL. This class will read the API-Configuration plus the optional set stage and the API-Definition.

Author:

cwiechmann

Constructor Summary

Constructors

Constructor and Description
APIImportConfigAdapter(API apiConfig, String apiConfigFile) Constructor just for testing.
APIImportConfigAdapter(String apiConfigFile, String stage, String pathToAPIDefinition, boolean usingOrgAdmin) Constructs the APIImportConfig

Method Summary

Modifier and Type	Method and Description
API	getApiConfig()
InputStream	getAPIDefinitionAsStream() To make testing easier we allow reading test-files from classpath as well
API	getDesiredAPI() Returns the IAPIDefintion that returns the desired state of the API.
String	getPathToAPIDefinition()
static boolean	isHttpsUri(String uri)
static boolean	isHttpUri(String pathToAPIDefinition)
void	setPathToAPIDefinition(String pathToAPIDefinition)

Methods inherited from class java.lang.Object

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

Constructor Detail

APIImportConfigAdapter

public APIImportConfigAdapter(API apiConfig,
                              String apiConfigFile)
                       throws AppException

Constructor just for testing. Don't use it!

Parameters:

apiConfig - the desired API to test with

apiConfigFile - this is the given config file

Throws:

AppException

APIImportConfigAdapter

public APIImportConfigAdapter(String apiConfigFile,
                              String stage,
                              String pathToAPIDefinition,
                              boolean usingOrgAdmin)
                       throws AppException

Constructs the APIImportConfig

Parameters:

apiConfigFile - the API-Config given by the user

stage - an optional stage used to load overrides and stage specific environment properties

pathToAPIDefinition - an optional path to the API-Definition (Swagger / WSDL), can be in the config-file as well.

usingOrgAdmin - access to API-Manager should be limited to the Org-Admin account

Throws:

AppException - if the config-file can't be parsed for some reason

Method Detail

getApiConfig

public API getApiConfig()

getDesiredAPI

public API getDesiredAPI()
                  throws AppException

Returns the IAPIDefintion that returns the desired state of the API. In this method:
- the API-Config is read - the API-Config is merged with the override - the API-Definition is read - Additionally some validations and completions are made here - in the future: This is the place to do some default handling.

Returns:

IAPIDefintion with the desired state of the API. This state will be the input to create the APIChangeState.

Throws:

AppException - if the state can't be created.

getAPIDefinitionAsStream

public InputStream getAPIDefinitionAsStream()
                                     throws AppException

To make testing easier we allow reading test-files from classpath as well

Returns:

The import Swagger-File as an InputStream

Throws:

AppException - when the import Swagger-File can't be read.

isHttpUri

public static boolean isHttpUri(String pathToAPIDefinition)

isHttpsUri

public static boolean isHttpsUri(String uri)

getPathToAPIDefinition

public String getPathToAPIDefinition()

setPathToAPIDefinition

public void setPathToAPIDefinition(String pathToAPIDefinition)