API (Axway API-Manager CLI API-Manager Adapter 1.0.1 API)

java.lang.Object
- com.axway.apim.api.API

Direct Known Subclasses:

APIBaseDefinition
```
public class API
extends Object
```
This class defines all common properties on an API and how each property should be treated during replication. APIManagerAPI and APIImportDefintion are both an instance of this class. Annotations for each property are used by the APIChangeState to decide: - Is is a breaking change? - Can the change be applied to the existing API? - Which Change-Handler should finally do the required actions to replicate the change into the APIManager When adding new properties, please make sure to create Getter and Setter as Jackson is used to create the Instances. Perhaps a way to simplify the code is to use for many of the properties is to use a SimplePropertyHandler as many properties are handled in the same way.

Author:

cwiechmann@axway.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected APISpecification`	`apiDefinition`
`protected String`	`apiId`
`protected List<APIMethod>`	`apiMethods`
`protected String`	`apiRoutingKey`
`protected APIQuota`	`applicationQuota`
`protected List<ClientApplication>`	`applications`
`protected List<AuthenticationProfile>`	`authenticationProfiles`
`protected List<CaCert>`	`caCerts`
`protected List<Organization>`	`clientOrganizations`
`protected List<CorsProfile>`	`corsProfiles`
`protected String`	`createdBy`
`protected String`	`createdOn`
`protected Map<String,String>`	`customProperties`
`protected String`	`deprecated`
`protected String`	`descriptionManual`
`protected String`	`descriptionMarkdown`
`protected String`	`descriptionType`
`protected String`	`descriptionUrl`
`protected String`	`id`
`protected Image`	`image`
`protected Map<String,InboundProfile>`	`inboundProfiles`
`protected String`	`name`
`protected Organization`	`organization`
`protected Map<String,OutboundProfile>`	`outboundProfiles`
`protected String`	`path`
`protected Long`	`retirementDate`
`protected List<SecurityProfile>`	`securityProfiles`
`protected Map<String,ServiceProfile>`	`serviceProfiles`
`protected String`	`state`
`static String`	`STATE_DELETED`
`static String`	`STATE_DEPRECATED`
`static String`	`STATE_PENDING`
`static String`	`STATE_PUBLISHED`
`static String`	`STATE_UNPUBLISHED`
`protected String`	`summary`
`protected APIQuota`	`systemQuota`
`protected TagMap<String,String[]>`	`tags`
`protected String`	`version`
`protected String`	`vhost`

Constructor Summary

Constructors
Constructor and Description

API()

Constructors
Constructor and Description
`API()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`getApiConfiguration()`
`APISpecification`	`getApiDefinition()`
`String`	`getApiDefinitionImport()`
`String`	`getApiId()`
`List<APIMethod>`	`getApiMethods()`
`String`	`getApiRoutingKey()`
`APIQuota`	`getApplicationQuota()`
`List<ClientApplication>`	`getApplications()`
`List<AuthenticationProfile>`	`getAuthenticationProfiles()`
`List<CaCert>`	`getCaCerts()`
`List<Organization>`	`getClientOrganizations()`
`List<CorsProfile>`	`getCorsProfiles()`
`String`	`getCreatedBy()`
`String`	`getCreatedOn()`
`Map<String,String>`	`getCustomProperties()`
`String`	`getDeprecated()`
`String`	`getDescriptionManual()`
`String`	`getDescriptionMarkdown()`
`String`	`getDescriptionType()`
`String`	`getDescriptionUrl()`
`String`	`getId()`
`Image`	`getImage()`
`Map<String,InboundProfile>`	`getInboundProfiles()`
`String`	`getName()`
`Organization`	`getOrganization()`
`String`	`getOrganizationId()`
`Map<String,OutboundProfile>`	`getOutboundProfiles()`
`String`	`getPath()`
`Long`	`getRetirementDate()`
`List<SecurityProfile>`	`getSecurityProfiles()`
`Map<String,ServiceProfile>`	`getServiceProfiles()`
`String`	`getState()` The tool handles deprecation as an additional state (might not be best choice), but the API-Manager internally doesn't.
`String`	`getSummary()`
`APIQuota`	`getSystemQuota()`
`TagMap<String,String[]>`	`getTags()`
`String`	`getVersion()`
`String`	`getVhost()`
`void`	`setApiConfiguration(com.fasterxml.jackson.databind.JsonNode apiConfiguration)`
`void`	`setApiDefinition(APISpecification apiDefinition)`
`void`	`setApiId(String apiId)`
`void`	`setApiMethods(List<APIMethod> apiMethods)`
`void`	`setApiRoutingKey(String apiRoutingKey)`
`void`	`setApplicationQuota(APIQuota applicationQuota)`
`void`	`setApplications(List<ClientApplication> applications)`
`void`	`setAuthenticationProfiles(List<AuthenticationProfile> authenticationProfiles)`
`void`	`setCaCerts(List<CaCert> caCerts)`
`void`	`setClientOrganizations(List<Organization> clientOrganizations)`
`void`	`setCorsProfiles(List<CorsProfile> corsProfiles)`
`void`	`setCreatedBy(String createdBy)`
`void`	`setCreatedOn(String createdOn)`
`void`	`setCustomProperties(Map<String,String> customProperties)`
`void`	`setDeprecated(String deprecated)`
`void`	`setDescriptionManual(String descriptionManual)`
`void`	`setDescriptionMarkdown(String descriptionMarkdown)`
`void`	`setDescriptionType(String descriptionType)`
`void`	`setDescriptionUrl(String descriptionUrl)`
`void`	`setId(String id)`
`void`	`setImage(Image image)`
`void`	`setInboundProfiles(Map<String,InboundProfile> inboundProfiles)`
`void`	`setName(String name)`
`void`	`setOrganization(Organization organization)`
`void`	`setOutboundProfiles(Map<String,OutboundProfile> outboundProfiles)`
`void`	`setPath(String path)`
`void`	`setRetirementDate(Long retirementDate)`
`void`	`setSecurityProfiles(List<SecurityProfile> securityProfiles)`
`void`	`setServiceProfiles(Map<String,ServiceProfile> serviceProfiles)`
`void`	`setState(String state)`
`void`	`setSummary(String summary)`
`void`	`setSystemQuota(APIQuota systemQuota)`
`void`	`setTags(TagMap<String,String[]> tags)`
`void`	`setVersion(String version)`
`void`	`setVhost(String vhost)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATE_PUBLISHED

public static final String STATE_PUBLISHED

See Also:: Constant Field Values

STATE_UNPUBLISHED

public static final String STATE_UNPUBLISHED

See Also:: Constant Field Values

STATE_DEPRECATED

public static final String STATE_DEPRECATED

See Also:: Constant Field Values

STATE_DELETED

public static final String STATE_DELETED

See Also:: Constant Field Values

STATE_PENDING

public static final String STATE_PENDING

See Also:: Constant Field Values

apiDefinition

protected APISpecification apiDefinition

caCerts
```
protected List<CaCert> caCerts
```

descriptionType
```
protected String descriptionType
```

descriptionManual
```
protected String descriptionManual
```

descriptionMarkdown
```
protected String descriptionMarkdown
```

descriptionUrl
```
protected String descriptionUrl
```

securityProfiles

protected List<SecurityProfile> securityProfiles

authenticationProfiles

protected List<AuthenticationProfile> authenticationProfiles

tags
```
protected TagMap<String,String[]> tags
```

outboundProfiles

protected Map<String,OutboundProfile> outboundProfiles

serviceProfiles

protected Map<String,ServiceProfile> serviceProfiles

inboundProfiles

protected Map<String,InboundProfile> inboundProfiles

corsProfiles

protected List<CorsProfile> corsProfiles

clientOrganizations

protected List<Organization> clientOrganizations

applications

protected List<ClientApplication> applications

path
```
protected String path
```

state
```
protected String state
```

version
```
protected String version
```

vhost
```
protected String vhost
```

name
```
protected String name
```

summary
```
protected String summary
```

createdOn
```
protected String createdOn
```

createdBy
```
protected String createdBy
```

image
```
protected Image image
```

customProperties

protected Map<String,String> customProperties

applicationQuota
```
protected APIQuota applicationQuota
```

systemQuota
```
protected APIQuota systemQuota
```

apiRoutingKey
```
protected String apiRoutingKey
```

organization
```
protected Organization organization
```

id
```
protected String id
```

apiId
```
protected String apiId
```

deprecated
```
protected String deprecated
```

retirementDate
```
protected Long retirementDate
```

apiMethods
```
protected List<APIMethod> apiMethods
```

Constructor Detail
- API
```
public API()
```

Method Detail

getApiDefinition

public APISpecification getApiDefinition()

setApiDefinition

public void setApiDefinition(APISpecification apiDefinition)

getOutboundProfiles

public Map<String,OutboundProfile> getOutboundProfiles()
                                                throws AppException

Throws:: AppException

setOutboundProfiles

public void setOutboundProfiles(Map<String,OutboundProfile> outboundProfiles)

getSecurityProfiles

public List<SecurityProfile> getSecurityProfiles()
                                          throws AppException

Throws:: AppException

setSecurityProfiles

public void setSecurityProfiles(List<SecurityProfile> securityProfiles)

getAuthenticationProfiles

public List<AuthenticationProfile> getAuthenticationProfiles()

setAuthenticationProfiles

public void setAuthenticationProfiles(List<AuthenticationProfile> authenticationProfiles)

getInboundProfiles

public Map<String,InboundProfile> getInboundProfiles()

setInboundProfiles

public void setInboundProfiles(Map<String,InboundProfile> inboundProfiles)

getCorsProfiles

public List<CorsProfile> getCorsProfiles()

setCorsProfiles

public void setCorsProfiles(List<CorsProfile> corsProfiles)

getVhost
```
public String getVhost()
```

setVhost
```
public void setVhost(String vhost)
```

getTags

public TagMap<String,String[]> getTags()

setState
```
public void setState(String state)
```

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.

Returns:

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

Throws:

AppException - in case of an error

See Also:

getState()

getVersion
```
public String getVersion()
```

setVersion

public void setVersion(String version)

getSummary
```
public String getSummary()
```

setSummary

public void setSummary(String summary)

getImage
```
public Image getImage()
```

setImage
```
public void setImage(Image image)
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getOrganization
```
public Organization getOrganization()
```

