com.axway.apim.adapter

Class APIManagerAdapter

java.lang.Object

com.axway.apim.adapter.APIManagerAdapter

public class APIManagerAdapter
extends Object

The APIContract reflects the actual existing API in the API-Manager.

Author:

cwiechmann@axway.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APIManagerAdapter.CacheType
static class	APIManagerAdapter.CUSTOM_PROP_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
APIManagerAPIAccessAdapter	accessAdapter
APIManagerAPIAdapter	apiAdapter
static String	apiManagerVersion
APIMgrAppsAdapter	appAdapter
static String	APPLICATION_DEFAULT_QUOTA
APIManagerConfigAdapter	configAdapter
static String	CREDENTIAL_TYPE_API_KEY
static String	CREDENTIAL_TYPE_EXT_CLIENTID
static String	CREDENTIAL_TYPE_OAUTH
static com.fasterxml.jackson.databind.ObjectMapper	mapper
APIManagerAPIMethodAdapter	methodAdapter
APIManagerOAuthClientProfilesAdapter	oauthClientAdapter
APIManagerOrganizationAdapter	orgAdapter
APIManagerPoliciesAdapter	policiesAdapter
APIManagerQuotaAdapter	quotaAdapter
static String	SYSTEM_API_QUOTA
static String	TYPE_BACK_END
static String	TYPE_FRONT_END

Method Summary

Modifier and Type	Method and Description
static void	clearCache(String cacheName)
static void	deleteInstance()
static Map<String,String>	getAllConfiguredCustomProperties(APIManagerAdapter.CUSTOM_PROP_TYPE type)
static String	getApiManagerVersion()
ClientApplication	getAppIdForCredential(String credential, String type) The actual App-ID based on the AppName.
static <K,V> org.ehcache.Cache<K,V>	getCache(APIManagerAdapter.CacheType cacheType, Class<K> key, Class<V> value)
static com.fasterxml.jackson.databind.JsonNode	getCertInfo(InputStream certFile, CaCert cert) Helper method to fulfill the given certificates by the API-Developer into the required format as it's needed by the API-Manager.
static User	getCurrentUser(boolean useAdminClient)
static com.fasterxml.jackson.databind.JsonNode	getCustomPropertiesConfig()
static com.fasterxml.jackson.databind.JsonNode	getFileData(byte[] certificate, String filename) Helper method to translate a Base64 encoded format as it's needed by the API-Manager.
static Image	getImageFromAPIM(URI uri, String baseFilename)
static APIManagerAdapter	getInstance()
static boolean	hasAdminAccount()
static boolean	hasAPIManagerVersion(String version) Checks if the API-Manager has at least given version.
boolean	isUsingOrgAdmin()
void	loginToAPIManager(boolean useAdminClient)
static com.fasterxml.jackson.databind.JsonNode	parseAppConfig(String appConfig) Helper method to validate that configured Custom-Properties are really configured in the API-Manager configuration.

Methods inherited from class java.lang.Object

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

Field Detail

apiManagerVersion

public static String apiManagerVersion

mapper

public static com.fasterxml.jackson.databind.ObjectMapper mapper

CREDENTIAL_TYPE_API_KEY

public static String CREDENTIAL_TYPE_API_KEY

CREDENTIAL_TYPE_EXT_CLIENTID

public static String CREDENTIAL_TYPE_EXT_CLIENTID

CREDENTIAL_TYPE_OAUTH

public static String CREDENTIAL_TYPE_OAUTH

SYSTEM_API_QUOTA

public static final String SYSTEM_API_QUOTA

See Also:

Constant Field Values

APPLICATION_DEFAULT_QUOTA

public static final String APPLICATION_DEFAULT_QUOTA

See Also:

Constant Field Values

TYPE_FRONT_END

public static final String TYPE_FRONT_END

See Also:

Constant Field Values

TYPE_BACK_END

public static final String TYPE_BACK_END

See Also:

Constant Field Values

configAdapter

public APIManagerConfigAdapter configAdapter

apiAdapter

public APIManagerAPIAdapter apiAdapter

methodAdapter

public APIManagerAPIMethodAdapter methodAdapter

policiesAdapter

public APIManagerPoliciesAdapter policiesAdapter

