#44 Added support to filter applications based on their credentials

Author: Chris Wiechmann

modules/apim-adapter/src/main/java/com/axway/apim/adapter/clientApps/APIMgrAppsAdapter.java

@@ -4,6 +4,7 @@
 import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -124,9 +125,9 @@ URI getApplicationsUri(ClientAppFilter filter) throws URISyntaxException {
 
 	public List<ClientApplication> getApplications(ClientAppFilter filter, boolean logProgress) throws AppException {
 		readApplicationsFromAPIManager(filter);
-		List<ClientApplication> apps;
+		List<ClientApplication> filteredApps = new ArrayList<ClientApplication>();
 		try {
-			apps = mapper.readValue(this.apiManagerResponse.get(filter), new TypeReference<List<ClientApplication>>(){});
+			List<ClientApplication> apps = mapper.readValue(this.apiManagerResponse.get(filter), new TypeReference<List<ClientApplication>>(){});
 			LOG.debug("Found: "+apps.size() + " applications");
 			for(int i=0; i<apps.size();i++) {
 				ClientApplication app = apps.get(i);
@@ -136,14 +137,16 @@ public List<ClientApplication> getApplications(ClientAppFilter filter, boolean l
 				}
 				addApplicationCredentials(app, filter.isIncludeCredentials());
 				addAPIAccess(app, filter.isIncludeAPIAccess());
+				if(!filter.filter(app)) continue;
+				filteredApps.add(app);
 				if(logProgress && apps.size()>5) Utils.progressPercentage(i, apps.size(), "Laoding "+apps.size()+" Applications");
 			}
 			if(logProgress && apps.size()>5) System.out.print("\n");
 		} catch (Exception e) {
 			throw new AppException("Can't initialize API-Manager API-Representation.", ErrorCode.API_MANAGER_COMMUNICATION, e);
 		}
 
-		return apps;
+		return filteredApps;
 	}
 
 	public List<ClientApplication> getAllApplications(boolean logProgress) throws AppException {

modules/apim-adapter/src/main/java/com/axway/apim/adapter/clientApps/ClientAppFilter.java

@@ -2,6 +2,8 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 import org.apache.commons.lang.StringUtils;
 import org.apache.http.NameValuePair;
@@ -11,6 +13,12 @@
 
 import com.axway.apim.adapter.APIManagerAdapter;
 import com.axway.apim.api.model.Organization;
+import com.axway.apim.api.model.User;
+import com.axway.apim.api.model.apps.APIKey;
+import com.axway.apim.api.model.apps.ClientAppCredential;
+import com.axway.apim.api.model.apps.ClientApplication;
+import com.axway.apim.api.model.apps.ExtClients;
+import com.axway.apim.api.model.apps.OAuth;
 import com.axway.apim.lib.errorHandling.AppException;
 import com.axway.apim.lib.errorHandling.ErrorCode;
 import com.axway.apim.lib.errorHandling.ErrorState;
@@ -27,13 +35,17 @@ public class ClientAppFilter {
 
 	boolean includeImage;
 
-	String applicationName;
+	private String credential;
 
-	String state;
+	private String redirectUrl;
 
-	Organization organization;
+	private String applicationName;
 
-	String applicationId;
+	private String state;
+	
+	private Organization organization;
+	
+	private String applicationId;
 
 	List<NameValuePair> filters = new ArrayList<NameValuePair>();
 
@@ -55,6 +67,22 @@ public boolean isIncludeAPIAccess() {
 		return includeAPIAccess;
 	}
 
+	public void setIncludeQuota(boolean includeQuota) {
+		this.includeQuota = includeQuota;
+	}
+
+	public void setIncludeCredentials(boolean includeCredentials) {
+		this.includeCredentials = includeCredentials;
+	}
+
+	public void setIncludeAPIAccess(boolean includeAPIAccess) {
+		this.includeAPIAccess = includeAPIAccess;
+	}
+
+	public void setIncludeImage(boolean includeImage) {
+		this.includeImage = includeImage;
+	}
+
 	public String getApplicationId() {
 		return applicationId;
 	}
@@ -98,7 +126,21 @@ public void setApplicationId(String applicationId) {
 		this.applicationId = applicationId;
 	}
 
+	public String getCredential() {
+		return credential;
+	}
+
+	public void setCredential(String credential) {
+		this.credential = credential;
+	}
+
+	public String getRedirectUrl() {
+		return redirectUrl;
+	}
 
+	public void setRedirectUrl(String redirectUrl) {
+		this.redirectUrl = redirectUrl;
+	}
 
 	public void setState(String state) {
 		if(state==null) return;
@@ -151,29 +193,76 @@ public String toString() {
 		}
 	}
 
+	public boolean filter(ClientApplication app) throws AppException {
+		if(this.getCredential()==null && this.getRedirectUrl()==null) { // Nothing given to filter out.
+			return true;
+		}
+		boolean match = false;
+		for(ClientAppCredential cred : app.getCredentials()) {
+			switch(cred.getCredentialType()) {
+			case "oauth":
+				match = filterCredential(((OAuth)cred).getClientId(), ((OAuth)cred).getRedirectUrls());
+				break;
+			case "extclients":
+				match = filterCredential(((ExtClients)cred).getClientId(), null);
+				break;
+			case "apikeys":
+				match = filterCredential(((APIKey)cred).getApiKey(), null);
+				break;
+			}
+			if(match) break;
+		}
+		return match;
+	}
+	
+	private boolean filterCredential(String appCredential, String[] appRedirectUrls) {
+		if(this.credential!=null) {
+			Pattern pattern = Pattern.compile(this.credential.replace("*", ".*"));
+			Matcher matcher = pattern.matcher(appCredential);
+			if(!matcher.matches()) return false;
+		}
+		if(this.redirectUrl!=null) {
+			if(appRedirectUrls==null || appRedirectUrls.length==0) return false;
+			Pattern pattern = Pattern.compile(this.redirectUrl.replace("*", ".*"));
+			boolean redirectUrlMatch = false;
+			for(String appRedirectUrl : appRedirectUrls) {
+				Matcher matcher = pattern.matcher(appRedirectUrl);
+				if(matcher.matches()) {
+					redirectUrlMatch = true;
+					break;
+				}
+			}
+			if(!redirectUrlMatch) return false;
+		}
+		return true;
+	}
 
 
 	/**
 	 * Build an applicationAdapter based on the given configuration
 	 */
 	public static class Builder {
 
-		boolean includeQuota;
+		private boolean includeQuota;
 
-		boolean includeCredentials;
+		private boolean includeCredentials;
 
-		boolean includeImage;
+		private boolean includeImage;
 
-		boolean includeAPIAccess;
+		private boolean includeAPIAccess;
 
-		Organization organization;
+		private Organization organization;
 
 		/** The name of the application */
-		String applicationName;
+		private String applicationName;
 
-		String applicationId;
+		private String applicationId;
 
-		String state;
+		private String state;
+		
+		private String credential;
+		
+		private String redirectUrl;
 
 		public Builder() {
 			super();
@@ -189,10 +278,12 @@ public ClientAppFilter build() {
 			filter.setApplicationName(this.applicationName);
 			filter.setOrganization(this.organization);
 			filter.setState(this.state);
-			filter.includeQuota = this.includeQuota;
-			filter.includeCredentials = this.includeCredentials;
-			filter.includeImage = this.includeImage;
-			filter.includeAPIAccess = this.includeAPIAccess;
+			filter.setIncludeQuota(this.includeQuota);
+			filter.setIncludeCredentials(this.includeCredentials);
+			filter.setIncludeImage(this.includeImage);
+			filter.setIncludeAPIAccess(this.includeAPIAccess);
+			filter.setCredential(this.credential);
+			filter.setRedirectUrl(this.redirectUrl);
 			return filter;
 		}
 
@@ -240,6 +331,16 @@ public Builder hasState(String state) {
 			return this;
 		}
 
+		public Builder hasCredential(String credential) {
+			this.credential = credential;
+			return this;
+		}
+		
+		public Builder hasRedirectUrl(String redirectUrl) {
+			this.redirectUrl = redirectUrl;
+			return this;
+		}
+		
 		public Builder includeQuotas(boolean includeQuota) {
 			this.includeQuota = includeQuota;
 			return this;

modules/apim-adapter/src/main/java/com/axway/apim/adapter/user/UserFilter.java

@@ -1,7 +1,6 @@
 package com.axway.apim.adapter.user;
 
 import java.util.ArrayList;
-import java.util.Iterator;
 import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -10,8 +9,6 @@
 import org.apache.http.NameValuePair;
 import org.apache.http.message.BasicNameValuePair;
 
-import com.axway.apim.api.model.OutboundProfile;
-import com.axway.apim.api.model.Policy;
 import com.axway.apim.api.model.User;
 import com.axway.apim.lib.errorHandling.AppException;
 
@@ -188,7 +185,6 @@ public boolean filter(User user) throws AppException {
 		if(this.getType()==null && this.getOrganizationName()==null) { // Nothing given to filter out.
 			return true;
 		}
-		// Before 7.7, we have to filter out APIs manually!
 		if(this.getType()!=null && !this.getType().equals(user.getType())) {
 			return false;
 		}

modules/app-export/src/main/java/com/axway/apim/appexport/impl/ApplicationExporter.java

@@ -7,6 +7,7 @@
 import org.slf4j.LoggerFactory;
 
 import com.axway.apim.adapter.clientApps.ClientAppFilter;
+import com.axway.apim.adapter.clientApps.ClientAppFilter.Builder;
 import com.axway.apim.api.model.apps.ClientApplication;
 import com.axway.apim.appexport.lib.AppExportParams;
 import com.axway.apim.lib.errorHandling.AppException;
@@ -59,4 +60,17 @@ public boolean hasError() {
 	}
 
 	public abstract ClientAppFilter getFilter() throws AppException;
+	
+	protected Builder getBaseFilterBuilder() throws AppException {
+		Builder builder = new ClientAppFilter.Builder()
+				.hasState(params.getAppState())
+				.hasName(params.getAppName())
+				.hasId(params.getAppId())
+				.hasCredential(params.getCredential())
+				.hasRedirectUrl(params.getRedirectUrl())
+				.hasOrganizationName(params.getOrgName())
+				.includeImage(false);
+		if(params.getCredential()!=null || params.getRedirectUrl()!=null) builder.includeCredentials(true);
+		return builder;
+	}
 }

modules/app-export/src/main/java/com/axway/apim/appexport/impl/ConsoleAppExporter.java

@@ -63,23 +63,18 @@ private boolean hasAppQuota(ClientApplication app) {
 
 	@Override
 	public ClientAppFilter getFilter() throws AppException {
-		Builder builder = new ClientAppFilter.Builder()
-				.hasState(AppExportParams.getInstance().getAppState())
-				.hasName(AppExportParams.getInstance().getAppName())
-				.hasId(AppExportParams.getInstance().getAppId())
-				.hasOrganizationName(AppExportParams.getInstance().getOrgName())
-				.includeImage(false);
+		Builder builder = getBaseFilterBuilder();
 
 		switch(params.getWide()) {
 		case standard:
 			builder.includeQuotas(false);
-			builder.includeCredentials(false);
+			if(params.getCredential()==null && params.getRedirectUrl()==null) builder.includeCredentials(false);
 			builder.includeAPIAccess(false);
 			break;
 		case wide:
 		case ultra:
 			builder.includeQuotas(true);
-			builder.includeCredentials(true);
+			if(params.getCredential()==null && params.getRedirectUrl()==null) builder.includeCredentials(true);
 			builder.includeAPIAccess(true);
 			break;
 		}

modules/app-export/src/main/java/com/axway/apim/appexport/impl/JsonApplicationExporter.java

@@ -118,11 +118,7 @@ protected void removeApplicationDefaultQuota(ClientApplication app) {
 
 	@Override
 	public ClientAppFilter getFilter() throws AppException {
-		return new ClientAppFilter.Builder()
-				.hasState(AppExportParams.getInstance().getAppState())
-				.hasName(AppExportParams.getInstance().getAppName())
-				.hasId(AppExportParams.getInstance().getAppId())
-				.hasOrganizationName(AppExportParams.getInstance().getOrgName())
+		return getBaseFilterBuilder()
 				.includeQuotas(true)
 				.includeCredentials(true)
 				.includeAPIAccess(true)

modules/app-export/src/main/java/com/axway/apim/appexport/lib/AppExportCLIOptions.java

@@ -30,7 +30,17 @@ public AppExportCLIOptions(String[] args) throws ParseException {
 
 		option = new  Option("orgName", true, "Filter applications to this organization");
 		option.setRequired(false);
-		option.setArgName("Partners");
+		option.setArgName("*Partners*");
+		options.addOption(option);
+		
+		option = new  Option("credential", true, "Filter applications having this credential information. Client-ID and API-Key is considered here.");
+		option.setRequired(false);
+		option.setArgName("*9877979779*");
+		options.addOption(option);
+		
+		option = new  Option("redirectUrl", true, "Filter applications having this Redirect-URL. Only OAuth-Credentials are considered.");
+		option.setRequired(false);
+		option.setArgName("*localhost*");
 		options.addOption(option);
 	}
 
@@ -49,6 +59,8 @@ public void printUsage(String message, String[] args) {
 		System.out.println(getBinaryName()+" api get -s api-env -n \"Client App\" -o json");
 		System.out.println(getBinaryName()+" app get -s api-env -n \"Client App\" -t /tmp/exported_apps -o json -deleteTarget ");
 		System.out.println(getBinaryName()+" app get -s api-env -n \"App 123\" -t /tmp/exported_apps -o json -deleteTarget");
+		System.out.println(getBinaryName()+" app get -s api-env -redirectUrl \"localhost\"");
+		System.out.println(getBinaryName()+" app get -s api-env -credential 16378192");
 		System.out.println();
 		System.out.println("For more information and advanced examples please visit:");
 		System.out.println("https://github.com/Axway-API-Management-Plus/apim-cli/wiki");

modules/app-export/src/main/java/com/axway/apim/appexport/lib/AppExportParams.java

@@ -32,4 +32,12 @@ public String getAppId() {
 	public String getOrgName() {
 		return getValue("orgName");
 	}
+	
+	public String getCredential() {
+		return getValue("credential");
+	}
+	
+	public String getRedirectUrl() {
+		return getValue("redirectUrl");
+	}
 }