com.axway.apim.api

Class APIBaseDefinition

java.lang.Object

com.axway.apim.api.API

com.axway.apim.api.APIBaseDefinition

public class APIBaseDefinition
extends API

Not sure if this class is really needed.

Author:

cwiechmann@axway.com

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
APIBaseDefinition()

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.
void	setStatus(String state)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

APIBaseDefinition

public APIBaseDefinition()

Method Detail

getState

public String getState()

Description copied from class: API

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

Returns:

the state of the API (unpublished, deprecated, etc.)

See Also:

API.getState()

setStatus

public void setStatus(String state)