CertAuthConnectionStrategy.java

/**
 * Copyright 2015 Anaplan Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License.md file for the specific language governing permissions and
 * limitations under the License.
 */

package com.anaplan.connector.connection;


import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.mule.api.annotations.Connect;
import org.mule.api.annotations.TestConnectivity;
import org.mule.api.annotations.components.ConnectionManagement;
import org.mule.api.annotations.display.Path;
import org.mule.api.annotations.param.ConnectionKey;
import org.mule.api.annotations.param.Default;
import org.mule.api.annotations.param.Optional;


/**
 * Certificate authentication for Anaplan users. The path to the certificate
 * file is required (.cer). If behind proxy, then proxy credentials are also
 * required.
 *
 * NOTE: This is the preferred authentication strategy because in the
 * basic-authentication strategy, Mulesoft stores the password in plain text.
 *
 * @author spondonsaha
 *
 */
@ConnectionManagement(
		friendlyName="Certificate Authentication",
		configElementName="cert-auth-connection")
public class CertAuthConnectionStrategy extends BaseConnectionStrategy {

    private static Logger logger = LogManager.getLogger(
            CertAuthConnectionStrategy.class.getName());

	/**
	 * Connect to the Anaplan API using an issued certificate. The certificate
	 * path is provided and the file is loaded into a Java Keystore and loaded
	 * into a X509Certificate object for use.
	 *
	 * @param certificatePath Filepath to certificate on local filesystem
	 * @param url API URL.
	 * @param proxyHost Proxy username if behind firewall.
	 * @param proxyUser Proxy username to get through firewall.
	 * @param proxyPass Proxy password to get through firewall.
	 * @throws org.mule.api.ConnectionException Whenever the connection to API
	 * 		fails due to expired certificate or invalid API endpoint or proxy
     * 	    details.
	 */
	@Connect
	@TestConnectivity
	public synchronized void connect(
			@ConnectionKey @Path String certificatePath,
			@Default("https://api.anaplan.com/") String url,
			@Optional @Default("") String proxyHost,
			@Optional @Default("") String proxyUser,
			@Optional @Default("") String proxyPass)
					throws org.mule.api.ConnectionException {

		logger.info("Initiating certificate connection...");

		if (apiConn == null) {
			// create the connection strategy using certificate path.
			apiConn = new AnaplanConnection(true, certificatePath, url,
					proxyHost, proxyUser, proxyPass);
			// Establish connection using new connection object and verify
			// service parameters
			connectToApi();
		}
	}
}