deployer/war/src/main/java/org/apache/karaf/deployer/war/WarDeploymentListener.java

/**
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.karaf.deployer.war;

import java.io.File;
import java.net.URL;
import java.util.jar.Attributes;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.Manifest;

import org.apache.felix.fileinstall.ArtifactUrlTransformer;

/**
 * A deployment listener that listens for war deployements.
 */
public class WarDeploymentListener implements ArtifactUrlTransformer {

	private static final String PATH_SEPERATOR = "/";

	public boolean canHandle(File artifact) {
		try {
			JarFile jar = new JarFile(artifact);
			JarEntry entry = jar.getJarEntry("WEB-INF/web.xml");
			// Only handle WAR artifacts
			if (entry == null) {
				return false;
			}
			// Only handle non OSGi bundles
			Manifest m = jar.getManifest();
			if (m!= null && m.getMainAttributes().getValue(
					new Attributes.Name("Bundle-SymbolicName")) != null
					&& m.getMainAttributes().getValue(
							new Attributes.Name("Bundle-Version")) != null) {
				return false;
			}
			return true;
		} catch (Exception e) {
			return false;
		}
	}

	public URL transform(URL artifact) throws Exception {

		String path = artifact.getPath();
		String protocol = artifact.getProtocol();

		int lastSlash = 0;
		// match the last slash to retrieve the name of the archive
		if ("jardir".equalsIgnoreCase(protocol)) {
		    // just to make sure this works on all kinds of windows
		    File fileInstance = new File(path);
		    // with a jardir this is system specific
		    lastSlash = fileInstance.getAbsolutePath().lastIndexOf(File.separator);
		} else {
		    // a standard file is not system specific, this is always a standardized URL path
		    lastSlash = path.lastIndexOf(PATH_SEPERATOR);
		}
		// match the suffix so we get rid of it for displaying
		int suffixPos = path.length() - 4; // usually this should be a war but might also be a jar plus the colon makes 4 signs

		// the display name for a web context is derived from the name of the archive
		String displayName = path.substring(lastSlash + 1, suffixPos);
		
		return new URL("war", null, protocol + ":" + path + "?Webapp-Context=" + displayName);
	}

}