Package com.axway.apim.api.specification

Class APISpecification

java.lang.Object

com.axway.apim.api.specification.APISpecification

Direct Known Subclasses:

OAS3xSpecification, ODataSpecification, Swagger1xSpecification, Swagger2xSpecification, UnknownAPISpecification, WADLSpecification, WSDLSpecification

public abstract class APISpecification
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	APISpecification.APISpecType

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	apiSpecificationContent
protected String	apiSpecificationFile
protected APISpecificationFilter	filterConfig
protected com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor	Description
APISpecification()

Method Summary

Modifier and Type	Method	Description
boolean	compareJSON(APISpecification apiSpecification, APISpecification gatewayApiSpecification)
boolean	compareString(byte[] sourceSpec, byte[] gatewaySpec)
abstract void	configureBasePath(String backendBasePath, API api)
boolean	equals(Object other)
void	filterAPISpecification()
abstract APISpecification.APISpecType	getAPIDefinitionType()
abstract byte[]	getApiSpecificationContent()
String	getApiSpecificationFile()
abstract String	getDescription()
int	hashCode()
boolean	parse(byte[] apiSpecificationContent)
void	setApiSpecificationFile(String apiSpecificationFile)
APISpecification	setFilterConfig(APISpecificationFilter filterConfig)
protected void	setMapperForDataFormat()
abstract void	updateBasePath(String basePath, String host)

Methods inherited from class java.lang.Object

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

Field Detail

mapper

protected com.fasterxml.jackson.databind.ObjectMapper mapper

apiSpecificationFile

protected String apiSpecificationFile

apiSpecificationContent

protected byte[] apiSpecificationContent

filterConfig

protected APISpecificationFilter filterConfig

Constructor Detail

APISpecification

public APISpecification()

Method Detail

getApiSpecificationFile

public String getApiSpecificationFile()

setApiSpecificationFile

public void setApiSpecificationFile(String apiSpecificationFile)

getApiSpecificationContent

public abstract byte[] getApiSpecificationContent()

updateBasePath

public abstract void updateBasePath(String basePath,
                                    String host)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

configureBasePath

public abstract void configureBasePath(String backendBasePath,
                                       API api)
                                throws AppException

Throws:

AppException

getDescription

public abstract String getDescription()

getAPIDefinitionType

public abstract APISpecification.APISpecType getAPIDefinitionType()
                                                           throws AppException

Throws:

AppException

parse

public boolean parse(byte[] apiSpecificationContent)
              throws AppException

Throws:

AppException

setMapperForDataFormat

protected void setMapperForDataFormat()
                               throws AppException

Throws:

AppException

compareJSON

public boolean compareJSON(APISpecification apiSpecification,
                           APISpecification gatewayApiSpecification)

compareString

public boolean compareString(byte[] sourceSpec,
                             byte[] gatewaySpec)

filterAPISpecification

public void filterAPISpecification()

setFilterConfig

public APISpecification setFilterConfig(APISpecificationFilter filterConfig)