Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.axway.apim.swagger.APIManagerAdapter Maven / Gradle / Ivy
package com.axway.apim.swagger;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.io.IOUtils;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.axway.apim.actions.CreateNewAPI;
import com.axway.apim.actions.RecreateToUpdateAPI;
import com.axway.apim.actions.UpdateExistingAPI;
import com.axway.apim.actions.rest.APIMHttpClient;
import com.axway.apim.actions.rest.GETRequest;
import com.axway.apim.actions.rest.POSTRequest;
import com.axway.apim.actions.rest.RestAPICall;
import com.axway.apim.actions.rest.Transaction;
import com.axway.apim.lib.APIPropertiesExport;
import com.axway.apim.lib.AppException;
import com.axway.apim.lib.CommandParameters;
import com.axway.apim.lib.ErrorCode;
import com.axway.apim.lib.ErrorState;
import com.axway.apim.swagger.api.properties.APIDefintion;
import com.axway.apim.swagger.api.properties.APIImage;
import com.axway.apim.swagger.api.properties.apiAccess.APIAccess;
import com.axway.apim.swagger.api.properties.applications.ClientApplication;
import com.axway.apim.swagger.api.properties.cacerts.CaCert;
import com.axway.apim.swagger.api.properties.organization.ApiAccess;
import com.axway.apim.swagger.api.properties.organization.Organization;
import com.axway.apim.swagger.api.properties.outboundprofiles.OutboundProfile;
import com.axway.apim.swagger.api.properties.quota.APIQuota;
import com.axway.apim.swagger.api.properties.quota.QuotaRestriction;
import com.axway.apim.swagger.api.properties.user.User;
import com.axway.apim.swagger.api.state.APIMethod;
import com.axway.apim.swagger.api.state.AbstractAPI;
import com.axway.apim.swagger.api.state.ActualAPI;
import com.axway.apim.swagger.api.state.IAPI;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
/**
* The APIContract reflects the actual existing API in the API-Manager.
*
* @author [email protected]
*/
public class APIManagerAdapter {
private static Logger LOG = LoggerFactory.getLogger(APIManagerAdapter.class);
private static APIManagerAdapter instance;
public static String apiManagerVersion = null;
private static Map apiManagerConfig = new HashMap();
private static List allOrgs = null;
private static List allApps = null;
private static List allAPIs = null;
private static Map clientCredentialToAppMap = new HashMap();
private static Map> orgsApiAccess = new HashMap>();
private boolean enforceBreakingChange = false;
public static APIQuota sytemQuotaConfig = null;
public static APIQuota applicationQuotaConfig = null;
private boolean usingOrgAdmin = false;
private boolean hasAdminAccount = false;
private ErrorState error = ErrorState.getInstance();
public static String CREDENTIAL_TYPE_API_KEY = "apikeys";
public static String CREDENTIAL_TYPE_EXT_CLIENTID = "extclients";
public static String CREDENTIAL_TYPE_OAUTH = "oauth";
public final static String SYSTEM_API_QUOTA = "00000000-0000-0000-0000-000000000000";
public final static String APPLICATION_DEFAULT_QUOTA = "00000000-0000-0000-0000-000000000001";
public final static String TYPE_FRONT_END = "proxies";
public final static String TYPE_BACK_END = "apirepo";
private static final Map configFieldRequiresAdmin;
static {
Map temp = new HashMap();
temp.put("apiRoutingKeyEnabled", true);
configFieldRequiresAdmin = Collections.unmodifiableMap(temp);
}
public static synchronized APIManagerAdapter getInstance() throws AppException {
return getInstance(false);
}
public static synchronized APIManagerAdapter getInstance(boolean forUnitTests) throws AppException {
if (APIManagerAdapter.instance == null) {
APIManagerAdapter.instance = new APIManagerAdapter (forUnitTests);
}
return APIManagerAdapter.instance;
}
public static synchronized void deleteInstance() throws AppException {
APIManagerAdapter.instance = null;
APIManagerAdapter.apiManagerConfig = new HashMap();;
APIManagerAdapter.allOrgs = null;
}
private APIManagerAdapter(boolean forUnitTests) throws AppException {
super();
if(forUnitTests) return; // No need to initialize just for Unit-Tests
Transaction transaction = Transaction.getInstance();
transaction.beginTransaction();
APIManagerAdapter.allApps = null; // Reset allApps with every run (relevant for testing, as executed in the same JVM)
loginToAPIManager(false); // Login with the provided user (might be an Org-Admin)
loginToAPIManager(true); // Second, login if needed with an admin account
this.enforceBreakingChange = CommandParameters.getInstance().isEnforceBreakingChange();
}
/**
* This method is taking in the APIChangeState to decide about the strategy how to
* synchronize the desired API-State into the API-Manager.
* @param changeState containing the desired and actual API
* @throws AppException is the desired state can't be replicated into the API-Manager.
*/
public void applyChanges(APIChangeState changeState) throws AppException {
CommandParameters commands = CommandParameters.getInstance();
if(!this.hasAdminAccount && isAdminAccountNeeded(changeState) ) {
if(commands.allowOrgAdminsToPublish()) {
LOG.debug("Desired API-State set to published using OrgAdmin account only. Going to create a publish request. "
+ "Set allowOrgAdminsToPublish to false to prevent orgAdmins from creating a publishing request.");
} else {
error.setError("OrgAdmin user only allowed to change/register unpublished APIs. "
+ "Set allowOrgAdminsToPublish to true (default) to allow orgAdmins to create a publishing request.", ErrorCode.NO_ADMIN_ROLE_USER, false);
throw new AppException("OrgAdmin user only allowed to change/register unpublished APIs.", ErrorCode.NO_ADMIN_ROLE_USER);
}
}
// No existing API found (means: No match for APIPath), creating a complete new
if(!changeState.getActualAPI().isValid()) {
// --> CreateNewAPI
LOG.info("Strategy: No existing API found, creating new!");
CreateNewAPI createAPI = new CreateNewAPI();
createAPI.execute(changeState, false);
// Otherwise an existing API exists
} else {
LOG.info("Strategy: Going to update existing API: " + changeState.getActualAPI().getName() +" (Version: "+ changeState.getActualAPI().getVersion() + ")");
if(!changeState.hasAnyChanges()) {
APIPropertiesExport.getInstance().setProperty("feApiId", changeState.getActualAPI().getId());
LOG.debug("BUT, no changes detected between Import- and API-Manager-API. Exiting now...");
error.setWarning("No changes detected between Import- and API-Manager-API", ErrorCode.NO_CHANGE, false);
throw new AppException("No changes detected between Import- and API-Manager-API", ErrorCode.NO_CHANGE);
}
LOG.info("Recognized the following changes. Potentially Breaking: " + changeState.getBreakingChanges() +
" plus Non-Breaking: " + changeState.getNonBreakingChanges());
if (changeState.isBreaking()) { // Make sure, breaking changes aren't applied without enforcing it.
if(!enforceBreakingChange) {
error.setError("A potentially breaking change can't be applied without enforcing it! Try option: -f true", ErrorCode.BREAKING_CHANGE_DETECTED, false);
throw new AppException("A potentially breaking change can't be applied without enforcing it! Try option: -f true", ErrorCode.BREAKING_CHANGE_DETECTED);
}
}
if(changeState.isUpdateExistingAPI()) { // All changes can be applied to the existing API in current state
LOG.info("Strategy: Update existing API, as all changes can be applied in current state.");
UpdateExistingAPI updateAPI = new UpdateExistingAPI();
updateAPI.execute(changeState);
return;
} else { // We have changes, that require a re-creation of the API
LOG.info("Strategy: Apply breaking changes: "+changeState.getBreakingChanges()+" & and "
+ "Non-Breaking: "+changeState.getNonBreakingChanges()+", for "+changeState.getActualAPI().getState().toUpperCase()+" API by recreating it!");
RecreateToUpdateAPI recreate = new RecreateToUpdateAPI();
recreate.execute(changeState);
}
}
if(!this.hasAdminAccount && isAdminAccountNeeded(changeState) && commands.allowOrgAdminsToPublish() ) {
LOG.info("Actual API has been created and is waiting for an approval by an administrator. "
+ "You may update the pending API as often as you want before it is finally published.");
}
}
private boolean isAdminAccountNeeded(APIChangeState changeState) throws AppException {
if(changeState.getDesiredAPI().getState().equals(IAPI.STATE_UNPUBLISHED) &&
(!changeState.getActualAPI().isValid() || changeState.getActualAPI().getState().equals(IAPI.STATE_UNPUBLISHED))) {
return false;
} else {
return true;
}
}
public void loginToAPIManager(boolean useAdminClient) throws AppException {
URI uri;
CommandParameters cmd = CommandParameters.getInstance();
if(cmd.ignoreAdminAccount() && useAdminClient) return;
if(hasAdminAccount && useAdminClient) return; // Already logged in with an Admin-Account.
HttpResponse response = null;
try {
uri = new URIBuilder(cmd.getAPIManagerURL()).setPath(RestAPICall.API_VERSION+"/login").build();
List params = new ArrayList();
String username;
String password;
if(useAdminClient) {
String[] usernamePassword = getAdminUsernamePassword();
if(usernamePassword==null) return;
username = usernamePassword[0];
password = usernamePassword[1];
LOG.debug("Logging in with Admin-User: '" + username + "'");
} else {
username = cmd.getUsername();
password = cmd.getPassword();
LOG.debug("Logging in with User: '" + username + "'");
}
// This forces to create a client which is re-used based on useAdmin
APIMHttpClient client = APIMHttpClient.getInstance(useAdminClient);
params.add(new BasicNameValuePair("username", username));
params.add(new BasicNameValuePair("password", password));
POSTRequest loginRequest = new POSTRequest(new UrlEncodedFormEntity(params), uri, null, useAdminClient);
loginRequest.setContentType(null);
response = loginRequest.execute();
int statusCode = response.getStatusLine().getStatusCode();
if(statusCode == 403 || statusCode == 401){
LOG.error("Login failed: " +statusCode+ ", Response: " + response);
throw new AppException("Given user: '"+username+"' can't login.", ErrorCode.API_MANAGER_COMMUNICATION);
}
User user = getCurrentUser(useAdminClient);
if(user.getRole().equals("admin")) {
this.hasAdminAccount = true;
// Also register this client as an Admin-Client
APIMHttpClient.addInstance(true, client);
} else if (user.getRole().equals("oadmin")) {
this.usingOrgAdmin = true;
} else {
error.setError("Not supported user-role: '"+user.getRole()+"'", ErrorCode.API_MANAGER_COMMUNICATION, false);
throw new AppException("Not supported user-role: "+user.getRole()+"", ErrorCode.API_MANAGER_COMMUNICATION);
}
} catch (Exception e) {
throw new AppException("Can't login to API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(response!=null)
((CloseableHttpResponse)response).close();
} catch (Exception ignore) {}
}
}
private String[] getAdminUsernamePassword() throws AppException {
if(CommandParameters.getInstance().getAdminUsername()==null) return null;
String[] usernamePassword = {CommandParameters.getInstance().getAdminUsername(), CommandParameters.getInstance().getAdminPassword()};
return usernamePassword;
}
public static User getCurrentUser(boolean useAdminClient) throws AppException {
ObjectMapper mapper = new ObjectMapper();
URI uri;
HttpResponse response = null;
JsonNode jsonResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION+"/currentuser").build();
GETRequest currentUserRequest = new GETRequest(uri, null, useAdminClient);
response = currentUserRequest.execute();
getCsrfToken(response, useAdminClient); // Starting from 7.6.2 SP3 the CSRF token is returned on CurrentUser request
String currentUser = IOUtils.toString(response.getEntity().getContent(), "UTF-8");
int statusCode = response.getStatusLine().getStatusCode();
if( statusCode != 200) {
throw new AppException("Status-Code: "+statusCode+", Can't get current-user information on response: '" + currentUser + "'",
ErrorCode.API_MANAGER_COMMUNICATION);
}
User user = mapper.readValue(currentUser, User.class);
if(user == null) {
throw new AppException("Can't get current-user information on response: '" + currentUser + "'",
ErrorCode.API_MANAGER_COMMUNICATION);
}
return user;
} catch (Exception e) {
throw new AppException("Can't get current-user information on response: '" + jsonResponse + "'",
ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(response!=null)
((CloseableHttpResponse)response).close();
} catch (Exception ignore) {}
}
}
private static void getCsrfToken(HttpResponse response, boolean useAdminClient) throws AppException {
for (Header header : response.getAllHeaders()) {
if(header.getName().equals("CSRF-Token")) {
APIMHttpClient.getInstance(useAdminClient).setCsrfToken(header.getValue());
break;
}
}
}
/**
* 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.
* @param version has the API-Manager this version of higher?
* @return false if API-Manager doesn't have this version otherwise true
*/
public static boolean hasAPIManagerVersion(String version) {
try {
List managerVersion = getMajorVersions(getApiManagerVersion());
List requestedVersion = getMajorVersions(version);
Date datedManagerVersion = getDateVersion(managerVersion);
Date datedRequestedVersion = getDateVersion(requestedVersion);
int managerSP = getServicePackVersion(getApiManagerVersion());
int requestedSP = getServicePackVersion(version);
for(int i=0;iInteger.parseInt(requestedVersion.get(i))) return true;
if(managerVer managerVersion) {
if(managerVersion.size()==3) {
try {
String dateVersion = managerVersion.get(2);
Date datedVersion=new SimpleDateFormat("yyyyMMdd").parse(dateVersion);
return datedVersion;
} catch (Exception e) {
LOG.trace("API-Manager version: '"+apiManagerVersion+"' seems not to contain a dated version");
}
}
return null;
}
private static int getServicePackVersion(String version) {
int spNumber = 0;
if(version.contains(" SP")) {
try {
String spVersion = version.substring(version.indexOf(" SP")+3);
spNumber = Integer.parseInt(spVersion);
} catch (Exception e){
LOG.trace("Can't parse service pack version in version: '"+version+"'");
}
}
return spNumber;
}
private static List getMajorVersions(String version) {
List majorNumbers = new ArrayList();
String versionWithoutSP = version;
if(version.contains(" SP")) {
versionWithoutSP = version.substring(0, version.indexOf(" SP"));
}
try {
String[] versions = versionWithoutSP.split("\\.");
for(int i = 0; i customProperties = new LinkedHashMap();
Iterator it = desiredAPI.getCustomProperties().keySet().iterator();
while(it.hasNext()) {
String customPropKey = it.next();
JsonNode value = jsonConfiguration.get(customPropKey);
String customPropValue = (value == null) ? null : value.asText();
customProperties.put(customPropKey, customPropValue);
}
((AbstractAPI)apiManagerApi).setCustomProperties(customProperties);
}
addQuotaConfiguration(apiManagerApi, desiredAPI);
addClientOrganizations(apiManagerApi, desiredAPI);
addClientApplications(apiManagerApi, desiredAPI);
addOrgName(apiManagerApi, desiredAPI);
addExistingClientAppQuotas(apiManagerApi.getApplications());
return apiManagerApi;
} catch (Exception e) {
throw new AppException("Can't initialize API-Manager API-State.", ErrorCode.API_MANAGER_COMMUNICATION, e);
}
}
private void addClientOrganizations(IAPI apiManagerApi, IAPI desiredAPI) throws AppException {
if(!hasAdminAccount) return;
if(desiredAPI.getState().equals(IAPI.STATE_UNPUBLISHED)) {
LOG.info("Ignoring Client-Organizations, as desired API-State is Unpublished!");
return;
}
if(desiredAPI.getClientOrganizations()==null && desiredAPI.getApplications()==null
&& CommandParameters.getInstance().getClientOrgsMode().equals(CommandParameters.MODE_REPLACE)) return;
List grantedOrgs = new ArrayList();
List allOrgs = getAllOrgs();
for(Organization org : allOrgs) {
List orgAPIAccess = getAPIAccess(org.getId(), "organizations");
for(APIAccess access : orgAPIAccess) {
if(access.getApiId().equals(apiManagerApi.getId())) {
grantedOrgs.add(org.getName());
}
}
}
apiManagerApi.setClientOrganizations(grantedOrgs);
}
public void addClientApplications(IAPI apiManagerApi, IAPI desiredAPI) throws AppException {
List existingClientApps = new ArrayList();
List apps = null;
// With version >7.7 we can retrieve the subscribed apps directly
if(APIManagerAdapter.hasAPIManagerVersion("7.7")) {
apps = getSubscribedApps(apiManagerApi.getId());
} else {
apps = getAllApps();
}
for(ClientApplication app : apps) {
List APIAccess = getAPIAccess(app.getId(), "applications");
app.setApiAccess(APIAccess);
if(APIManagerAdapter.hasAPIManagerVersion("7.7")) {
existingClientApps.add(app);
} else {
for(APIAccess access : APIAccess) {
if(access.getApiId().equals(apiManagerApi.getId())) {
existingClientApps.add(app);
}
}
}
}
apiManagerApi.setApplications(existingClientApps);
}
private void addOrgName(IAPI apiManagerApi, IAPI desiredAPI) throws AppException {
if(apiManagerApi.getOrganization()!=null) return;
if(desiredAPI!=null) {
// Is desiredOrgId is the same as the actual org just take over the desired Org-Name
if(desiredAPI.getOrganizationId().equals(apiManagerApi.getOrganizationId())) {
((ActualAPI)apiManagerApi).setOrganization(desiredAPI.getOrganization());
} else {
String actualOrgName = getOrg(apiManagerApi.getOrganizationId()).getName();
((ActualAPI)apiManagerApi).setOrganization(actualOrgName);
}
}
}
private void addExistingClientAppQuotas(List existingClientApps) throws AppException {
if(existingClientApps==null || existingClientApps.size()==0) return; // No apps subscribed to this APIs
for(ClientApplication app : existingClientApps) {
APIQuota appQuota = getQuotaFromAPIManager(app.getId());
app.setAppQuota(appQuota);
}
}
public String getMethodNameForId(String apiId, String methodId) throws AppException {
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/proxies/"+apiId+"/operations/"+methodId).build();
RestAPICall getRequest = new GETRequest(uri, null);
HttpResponse httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
EntityUtils.consume(httpResponse.getEntity());
LOG.trace("Response: " + response);
JsonNode operationDetails = mapper.readTree(response);
if(operationDetails.size()==0) {
LOG.warn("No operation with ID: "+methodId+" found for API with id: " + apiId);
return null;
}
return operationDetails.get("name").asText();
} catch (Exception e) {
LOG.error("Can't load name for operation with id: "+methodId+" for API: "+apiId+". Can't parse response: " + response);
throw new AppException("Can't load name for operation with id: "+methodId+" for API: "+apiId, ErrorCode.API_MANAGER_COMMUNICATION, e);
}
}
public List getAllMethodsForAPI(String apiId) throws AppException {
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
List apiMethods = new ArrayList();
HttpResponse httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/proxies/"+apiId+"/operations").build();
RestAPICall getRequest = new GETRequest(uri, null);
httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
apiMethods = mapper.readValue(response, new TypeReference>(){});
return apiMethods;
} catch (Exception e) {
LOG.error("Error cant load API-Methods for API: '"+apiId+"' from API-Manager. Can't parse response: " + response);
throw new AppException("Error cant load API-Methods for API: '"+apiId+"' from API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
public String getMethodIdPerName(String apiId, String methodName) throws AppException {
List apiMethods = getAllMethodsForAPI(apiId);
if(apiMethods.size()==0) {
LOG.warn("No operations found for API with id: " + apiId);
return null;
}
for(APIMethod method : apiMethods) {
String operationName = method.getName();
if(operationName.equals(methodName)) {
return method.getId();
}
}
LOG.warn("No operation found with name: '"+methodName+"' for API: '"+apiId+"'");
return null;
}
public String getOrgId(String orgName) throws AppException {
return getOrgId(orgName, false);
}
/**
* The actual Org-ID based on the OrgName. Lazy implementation.
* @param orgName the name of the organizations
* @param devOrgsOnly limit the query to organization having the development flag enabled
* @return the id of the organization
* @throws AppException if allOrgs can't be read from the API-Manager
*/
public String getOrgId(String orgName, boolean devOrgsOnly) throws AppException {
if(!this.hasAdminAccount) return null;
if(allOrgs == null) getAllOrgs();
for(Organization org : allOrgs) {
if(devOrgsOnly && org.getDevelopment().equals("false")) continue; // Ignore non-dev orgs
if(orgName.equals(org.getName())) return org.getId();
}
LOG.error("Requested OrgId for unknown orgName: " + orgName);
return null;
}
/**
* The actual Org-ID based on the OrgName. Lazy implementation.
* @param orgId the id of the organizations you want the name for
* @return the id of the organization
* @throws AppException if allOrgs can't be read from the API-Manager
*/
public Organization getOrg(String orgId) throws AppException {
if(allOrgs == null) getAllOrgs();
for(Organization org : allOrgs) {
if(orgId.equals(org.getId())) return org;
}
LOG.error("Requested OrgName for unknown orgId: " + orgId);
return null;
}
/**
* The actual App-ID based on the AppName. Lazy implementation.
* @param appName the name of the application
* @return the application object
* @throws AppException if allApps can't be read from API-Manager
*/
public ClientApplication getApplication(String appName) throws AppException {
List foundApps = new ArrayList();
if(allApps==null) getAllApps();
String orgId = null;
if(appName.contains("|")) {
orgId = getOrgId(appName.substring(appName.indexOf("|")+1));
appName = appName.substring(0, appName.indexOf("|"));
}
for(ClientApplication app : allApps) {
if(appName.equals(app.getName())) {
if(orgId!=null && !orgId.equals(app.getOrganizationId())) continue;
foundApps.add(app);
}
}
if(foundApps.size()==0) {
LOG.error("Requested AppId for unknown appName: " + appName);
return null;
} else if (foundApps.size()>1) {
ErrorState.getInstance().setError("The given application-name: '"+appName+"' doesn't resolve to a unique application. "
+ "You may add the organization name using format: 'appname|orgname' or use one of the application credentials.", ErrorCode.APP_NAME_IS_NOT_UNIQUE, false);
throw new AppException("The given application-name: '"+appName+"' doesn't resolve to a unique application. ", ErrorCode.APP_NAME_IS_NOT_UNIQUE);
}
LOG.debug("Configured app with name: '"+appName+"' found. ID: '"+foundApps.get(0)+"'");
return foundApps.get(0);
}
/**
* The actual App-ID based on the AppName. Lazy implementation.
* @param appId unique ID for the application
* @return the id of the organization
*/
public static ClientApplication getAppForId(String appId) {
for(ClientApplication app : allApps) {
if(appId.equals(app.getId())) return app;
}
LOG.error("Requested Application for unknown appId: "+appId+" not found.");
return null;
}
/**
* The actual App-ID based on the AppName. Lazy implementation.
* @param credential The credentials (API-Key, Client-ID) which is registered for an application
* @param type of the credential. See APIManagerAdapter for potential credential types
* @return the id of the organization
* @throws AppException if JSON response from API-Manager can't be parsed
*/
public ClientApplication getAppIdForCredential(String credential, String type) throws AppException {
if(clientCredentialToAppMap.containsKey(type+"_"+credential)) {
ClientApplication app = clientCredentialToAppMap.get(type+"_"+credential);
LOG.info("Found existing application (in cache): '"+app.getName()+"' based on credential (Type: '"+type+"'): '"+credential+"'");
return app;
}
getAllApps(); // Make sure, we loaded all apps before!
LOG.debug("Searching credential (Type: "+type+"): '"+credential+"' in: " + allApps.size() + " apps.");
Collection appIds = clientCredentialToAppMap.values();
HttpResponse httpResponse = null;
for(ClientApplication app : allApps) {
if(appIds.contains(app)) continue;
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/applications/"+app.getId()+"/"+type+"").build();
LOG.debug("Loading credentials of type: '" + type + "' for application: '" + app.getName() + "' from API-Manager.");
RestAPICall getRequest = new GETRequest(uri, null, true);
httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
LOG.trace("Response: " + response);
JsonNode clientIds = mapper.readTree(response);
if(clientIds.size()==0) {
LOG.debug("No credentials (Type: '"+type+"') found for application: '"+app.getName()+"'");
continue;
}
for(JsonNode clientId : clientIds) {
String key;
if(type.equals(CREDENTIAL_TYPE_API_KEY)) {
key = clientId.get("id").asText();
} else if(type.equals(CREDENTIAL_TYPE_EXT_CLIENTID) || type.equals(CREDENTIAL_TYPE_OAUTH)) {
if(clientId.get("clientId")==null) {
key = "NOT_FOUND";
} else {
key = clientId.get("clientId").asText();
}
} else {
throw new AppException("Unknown credential type: " + type, ErrorCode.UNXPECTED_ERROR);
}
LOG.debug("Found credential (Type: '"+type+"'): '"+key+"' for application: '"+app.getName()+"'");
clientCredentialToAppMap.put(type+"_"+key, app);
if(key.equals(credential)) {
LOG.info("Found existing application: '"+app.getName()+"' ("+app.getId()+") based on credential (Type: '"+type+"'): '"+credential+"'");
return app;
}
}
} catch (Exception e) {
LOG.error("Can't load applications credentials. Can't parse response: " + response);
throw new AppException("Can't load applications credentials.", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
LOG.error("No application found for credential ("+type+"): " + credential);
return null;
}
private void addQuotaConfiguration(IAPI api, IAPI desiredAPI) throws AppException {
// No need to load quota, if not given in the desired API
if(desiredAPI!=null && (desiredAPI.getApplicationQuota() == null && desiredAPI.getSystemQuota() == null)) return;
if(!this.hasAdminAccount) return; // Can't load quota without having an Admin-Account
ActualAPI managerAPI = (ActualAPI)api;
try {
applicationQuotaConfig = getQuotaFromAPIManager(APPLICATION_DEFAULT_QUOTA); // Get the Application-Default-Quota
sytemQuotaConfig = getQuotaFromAPIManager(SYSTEM_API_QUOTA); // Get the System-Default-Quota
managerAPI.setApplicationQuota(getAPIQuota(applicationQuotaConfig, managerAPI.getId()));
managerAPI.setSystemQuota(getAPIQuota(sytemQuotaConfig, managerAPI.getId()));
} catch (AppException e) {
LOG.error("Application-Default quota response: '"+applicationQuotaConfig+"'");
LOG.error("System-Default quota response: '"+sytemQuotaConfig+"'");
throw e;
}
}
private APIQuota getQuotaFromAPIManager(String identifier) throws AppException {
if(!hasAdminAccount()) return null;
ObjectMapper mapper = new ObjectMapper();
URI uri;
HttpResponse httpResponse = null;
try {
if(identifier.equals(APPLICATION_DEFAULT_QUOTA) || identifier.equals(SYSTEM_API_QUOTA)) {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/quotas/"+identifier).build();
} else {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/applications/"+identifier+"/quota/").build();
}
RestAPICall getRequest = new GETRequest(uri, null, true);
httpResponse = getRequest.execute();
int statusCode = httpResponse.getStatusLine().getStatusCode();
if( statusCode == 403){
throw new AppException("Can't get API-Manager Quota-Configuration, User should have API administrator role", ErrorCode.API_MANAGER_COMMUNICATION);
}
if( statusCode != 200){
throw new AppException("Can't get API-Manager Quota-Configuration.", ErrorCode.API_MANAGER_COMMUNICATION);
}
String config = IOUtils.toString(httpResponse.getEntity().getContent(), "UTF-8");
APIQuota quotaConfig = mapper.readValue(config, APIQuota.class);
return quotaConfig;
} catch (URISyntaxException | UnsupportedOperationException | IOException e) {
throw new AppException("Can't get API-Manager Quota-Configuration.", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
private static APIQuota getAPIQuota(APIQuota quotaConfig, String apiId) throws AppException {
List apiRestrictions = new ArrayList();
try {
for(QuotaRestriction restriction : quotaConfig.getRestrictions()) {
if(restriction.getApi().equals(apiId)) {
apiRestrictions.add(restriction);
}
}
if(apiRestrictions.size()==0) return null;
APIQuota apiQuota = new APIQuota();
apiQuota.setDescription(quotaConfig.getDescription());
apiQuota.setName(quotaConfig.getName());
apiQuota.setRestrictions(apiRestrictions);
return apiQuota;
} catch (Exception e) {
throw new AppException("Can't parse quota from API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
}
}
private static APIDefintion getOriginalAPIDefinitionFromAPIM(String backendApiID) throws AppException {
URI uri;
APIDefintion apiDefinition;
HttpResponse httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/apirepo/"+backendApiID+"/download")
.setParameter("original", "true").build();
RestAPICall getRequest = new GETRequest(uri, null);
httpResponse=getRequest.execute();
String res = EntityUtils.toString(httpResponse.getEntity(),StandardCharsets.UTF_8);
apiDefinition = new APIDefintion(res.getBytes(StandardCharsets.UTF_8));
if(httpResponse.containsHeader("Content-Disposition")) {
String origFilename = httpResponse.getHeaders("Content-Disposition")[0].getValue();
apiDefinition.setAPIDefinitionFile(origFilename.substring(origFilename.indexOf("filename=")+9));
}
return apiDefinition;
} catch (Exception e) {
throw new AppException("Can't read Swagger-File.", ErrorCode.CANT_READ_API_DEFINITION_FILE, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
private static APIImage getAPIImageFromAPIM(String backendApiID) throws AppException {
APIImage image = new APIImage();
URI uri;
HttpResponse httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/proxies/"+backendApiID+"/image").build();
RestAPICall getRequest = new GETRequest(uri, null);
httpResponse = getRequest.execute();
if(httpResponse == null || httpResponse.getEntity() == null) return null; // no Image found in API-Manager
InputStream is = httpResponse.getEntity().getContent();
image.setImageContent(IOUtils.toByteArray(is));
image.setBaseFilename("api-image");
if(httpResponse.containsHeader("Content-Type")) {
String contentType = httpResponse.getHeaders("Content-Type")[0].getValue();
image.setContentType(contentType);
}
return image;
} catch (Exception e) {
throw new AppException("Can't read Image from API-Manager.", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
public static String getApiManagerVersion() throws AppException {
if(APIManagerAdapter.apiManagerVersion!=null) {
return apiManagerVersion;
}
APIManagerAdapter.apiManagerVersion = getApiManagerConfig("productVersion");
LOG.info("API-Manager version is: " + apiManagerVersion);
return APIManagerAdapter.apiManagerVersion;
}
/**
* Lazy helper method to get the actual API-Manager version. This is used to toggle on/off some
* of the features (such as API-Custom-Properties)
* @return the API-Manager version as returned from the API-Manager REST-API /config endpoint
* @param configField name of the configField from API-Manager
* @throws AppException is something goes wrong.
*/
public static String getApiManagerConfig(String configField) throws AppException {
ObjectMapper mapper = new ObjectMapper();
boolean useAdmin = (configFieldRequiresAdmin.containsKey(configField)) ? true : false;
String managerConfig = apiManagerConfig.get(useAdmin);
URI uri;
HttpResponse httpResponse = null;
try {
if(managerConfig==null) {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/config").build();
RestAPICall getRequest = new GETRequest(uri, null, useAdmin);
httpResponse = getRequest.execute();
managerConfig = EntityUtils.toString(httpResponse.getEntity());
}
JsonNode jsonResponse;
jsonResponse = mapper.readTree(managerConfig);
JsonNode retrievedConfigField = jsonResponse.get(configField);
if(retrievedConfigField==null) {
LOG.debug("Config field: '"+configField+"' is unsuporrted!");
return "UnknownConfigField"+configField;
}
apiManagerConfig.put(useAdmin, managerConfig);
return retrievedConfigField.asText();
} catch (Exception e) {
LOG.error("Error AppInfo from API-Manager. Can't parse response: " + managerConfig);
throw new AppException("Can't get "+configField+" from API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
public static List getAPIAccess(String id, String type) throws AppException {
List allApiAccess = new ArrayList();
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
HttpResponse httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/"+type+"/"+id+"/apis").build();
RestAPICall getRequest = new GETRequest(uri, null, hasAdminAccount());
httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
allApiAccess = mapper.readValue(response, new TypeReference>(){});
return allApiAccess;
} catch (Exception e) {
LOG.error("Error cant load API-Access for "+type+" from API-Manager. Can't parse response: " + response);
throw new AppException("API-Access for "+type+" from API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
private List getSubscribedApps(String apiId) throws AppException {
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
HttpResponse httpResponse = null;
if(!APIManagerAdapter.hasAPIManagerVersion("7.7")) {
throw new AppException("API-Manager: " + apiManagerVersion + " doesn't support /proxies//applications", ErrorCode.UNXPECTED_ERROR);
}
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/proxies/"+apiId+"/applications").build();
RestAPICall getRequest = new GETRequest(uri, null, hasAdminAccount);
httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
List subscribedApps = mapper.readValue(response, new TypeReference>(){});
return subscribedApps;
} catch (Exception e) {
LOG.error("Error cant load subscribes applications from API-Manager. Can't parse response: " + response);
throw new AppException("Error cant load subscribes applications from API-Manager.", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
public List getAllOrgs() throws AppException {
if(!hasAdminAccount) {
LOG.error("Using OrgAdmin only to load all organizations.");
}
if(APIManagerAdapter.allOrgs!=null) {
return APIManagerAdapter.allOrgs;
}
allOrgs = new ArrayList();
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
HttpResponse httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/organizations").build();
RestAPICall getRequest = new GETRequest(uri, null, hasAdminAccount);
httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
allOrgs = mapper.readValue(response, new TypeReference>(){});
return allOrgs;
} catch (Exception e) {
LOG.error("Error cant read all orgs from API-Manager. Can't parse response: " + response);
throw new AppException("Can't read all orgs from API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
public List getAllAPIs() throws AppException {
if(!hasAdminAccount) {
LOG.error("Cant load all APIs without an Admin-Account.");
return null;
}
if(APIManagerAdapter.allAPIs!=null) {
return APIManagerAdapter.allAPIs;
}
allAPIs = new ArrayList();
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
HttpResponse httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/proxies").build();
RestAPICall getRequest = new GETRequest(uri, null, true);
httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
allAPIs = mapper.readValue(response, new TypeReference>(){});
return allAPIs;
} catch (Exception e) {
LOG.error("Error cant read all APIs from API-Manager. Can't parse response: " + response);
throw new AppException("Can't read all APIs from API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
public List getAllApps() throws AppException {
if(!hasAdminAccount) {
LOG.trace("Using OrgAdmin to load all applications.");
}
if(APIManagerAdapter.allApps!=null) {
LOG.trace("Not reloading existing apps from API-Manager. Number of apps: " + APIManagerAdapter.allApps.size());
return APIManagerAdapter.allApps;
}
LOG.debug("Loading existing apps from API-Manager.");
allApps = new ArrayList();
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
HttpResponse httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/applications").build();
RestAPICall getRequest = new GETRequest(uri, null, hasAdminAccount);
httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
allApps = mapper.readValue(response, new TypeReference>(){});
LOG.debug("Loaded: " + allApps.size() + " apps from API-Manager.");
return allApps;
} catch (Exception e) {
LOG.error("Error cant read all applications from API-Manager. Can't parse response: " + response);
throw new AppException("Can't read all applications from API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
public void setAllApps(List allApps) throws AppException {
APIManagerAdapter.allApps = allApps;
}
public static List getOrgsApiAccess(String orgId, boolean forceReload) throws AppException {
if(!forceReload && orgsApiAccess.containsKey(orgId)) {
return orgsApiAccess.get(orgId);
}
ObjectMapper mapper = new ObjectMapper();
String response = null;
URI uri;
List apiAccess;
HttpResponse httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/organizations/"+orgId+"/apis").build();
RestAPICall getRequest = new GETRequest(uri, null, true);
httpResponse = getRequest.execute();
response = EntityUtils.toString(httpResponse.getEntity());
apiAccess = mapper.readValue(response, new TypeReference>(){});
orgsApiAccess.put(orgId, apiAccess);
return apiAccess;
} catch (Exception e) {
LOG.error("Error cant read API-Access for org: "+orgId+" from API-Manager. Can't parse response: " + response);
throw new AppException("Error cant read API-Access for org: "+orgId+" from API-Manager", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
public static JsonNode getCustomPropertiesConfig() throws AppException {
String appConfig = null;
URI uri;
HttpEntity httpResponse = null;
try {
uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath("/vordel/apiportal/app/app.config").build();
RestAPICall getRequest = new GETRequest(uri, null);
httpResponse = getRequest.execute().getEntity();
appConfig = IOUtils.toString(httpResponse.getContent(), "UTF-8");
return parseAppConfig(appConfig);
} catch (Exception e) {
throw new AppException("Can't read app.config from API-Manager: '" + appConfig + "'", ErrorCode.API_MANAGER_COMMUNICATION, e);
} finally {
try {
if(httpResponse!=null)
((CloseableHttpResponse)httpResponse).close();
} catch (Exception ignore) {}
}
}
/**
* Helper method to validate that configured Custom-Properties are really configured
* in the API-Manager configuration. void translateMethodIds(Map profiles, IAPI actualAPI) throws AppException {
translateMethodIds(profiles, actualAPI, false);
}
public void translateMethodIds(Map profiles, IAPI actualAPI, boolean toMethodnames) throws AppException {
Map updatedEntries = new LinkedHashMap();
if(profiles!=null) {
List methods = null;
Iterator keys = profiles.keySet().iterator();
while(keys.hasNext()) {
String key = keys.next();
if(key.equals("_default")) continue;
if(methods==null) methods = getAllMethodsForAPI(actualAPI.getId());
for(APIMethod method : methods) {
if(toMethodnames) {
if(method.getId().equals(key)) { // Look for the methodId
profile value = profiles.get(key);
if(value instanceof OutboundProfile) {
((OutboundProfile)value).setApiMethodId(method.getName()); // Put the name as the ID!
((OutboundProfile)value).setApiId(method.getApiId());
}
updatedEntries.put(method.getName(), value);
keys.remove();
break;
}
} else {
if(method.getName().equals(key)) {
profile value = profiles.get(key);
if(value instanceof OutboundProfile) {
((OutboundProfile)value).setApiMethodId(method.getApiMethodId());
((OutboundProfile)value).setApiId(method.getApiId());
}
updatedEntries.put(method.getId(), profiles.get(key));
keys.remove();
break;
}
}
}
}
profiles.putAll(updatedEntries);
}
}
/**
* @return true, when admin credentials are provided
* @throws AppException when the API-Manager instance is not initialized
*/
public static boolean hasAdminAccount() throws AppException {
return APIManagerAdapter.getInstance().hasAdminAccount;
}
/**
* @return true, if an OrgAdmin is the primary user (additional Admin-Credentials may have provided anyway)
*/
public boolean isUsingOrgAdmin() {
return usingOrgAdmin;
}
}
