Some refactoring of the examples to make them cleaner, moved settings out of constants and into a new config.properties file, added a basic query example and an example that shows how to query an aspect, split out the like and comment example from the create document example and put those in their own classes, moved the API key and API secret into the config.properties file.

Author: jpotts

alfresco-api-examples/README.md

@@ -15,19 +15,19 @@ from BaseOnPremExample.
 Before running against either cloud or on-premise
 =================================================
 
-In BasePublicAPIExample.java, set SITE to a test site ID in which you can
+Edit config.properties. Set site to a test site ID in which you can
 create and delete folders and documents.
 
-If you are running CmisCreateDocumentExample or CmisAspectExample, set the
-constants in those classes to match your environment.
+If you are running CmisCreateDocumentExample or CmisGeographicAspectExample, set the
+folder_name, local_file_path, and local_file_type properties.
 
 Before running against Alfresco in the cloud
 ============================================
 
-Before running these examples you must first register at:
+Before running these examples against Alfresco in the cloud you must first register at:
 https://developer.alfresco.com
 
-Add your auth key and secret to OAuth2ClientCredentials.java.
+Add your API key and secret to config.properties.
 
 In your application profile on developer.alfresco.com, you must set
 your callback URL to http://127.0.0.1:8080/Callback.
@@ -38,9 +38,4 @@ you must make the appropriate change to LocalServerReceiver.java.
 Before running against Alfresco on-premise
 ==========================================
 
-In BaseOnPremExample.java, set these to match your environment:
-
- * ALFRESCO_API_URL: May need to adjust hostname and port number.
- * USER_NAME: Use a username that has an account in Alfresco with access to the
-SITE you specified earlier.
- * PASSWORD: Password for that account.
+Edit host, username, and password.

alfresco-api-examples/config.properties

@@ -0,0 +1,19 @@
+#Change this to the ID of a site in which you have collaborator access.
+site=alfresco-api-demo
+
+# Specify a folder to create in the root of the test site
+folder_name=test folder
+
+# Specify a test file and type
+local_file_path=/users/jpotts/Documents/sample/sample-a.pdf
+local_file_type=application/pdf
+	
+# ON-PREMISE ONLY
+host=http://localhost:8080/alfresco
+username=admin
+password=admin
+
+# CLOUD ONLY
+# Register for your API key and secret at http://www.alfresco.com/develop
+api_key=PUT YOURS HERE
+api_secret=PUT YOURS HERE

alfresco-api-examples/src/main/java/com/alfresco/api/example/BaseCloudExample.java

@@ -17,8 +17,8 @@
 import org.apache.chemistry.opencmis.commons.enums.BindingType;
 
 import com.alfresco.api.example.oauth.LocalServerReceiver;
-import com.alfresco.api.example.oauth.OAuth2ClientCredentials;
 import com.alfresco.api.example.oauth.VerificationCodeReceiver;
+import com.alfresco.api.example.util.Config;
 import com.google.api.client.auth.oauth2.AuthorizationCodeFlow;
 import com.google.api.client.auth.oauth2.AuthorizationCodeRequestUrl;
 import com.google.api.client.auth.oauth2.BearerToken;
