com.axway.apim.apiimport

Class ActualAPI

java.lang.Object

com.axway.apim.api.API

com.axway.apim.apiimport.ActualAPI

public class ActualAPI
extends API

Concrete class that is used to reflect the actual API as it's stored in the API-Manager. On the other hand, the APIImportDefintion reflects the desired state of the API. Both classes extend the AbstractAPIDefinition which contains all the common API-Properties that are compared property by property in APIChangeState.

Author:

cwiechmann@axway.com

See Also:

API, DesiredAPI

Field Summary

Fields inherited from class com.axway.apim.api.API

APIDefinition, apiId, apiMethods, apiRoutingKey, applicationQuota, applications, authenticationProfiles, caCerts, clientOrganizations, corsProfiles, customProperties, deprecated, descriptionManual, descriptionMarkdown, descriptionType, descriptionUrl, id, image, inboundProfiles, name, OPEN_API_30, organization, outboundProfiles, path, retirementDate, securityProfiles, serviceProfiles, state, STATE_DELETED, STATE_DEPRECATED, STATE_PENDING, STATE_PUBLISHED, STATE_UNPUBLISHED, summary, SWAGGGER_API_12, SWAGGGER_API_20, systemQuota, tags, version, vhost, WSDL_API

Constructor Summary

Constructors

Constructor and Description
ActualAPI()

Method Summary

Modifier and Type	Method and Description
String	getState() The tool handles deprecation as an additional state (might not be best choice), but the API-Manager internally doesn't.

Methods inherited from class com.axway.apim.api.API

getApiConfiguration, getAPIDefinition, getApiDefinitionImport, getApiId, getApiMethods, getApiRoutingKey, getAPIType, getApplicationQuota, getApplications, getAuthenticationProfiles, getCaCerts, getClientOrganizations, getCorsProfiles, getCustomProperties, getDeprecated, getDescriptionManual, getDescriptionMarkdown, getDescriptionType, getDescriptionUrl, getId, getImage, getInboundProfiles, getName, getOrganization, getOutboundProfiles, getPath, getRetirementDate, getSecurityProfiles, getServiceProfiles, getSummary, getSystemQuota, getTags, getVersion, getVhost, setApiConfiguration, setAPIDefinition, setApiId, setApiMethods, setApiRoutingKey, setApplicationQuota, setApplications, setAuthenticationProfiles, setCaCerts, setClientOrganizations, setCorsProfiles, setCustomProperties, setDeprecated, setDescriptionManual, setDescriptionMarkdown, setDescriptionType, setDescriptionUrl, setId, setImage, setInboundProfiles, setName, setOrganization, setOutboundProfiles, setPath, setRetirementDate, setSecurityProfiles, setState, setSummary, setSystemQuota, setVersion, setVhost, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ActualAPI

public ActualAPI()
          throws AppException

Throws:

AppException

Method Detail

getState

public String getState()
                throws AppException

The tool handles deprecation as an additional state (might not be best choice), but the API-Manager internally doesn't. In API-Manager deprecation is just a true/false toggle. To make Desired and Actual API comparable this method is encapsulating the difference.

Overrides:

getState in class API

Throws:

AppException

See Also:

API.getState()