com.axway.apim.apiimport

Class DesiredAPI

java.lang.Object

com.axway.apim.api.API

com.axway.apim.apiimport.DesiredAPI

Direct Known Subclasses:

DesiredTestOnlyAPI

public class DesiredAPI
extends API

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

Author:

cwiechmann@axway.com

Field Summary

Fields

Modifier and Type	Field and Description
String	apiDefinitionImport

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
DesiredAPI()

Method Summary

Modifier and Type	Method and Description
String	getApiDefinitionImport()
String	getBackendBasepath() BackendBasePath is a property which doesn't exists in API-Manager naturally.
boolean	isRequestForAllOrgs() requestForAllOrgs is used to decide if an API should grant access to ALL organizations.
void	setApiDefinitionImport(String apiDefinitionImport)
void	setBackendBasepath(String backendBasepath) BackendBasePath is a property which doesn't exists in API-Manager naturally.
void	setRequestForAllOrgs(boolean requestForAllOrgs) requestForAllOrgs is used to decide if an API should grant access to ALL organizations.
void	setRetirementDate(String retirementDate)

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

getApiConfiguration, getApiDefinition, 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, getState, getSummary, getSystemQuota, getTags, getVersion, getVhost, 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, 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

Field Detail

apiDefinitionImport

public String apiDefinitionImport

Constructor Detail

DesiredAPI

public DesiredAPI()
           throws AppException

Throws:

AppException

Method Detail

getBackendBasepath

public String getBackendBasepath()

BackendBasePath is a property which doesn't exists in API-Manager naturally. It simplifies the use of the tool.

Returns:

the URL to the BE-API-Host.

setBackendBasepath

public void setBackendBasepath(String backendBasepath)

BackendBasePath is a property which doesn't exists in API-Manager naturally. It simplifies the use of the tool. If the backendBasePath is set internally a ServiceProfile is created by this method.

Parameters:

backendBasepath - the URL to the BE-API-Host.

isRequestForAllOrgs

public boolean isRequestForAllOrgs()

requestForAllOrgs is used to decide if an API should grant access to ALL organizations. That means, when an API-Developer is defining ALL as the organization name this flag is set to true and it becomes the desired state.

Returns:

true, if the developer wants to have permissions to this API for all Orgs.

setRequestForAllOrgs

public void setRequestForAllOrgs(boolean requestForAllOrgs)

requestForAllOrgs is used to decide if an API should grant access to ALL organizations. That means, when an API-Developer is defining ALL as the organization name this flag is set to true and it becomes the desired state. This method is used during creation of APIImportDefinition in APIImportConfig#handleAllOrganizations()

Parameters:

requestForAllOrgs - when set to true, the APIs will be granted to ALL organizations.

See Also:

APIImportConfigAdapter

getApiDefinitionImport

public String getApiDefinitionImport()

Overrides:

getApiDefinitionImport in class API

setApiDefinitionImport

public void setApiDefinitionImport(String apiDefinitionImport)

setRetirementDate

public void setRetirementDate(String retirementDate)
                       throws AppException

Throws:

AppException