@@ -43,21 +43,27 @@
  */
 public class BaseCloudExample extends BasePublicAPIExample {
 
+	public static final String CMIS_URL = "cmis/versions/1.0/atom";
 	public static final HttpTransport HTTP_TRANSPORT = new NetHttpTransport();
 	public static final JsonFactory JSON_FACTORY = new JacksonFactory();
 
 	public static final String ALFRESCO_API_URL = "https://api.alfresco.com/";
 
 	public static final String TOKEN_SERVER_URL = ALFRESCO_API_URL + "auth/oauth/versions/2/token";
 	public static final String AUTHORIZATION_SERVER_URL = ALFRESCO_API_URL + "auth/oauth/versions/2/authorize";
-	private static final String SCOPE = "public_api";
-	private static final List<String> SCOPES = Arrays.asList(SCOPE);
+	public static final String SCOPE = "public_api";
+	public static final List<String> SCOPES = Arrays.asList(SCOPE);
 
 	private HttpRequestFactory requestFactory;
 	private Credential credential;
+	private Session cmisSession;
+
+	public String getAlfrescoAPIUrl() {
+		return ALFRESCO_API_URL;
+	}
 
 	public String getAtomPubURL() {
-		return ALFRESCO_API_URL + "cmis/versions/1.0/atom";
+		return ALFRESCO_API_URL + CMIS_URL;
 	}
 
 	public void launchInBrowser(
@@ -95,7 +101,7 @@ public HttpRequestFactory getRequestFactory() {
 			VerificationCodeReceiver receiver = new LocalServerReceiver();
 		    try {
 		    	String redirectUri = receiver.getRedirectUri();
-		    	launchInBrowser("google-chrome", redirectUri, OAuth2ClientCredentials.CLIENT_ID, SCOPE);
+		    	launchInBrowser("google-chrome", redirectUri, BaseCloudExample.getAPIKey(), SCOPE);
 		    	this.credential = authorize(receiver, redirectUri);
 
 		    	this.requestFactory = HTTP_TRANSPORT.createRequestFactory(new HttpRequestInitializer() {
@@ -130,8 +136,8 @@ public Credential authorize(VerificationCodeReceiver receiver, String redirectUr
 			        JSON_FACTORY,
 			        new GenericUrl(TOKEN_SERVER_URL),
 			        new ClientParametersAuthentication(
-			            OAuth2ClientCredentials.CLIENT_ID, OAuth2ClientCredentials.CLIENT_SECRET),
-			        OAuth2ClientCredentials.CLIENT_ID,
+			            BaseCloudExample.getAPIKey(), BaseCloudExample.getAPISecret()),
+			        BaseCloudExample.getAPIKey(),
 			        AUTHORIZATION_SERVER_URL).setScopes(SCOPES).build();
 
 			TokenResponse response = codeFlow.newTokenRequest(code)
@@ -148,23 +154,26 @@ public Credential authorize(VerificationCodeReceiver receiver, String redirectUr
 	 * @return Session
 	 */
 	public Session getCmisSession() {
-		String accessToken = getCredential().getAccessToken();
-		System.out.println("Access token:" + accessToken);
-		
-		// default factory implementation
-		SessionFactory factory = SessionFactoryImpl.newInstance();
-		Map<String, String> parameter = new HashMap<String, String>();
-
-		// connection settings
-		parameter.put(SessionParameter.ATOMPUB_URL, this.getAtomPubURL());
-		parameter.put(SessionParameter.BINDING_TYPE, BindingType.ATOMPUB.value());
-		parameter.put(SessionParameter.AUTH_HTTP_BASIC, "false");
-		parameter.put(SessionParameter.HEADER + ".0", "Authorization: Bearer " + accessToken);
-		parameter.put(SessionParameter.OBJECT_FACTORY_CLASS, "org.alfresco.cmis.client.impl.AlfrescoObjectFactoryImpl");
-
-		List<Repository> repositories = factory.getRepositories(parameter);
-
-		return repositories.get(0).createSession();
+		if (cmisSession == null) {
+			String accessToken = getCredential().getAccessToken();
+			System.out.println("Access token:" + accessToken);
+			
+			// default factory implementation
+			SessionFactory factory = SessionFactoryImpl.newInstance();
+			Map<String, String> parameter = new HashMap<String, String>();
+	
+			// connection settings
+			parameter.put(SessionParameter.ATOMPUB_URL, this.getAtomPubURL());
+			parameter.put(SessionParameter.BINDING_TYPE, BindingType.ATOMPUB.value());
+			parameter.put(SessionParameter.AUTH_HTTP_BASIC, "false");
+			parameter.put(SessionParameter.HEADER + ".0", "Authorization: Bearer " + accessToken);
+			parameter.put(SessionParameter.OBJECT_FACTORY_CLASS, "org.alfresco.cmis.client.impl.AlfrescoObjectFactoryImpl");
+	
+			List<Repository> repositories = factory.getRepositories(parameter);
+	
+			cmisSession = repositories.get(0).createSession();
+		}
+		return cmisSession;
 	}
 
 	public Credential getCredential() {
@@ -174,4 +183,11 @@ public Credential getCredential() {
 		return this.credential;
 	}
 
+	public static String getAPIKey() {
+		return Config.getConfig().getProperty("api_key");
+	}
+	
+	public static String getAPISecret() {
+		return Config.getConfig().getProperty("api_secret");
+	}
 }

alfresco-api-examples/src/main/java/com/alfresco/api/example/BaseOnPremExample.java

@@ -12,6 +12,7 @@
 import org.apache.chemistry.opencmis.commons.SessionParameter;
 import org.apache.chemistry.opencmis.commons.enums.BindingType;
 
+import com.alfresco.api.example.util.Config;
 import com.google.api.client.http.HttpRequest;
 import com.google.api.client.http.HttpRequestFactory;
 import com.google.api.client.http.HttpRequestInitializer;
@@ -32,23 +33,24 @@ public class BaseOnPremExample extends BasePublicAPIExample {
 	/**
 	 * Change these to match your environment
 	 */
-	public static final String ALFRESCO_API_URL = "http://localhost:8080/alfresco/api/";
-	public static final String USER_NAME = "admin";
-	public static final String PASSWORD = "admin";
+	//public static final String CMIS_URL = "/public/cmis/versions/1.0/atom";
+	public static final String CMIS_URL = "/public/cmis/versions/1.1/atom";
 
 	public static final HttpTransport HTTP_TRANSPORT = new NetHttpTransport();
 	public static final JsonFactory JSON_FACTORY = new JacksonFactory();
 
 	private HttpRequestFactory requestFactory;
+	private Session cmisSession;
 
 	public String getAtomPubURL(HttpRequestFactory requestFactory) {
+		String alfrescoAPIUrl = getAlfrescoAPIUrl();
 		String atomPubURL = null;
 
 		try {
-			atomPubURL = ALFRESCO_API_URL + getHomeNetwork(ALFRESCO_API_URL, requestFactory) + "/public/cmis/versions/1.0/atom";
+			atomPubURL = alfrescoAPIUrl + getHomeNetwork() + CMIS_URL;
 		} catch (IOException ioe) {
 			System.out.println("Warning: Couldn't determine home network, defaulting to -default-");
-			atomPubURL = ALFRESCO_API_URL + "-default-" + "/public/cmis/versions/1.0/atom";
+			atomPubURL = alfrescoAPIUrl + "-default-" + CMIS_URL;
 		}
 
 		return atomPubURL;
@@ -60,21 +62,24 @@ public String getAtomPubURL(HttpRequestFactory requestFactory) {
 	 * @return Session
 	 */
 	public Session getCmisSession() {
-		// default factory implementation
-		SessionFactory factory = SessionFactoryImpl.newInstance();
-		Map<String, String> parameter = new HashMap<String, String>();
-
-		// connection settings
-		parameter.put(SessionParameter.ATOMPUB_URL, getAtomPubURL(getRequestFactory()));
-		parameter.put(SessionParameter.BINDING_TYPE, BindingType.ATOMPUB.value());
-		parameter.put(SessionParameter.AUTH_HTTP_BASIC, "true");
-		parameter.put(SessionParameter.USER, USER_NAME);
-		parameter.put(SessionParameter.PASSWORD, PASSWORD);
-		parameter.put(SessionParameter.OBJECT_FACTORY_CLASS, "org.alfresco.cmis.client.impl.AlfrescoObjectFactoryImpl");
-
-		List<Repository> repositories = factory.getRepositories(parameter);
-
-		return repositories.get(0).createSession();
+		if (cmisSession == null) {
+			// default factory implementation
+			SessionFactory factory = SessionFactoryImpl.newInstance();
+			Map<String, String> parameter = new HashMap<String, String>();
+	
+			// connection settings
+			parameter.put(SessionParameter.ATOMPUB_URL, getAtomPubURL(getRequestFactory()));
+			parameter.put(SessionParameter.BINDING_TYPE, BindingType.ATOMPUB.value());
+			parameter.put(SessionParameter.AUTH_HTTP_BASIC, "true");
+			parameter.put(SessionParameter.USER, getUsername());
+			parameter.put(SessionParameter.PASSWORD, getPassword());
+			parameter.put(SessionParameter.OBJECT_FACTORY_CLASS, "org.alfresco.cmis.client.impl.AlfrescoObjectFactoryImpl");
+	
+			List<Repository> repositories = factory.getRepositories(parameter);
+	
+			cmisSession = repositories.get(0).createSession();
+		}
+		return this.cmisSession;
 	}
 
 	/**
@@ -88,10 +93,24 @@ public HttpRequestFactory getRequestFactory() {
     			@Override
     			public void initialize(HttpRequest request) throws IOException {
     				request.setParser(new JsonObjectParser(new JacksonFactory()));
-    				request.getHeaders().setBasicAuthentication(USER_NAME, PASSWORD);
+    				request.getHeaders().setBasicAuthentication(getUsername(), getPassword());
     			}
     		});
 		}
 		return this.requestFactory;	
 	}
+	
+	public String getAlfrescoAPIUrl() {
+		String host = Config.getConfig().getProperty("host"); 
+		return host + "/api/"; 		
+	}
+
+	public String getUsername() {
+		return Config.getConfig().getProperty("username"); 
+	}
+
+	public String getPassword() {
+		return Config.getConfig().getProperty("password");		 		
+	}
+
 }