org.kohsuke.stapler.framework.adjunct
public class AdjunctManager extends java.lang.Object
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>
Modifier and Type | Field and Description |
---|---|
java.lang.String |
rootURL
Absolute URL of the
AdjunctManager in the calling application where it is bound to. |
Constructor and Description |
---|
AdjunctManager(javax.servlet.ServletContext context,
java.lang.ClassLoader classLoader,
java.lang.String rootURL) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
allowResourceToBeServed(java.lang.String absolutePath)
Controls whether the given resource can be served to browsers.
|
void |
doDynamic(StaplerRequest req,
StaplerResponse rsp)
Serves resources in the class loader.
|
static AdjunctManager |
get(javax.servlet.ServletContext context) |
Adjunct |
get(java.lang.String name)
Obtains the adjunct.
|
public final java.lang.String rootURL
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 AdjunctManager(javax.servlet.ServletContext context, java.lang.ClassLoader classLoader, java.lang.String rootURL)
classLoader
- ClassLoader to load adjuncts from.rootURL
- See rootURL
for the meaning of this parameter.public static AdjunctManager get(javax.servlet.ServletContext context)
public Adjunct get(java.lang.String name) throws java.io.IOException
java.io.IOException
- if failed to locate Adjunct
.public void doDynamic(StaplerRequest req, StaplerResponse rsp) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
protected boolean allowResourceToBeServed(java.lang.String absolutePath)
This method can be overridden by the sub classes to change the access control behavior.
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.
Copyright © 2014. All Rights Reserved.