quotaAdapter

public APIManagerQuotaAdapter quotaAdapter

orgAdapter

public APIManagerOrganizationAdapter orgAdapter

accessAdapter

public APIManagerAPIAccessAdapter accessAdapter

oauthClientAdapter

public APIManagerOAuthClientProfilesAdapter oauthClientAdapter

appAdapter

public APIMgrAppsAdapter appAdapter

Method Detail

getInstance

public static APIManagerAdapter getInstance()
                                     throws AppException

Throws:

AppException

deleteInstance

public static void deleteInstance()
                           throws AppException

Throws:

AppException

loginToAPIManager

public void loginToAPIManager(boolean useAdminClient)
                       throws AppException

Throws:

AppException

getCurrentUser

public static User getCurrentUser(boolean useAdminClient)
                           throws AppException

Throws:

AppException

getCache

public static <K,V> org.ehcache.Cache<K,V> getCache(APIManagerAdapter.CacheType cacheType,
                                                    Class<K> key,
                                                    Class<V> value)

clearCache

public static void clearCache(String cacheName)

hasAPIManagerVersion

public static boolean hasAPIManagerVersion(String version)

Checks if the API-Manager has at least given version. If the given requested version is the same or lower than the actual API-Manager version, true is returned otherwise false. This helps to use features, that are introduced with a certain version or even service-pack.

Parameters:

version - has the API-Manager this version of higher?

Returns:

false if API-Manager doesn't have this version otherwise true

getAppIdForCredential

public ClientApplication getAppIdForCredential(String credential,
                                               String type)
                                        throws AppException

The actual App-ID based on the AppName. Lazy implementation.

Parameters:

credential - The credentials (API-Key, Client-ID) which is registered for an application

type - of the credential. See APIManagerAdapter for potential credential types

Returns:

the id of the organization

Throws:

AppException - if JSON response from API-Manager can't be parsed

getImageFromAPIM

public static Image getImageFromAPIM(URI uri,
                                     String baseFilename)
                              throws AppException

Throws:

AppException

getApiManagerVersion

public static String getApiManagerVersion()
                                   throws AppException

Throws:

AppException

getAllConfiguredCustomProperties

public static Map<String,String> getAllConfiguredCustomProperties(APIManagerAdapter.CUSTOM_PROP_TYPE type)

getCustomPropertiesConfig

public static com.fasterxml.jackson.databind.JsonNode getCustomPropertiesConfig()
                                                                         throws AppException

Throws:

AppException

parseAppConfig

public static com.fasterxml.jackson.databind.JsonNode parseAppConfig(String appConfig)
                                                              throws AppException

Helper method to validate that configured Custom-Properties are really configured in the API-Manager configuration.
Will become obsolete sine the API-Manager REST-API provides an endpoint for that.

Parameters:

appConfig - from the API-Manager (which isn't JSON)

Returns:

JSON-Configuration with the custom-properties section

Throws:

AppException - if the app.config can't be parsed

getCertInfo

public static com.fasterxml.jackson.databind.JsonNode getCertInfo(InputStream certFile,
                                                                  CaCert cert)
                                                           throws AppException

Helper method to fulfill the given certificates by the API-Developer into the required format as it's needed by the API-Manager.

Parameters:

certFile - InputStream to the Certificate

cert - the certificate itself

Returns:

JsonNode as it's required by the API-Manager.

Throws:

AppException - if JSON-Node-Config can't be created

getFileData

public static com.fasterxml.jackson.databind.JsonNode getFileData(byte[] certificate,
                                                                  String filename)
                                                           throws AppException

Helper method to translate a Base64 encoded format as it's needed by the API-Manager.

Parameters:

certificate - the certificate content

filename - the name of the certificate file used as a reference in the generated Json object

Returns:

a Json-Object structure as needed by the API-Manager

Throws:

AppException - when the certificate information can't be created

hasAdminAccount

public static boolean hasAdminAccount()
                               throws AppException

Returns:

true, when admin credentials are provided

Throws:

AppException - when the API-Manager instance is not initialized

isUsingOrgAdmin

public boolean isUsingOrgAdmin()

Returns:

true, if an OrgAdmin is the primary user (additional Admin-Credentials may have provided anyway)