getOrganizationId
```
public String getOrganizationId()
```

setOrganization

public void setOrganization(Organization organization)

getPath

public String getPath()
               throws AppException

Throws:: AppException

setPath
```
public void setPath(String path)
```

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getApiId
```
public String getApiId()
```

setApiId
```
public void setApiId(String apiId)
```

getDeprecated
```
public String getDeprecated()
```

setDeprecated

public void setDeprecated(String deprecated)

getRetirementDate
```
public Long getRetirementDate()
```

setRetirementDate

public void setRetirementDate(Long retirementDate)

getCustomProperties

public Map<String,String> getCustomProperties()

setCustomProperties

public void setCustomProperties(Map<String,String> customProperties)

getDescriptionType
```
public String getDescriptionType()
```

setDescriptionType

public void setDescriptionType(String descriptionType)

getDescriptionManual
```
public String getDescriptionManual()
```

setDescriptionManual

public void setDescriptionManual(String descriptionManual)

getDescriptionMarkdown

public String getDescriptionMarkdown()

setDescriptionMarkdown

public void setDescriptionMarkdown(String descriptionMarkdown)

getDescriptionUrl
```
public String getDescriptionUrl()
```

setDescriptionUrl

public void setDescriptionUrl(String descriptionUrl)

getCaCerts
```
public List<CaCert> getCaCerts()
```

