com.axway.apim.api.state

Class APIChangeState

java.lang.Object

com.axway.apim.api.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
static void	copyChangedProps(API desiredAPI, API createdAPI, List<String> changes)
static void	copyProps(API sourceAPI, API targetAPI, List<String> propsToCopy, boolean logMessage) Copied all changed properties of the API having APIPropertyAnnotation set to copyProp = true (default)
API	getActualAPI()
List<String>	getAllChanges()
List<String>	getBreakingChanges()
API	getDesiredAPI()
List<String>	getNonBreakingChanges()
boolean	hasAnyChanges()
static void	initCreatedAPI(API desiredAPI, API createdAPI)
boolean	isAdminAccountNeeded()
boolean	isBreaking()
boolean	isProxyUpdateRequired()
boolean	isUpdateExistingAPI()
void	setActualAPI(API actualAPI)
void	setDesiredAPI(API desiredAPI)
String	waiting4Approval()

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

initCreatedAPI

public static void initCreatedAPI(API desiredAPI,
                                  API createdAPI)
                           throws AppException

Throws:

AppException

copyChangedProps

public static void copyChangedProps(API desiredAPI,
                                    API createdAPI,
                                    List<String> changes)
                             throws AppException

Throws:

AppException

copyProps

public static void copyProps(API sourceAPI,
                             API targetAPI,
                             List<String> propsToCopy,
                             boolean logMessage)
                      throws AppException

Copied all changed properties of the API having APIPropertyAnnotation set to copyProp = true (default)

Parameters:

sourceAPI - copy the properties from this source API

targetAPI - copy the properties into this target API

propsToCopy - the list of API properties to copy

logMessage - controls if a log message is created which properties are copied

Throws:

AppException - if something goes wrong

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.

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.

isProxyUpdateRequired

public boolean isProxyUpdateRequired()

getAllChanges

public List<String> getAllChanges()

Returns:

list of all changes.

isAdminAccountNeeded

public boolean isAdminAccountNeeded()
                             throws AppException

Throws:

AppException

waiting4Approval

public String waiting4Approval()
                        throws AppException

Throws:

AppException