public class Toolbox extends Object implements Serializable
Instances of this class are typically created by a ToolboxFactory
on a one-per-scope basis. So, for each application, there would be one
application-scoped Toolbox from which you would retrieve tool instances,
and for each request, there would be one request-scoped Toolbox.
Of course, none of the above is enforced. There's no reason that you can't
manually create a Toolbox or have multiple Toolboxes for each scope.
When a Toolbox creates a tool instance asked of it (see get(java.lang.String)
),
it will cache that instance for future requests.
Modifier and Type | Field and Description |
---|---|
static String |
KEY
The key used to place instances in various scopes.
|
Constructor and Description |
---|
Toolbox(Map<String,ToolInfo> toolInfo) |
Toolbox(Map<String,ToolInfo> toolInfo,
Map<String,Object> properties) |
Modifier and Type | Method and Description |
---|---|
protected void |
cacheData(Map<String,Object> data) |
Toolbox |
combine(Toolbox... toolboxes)
|
Object |
get(String key) |
Object |
get(String key,
Map<String,Object> context) |
Object |
get(String key,
String path) |
Object |
get(String key,
String path,
Map<String,Object> context) |
Map<String,Object> |
getAll(Map<String,Object> context) |
protected Object |
getFromCache(String key,
String path) |
protected Object |
getFromInfo(String key,
String path,
Map<String,Object> context) |
Set<String> |
getKeys() |
Map<String,Object> |
getProperties() |
Map<String,Class> |
getToolClassMap()
|
protected boolean |
hasPermission(ToolInfo info,
String path) |
public static final String KEY
public Map<String,Class> getToolClassMap()
Map
link tools' keys to their Class
es.
This will not instantiate any tools, it is merely informational.
This will not include the keys for any cached data. Note that inclusion
in this map does NOT mean that all these tools will be available for
all requests, as this map ignores all path restrictions on the tools.Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.