setCaCerts

public void setCaCerts(List<CaCert> caCerts)

getApplicationQuota
```
public APIQuota getApplicationQuota()
```

setApplicationQuota

public void setApplicationQuota(APIQuota applicationQuota)

getSystemQuota
```
public APIQuota getSystemQuota()
```

setSystemQuota

public void setSystemQuota(APIQuota systemQuota)

getServiceProfiles

public Map<String,ServiceProfile> getServiceProfiles()

setTags

public void setTags(TagMap<String,String[]> tags)

setServiceProfiles

public void setServiceProfiles(Map<String,ServiceProfile> serviceProfiles)

getClientOrganizations

public List<Organization> getClientOrganizations()
                                          throws AppException

Throws:: AppException

setClientOrganizations

public void setClientOrganizations(List<Organization> clientOrganizations)

getApplications

public List<ClientApplication> getApplications()

setApplications

public void setApplications(List<ClientApplication> applications)

getApiRoutingKey
```
public String getApiRoutingKey()
```

setApiRoutingKey

public void setApiRoutingKey(String apiRoutingKey)

getApiMethods

public List<APIMethod> getApiMethods()

setApiMethods

public void setApiMethods(List<APIMethod> apiMethods)

toString
```
public String toString()
```
Overrides:

toString in class Object

getApiDefinitionImport

public String getApiDefinitionImport()

getApiConfiguration

public com.fasterxml.jackson.databind.JsonNode getApiConfiguration()

setApiConfiguration

public void setApiConfiguration(com.fasterxml.jackson.databind.JsonNode apiConfiguration)

getCreatedOn
```
public String getCreatedOn()
```

setCreatedOn

public void setCreatedOn(String createdOn)

getCreatedBy
```
public String getCreatedBy()
```

setCreatedBy

public void setCreatedBy(String createdBy)

Class API

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_PUBLISHED

STATE_UNPUBLISHED

STATE_DEPRECATED

STATE_DELETED

STATE_PENDING

apiDefinition

caCerts

descriptionType

descriptionManual

descriptionMarkdown

descriptionUrl

securityProfiles

authenticationProfiles

tags

outboundProfiles

serviceProfiles

inboundProfiles

corsProfiles

clientOrganizations

applications

path

state

version

vhost

name

summary

createdOn

createdBy

image

customProperties

applicationQuota

systemQuota

apiRoutingKey

organization

id

apiId

deprecated

retirementDate

apiMethods

Constructor Detail

API

Method Detail

getApiDefinition

setApiDefinition

getOutboundProfiles

setOutboundProfiles

getSecurityProfiles

setSecurityProfiles

getAuthenticationProfiles

setAuthenticationProfiles

getInboundProfiles

setInboundProfiles

getCorsProfiles

setCorsProfiles

getVhost

setVhost

getTags

setState

getState

getVersion

setVersion

getSummary

setSummary

getImage

setImage

getName

setName

getOrganization

getOrganizationId

setOrganization

getPath

setPath

getId

setId