com.axway.apim.apiimport.state

Class APIChangeState

java.lang.Object

com.axway.apim.apiimport.state.APIChangeState

public class APIChangeState
extends Object

This class is key, as the desired and actual API comes together. This class compares the desired- with the actual-API to create the Change-State. Basically a list of changes that are needed to bring the API in sync. For that the class iterates through all the declared API-Properties, in case of changes the belonging APIManagerAction is queued to be executed. This way of working is esp. important when updating an existing API, without replacing it.

Author:

cwiechmann

Constructor Summary

Constructors

Constructor and Description
APIChangeState(API actualAPI, API desiredAPI) Constructs the APIChangeState based on the given Actual- and Desired-API.

Method Summary

Modifier and Type	Method and Description
API	getActualAPI()
List<String>	getBreakingChanges()
API	getDesiredAPI()
API	getIntransitAPI() The IntransitAPI is used/set, when a new API has been created in API-Manager while the "old actual API" still exists.
List<String>	getNonBreakingChanges()
boolean	hasAnyChanges()
boolean	isBreaking()
boolean	isUpdateExistingAPI()
void	setActualAPI(API actualAPI)
void	setDesiredAPI(API desiredAPI)
void	setIntransitAPI(API intransitAPI) The IntransitAPI is used/set, when a new API has been created in API-Manager while the "old actual API" still exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

APIChangeState

public APIChangeState(API actualAPI,
                      API desiredAPI)
               throws AppException

Constructs the APIChangeState based on the given Actual- and Desired-API.

Parameters:

actualAPI - - The API taken from the API-Manager

desiredAPI - - The API loaded from the Swagger + Config

Throws:

AppException - - Is thrown when something goes wrong.

Method Detail

getActualAPI

public API getActualAPI()

Returns:

the API-Manager API that has been given to this APIChangeState instance

setActualAPI

public void setActualAPI(API actualAPI)

Parameters:

actualAPI - overwrites the API-Manager API instance

getDesiredAPI

public API getDesiredAPI()

Returns:

the desired API that has been given to this APIChangeState instance

setDesiredAPI

public void setDesiredAPI(API desiredAPI)

Parameters:

desiredAPI - overwrites the desired API.

getIntransitAPI

public API getIntransitAPI()

The IntransitAPI is used/set, when a new API has been created in API-Manager while the "old actual API" still exists. This is required for instance when the API must be Re-Created, before told old can be deleted. This API basically stores the actual API before the real old actual API can be deleted.

Returns:

the in TransitAPI.

See Also:

CreateNewAPI

setIntransitAPI

public void setIntransitAPI(API intransitAPI)

The IntransitAPI is used/set, when a new API has been created in API-Manager while the "old actual API" still exists. This is required for instance when the API must be Re-Created, before told old can be deleted. This API basically stores the actual API before the real old actual API can be deleted.

Parameters:

intransitAPI - the intermediate API

See Also:

CreateNewAPI

hasAnyChanges

public boolean hasAnyChanges()

Returns:

true, if a breakingChange or a nonBreakingChange was found otherwise false.

isBreaking

public boolean isBreaking()
                   throws AppException

Returns:

true, if a Breaking-Change propery is found on an "Unpublished" API otherwise false.

Throws:

AppException - if the actualAPI.state can't be read

isUpdateExistingAPI

public boolean isUpdateExistingAPI()

Returns:

true if all changes are writable to actual/current API-State.

getBreakingChanges

public List<String> getBreakingChanges()

Returns:

list of breaking changes

getNonBreakingChanges

public List<String> getNonBreakingChanges()

Returns:

list of Non-Breaking-Changes.