org.kohsuke.stapler.framework.adjunct.AdjunctManager Maven / Gradle / Ivy
Show all versions of stapler-jelly Show documentation
/*******************************************************************************
*
* Copyright (c) 2004-2010 Oracle Corporation.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
*
* Kohsuke Kawaguchi
*
*******************************************************************************/
package org.kohsuke.stapler.framework.adjunct;
import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.MetaClass;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import javax.servlet.ServletException;
import javax.servlet.ServletContext;
import static javax.servlet.http.HttpServletResponse.SC_FORBIDDEN;
import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
import java.io.IOException;
import java.net.URL;
import java.util.concurrent.ConcurrentHashMap;
/**
* This application-scoped object works like a factory for {@link Adjunct}s and provides caching.
*
*
* This object can be UI-bound by stapler, and adjunct CSS and JavaScript can be accessed like
*
*
* <link rel="stylesheet" href=".../css/org/example/style" type="text/css" />
* <script href=".../js/org/example/style"></script>
*
* @author Kohsuke Kawaguchi
*/
public class AdjunctManager {
private final ConcurrentHashMap adjuncts = new ConcurrentHashMap();
/**
* Map used as a set to remember which resources can be served.
*/
private final ConcurrentHashMap allowedResources = new ConcurrentHashMap();
private final ClassLoader classLoader;
/**
* Absolute URL of the {@link AdjunctManager} in the calling application where it is bound to.
*
*
* The path is treated relative from the context path of the application, and it
* needs to end without '/'. So it needs to be something like "foo/adjuncts" or more likely,
* just "adjuncts".
*/
public final String rootURL;
/**
* @param classLoader
* ClassLoader to load adjuncts from.
* @param rootURL
* See {@link #rootURL} for the meaning of this parameter.
*/
public AdjunctManager(ServletContext context,ClassLoader classLoader, String rootURL) {
this.classLoader = classLoader;
this.rootURL = rootURL;
// register this globally
context.setAttribute(KEY,this);
}
public static AdjunctManager get(ServletContext context) {
return (AdjunctManager) context.getAttribute(KEY);
}
/**
* Obtains the adjunct.
*
* @return
* always non-null.
* @throws IOException
* if failed to locate {@link Adjunct}.
*/
public Adjunct get(String name) throws IOException {
Adjunct a = adjuncts.get(name);
if(a!=null) return a; // found it
synchronized (this) {
a = adjuncts.get(name);
if(a!=null) return a; // one more check before we start loading
a = new Adjunct(this,name,classLoader);
adjuncts.put(name,a);
return a;
}
}
/**
* Serves resources in the class loader.
*/
public void doDynamic(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
String path = req.getRestOfPath();
if(!allowedResources.containsKey(path)) {
if(!allowResourceToBeServed(path)) {
rsp.sendError(SC_FORBIDDEN);
return;
}
// remember URLs that we can serve. but don't remember error ones, as it might be unbounded
allowedResources.put(path,path);
}
if (path.charAt(0)=='/') path = path.substring(1);
URL res = classLoader.getResource(path);
if(res==null) {
throw HttpResponses.error(SC_NOT_FOUND,new IllegalArgumentException("No such adjunct found: "+path));
} else {
long expires = MetaClass.NO_CACHE ? 0 : 24L * 60 * 60 * 1000; /*1 day*/
rsp.serveFile(req,res,expires);
}
}
/**
* Controls whether the given resource can be served to browsers.
*
*
* This method can be overridden by the sub classes to change the access control behavior.
*
*
* {@link AdjunctManager} is capable of serving all the resources visible
* in the classloader by default. If the resource files need to be kept private,
* return false, which causes the request to fail with 401.
*
* Otherwise return true, in which case the resource will be served.
*/
protected boolean allowResourceToBeServed(String absolutePath) {
return absolutePath.endsWith(".gif")
|| absolutePath.endsWith(".png")
|| absolutePath.endsWith(".css")
|| absolutePath.endsWith(".js");
}
/**
* Key in {@link ServletContext} to look up {@link AdjunctManager}.
*/
private static final String KEY = AdjunctManager.class.getName();
}