A B C D E G H I K L N O P Q R S T U V W

A

AbstractDisplay - Class in org.codehaus.plexus.summit.display
 
AbstractDisplay() - Constructor for class org.codehaus.plexus.summit.display.AbstractDisplay
 
AbstractPipeline - Class in org.codehaus.plexus.summit.pipeline
Flexible implementation of a Pipeline.
AbstractPipeline() - Constructor for class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 
AbstractRenderer - Class in org.codehaus.plexus.summit.renderer
Base class from which all Renderers are derived.
AbstractRenderer() - Constructor for class org.codehaus.plexus.summit.renderer.AbstractRenderer
 
AbstractResolver - Class in org.codehaus.plexus.summit.resolver
The base class from which all Resolvers are derived.
AbstractResolver() - Constructor for class org.codehaus.plexus.summit.resolver.AbstractResolver
 
AbstractRunData - Class in org.codehaus.plexus.summit.rundata
The base class from which all RunData implementations are derived.
AbstractRunData() - Constructor for class org.codehaus.plexus.summit.rundata.AbstractRunData
 
AbstractSummitComponent - Class in org.codehaus.plexus.summit
The base class for all the various components used in Summit:

Displays Modules Pipelines Valves (not yet) Renderers Resolvers Views

The primary motivation for this is to share access to the application view which acts a mediator between all the various components so that each of the components are not directly coupled to one another.

AbstractSummitComponent() - Constructor for class org.codehaus.plexus.summit.AbstractSummitComponent
 
AbstractValve - Class in org.codehaus.plexus.summit.pipeline.valve
Valve that can be used as the basis of Valve implementations.
AbstractValve() - Constructor for class org.codehaus.plexus.summit.pipeline.valve.AbstractValve
 
AbstractView - Class in org.codehaus.plexus.summit.view
The base class from which all Views are derived.
AbstractView(String) - Constructor for class org.codehaus.plexus.summit.view.AbstractView
 
ACTION - Static variable in interface org.codehaus.plexus.summit.SummitConstants
The action for a request.
ActionValve - Class in org.codehaus.plexus.summit.pipeline.valve
 
ActionValve() - Constructor for class org.codehaus.plexus.summit.pipeline.valve.ActionValve
 
add(int, String, String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
If the type is P (0), then add name/value to the pathInfo hashtable.
add(ArrayList, RequestParameters) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Method for a quick way to add all the parameters in a RequestParameters to a given List
add(int, RequestParameters) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Method for a quick way to add all the parameters in a RequestParameters.
addFileItem(Map, String, FileItem) - Method in class org.codehaus.plexus.summit.parameters.BaseRequestParameterParser
Add a FileItem to the specified parameter map ensuring that the value is stored as an array of FileItems even if there is only a single parameter.
addPair(ArrayList, String, String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Add a key value pair (in the form of a 2 object array) to the provided list
addParameter(Map, String, String) - Method in class org.codehaus.plexus.summit.parameters.BaseRequestParameterParser
Add a parameter to the specified parameter map ensuring that the value is stored as an array of Strings even if there is only a single parameter.
addPathInfo(String, Object) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the path_info string.
addPathInfo(String, String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the path_info string.
addPathInfo(String, double) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the path_info string.
addPathInfo(String, int) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the path_info string.
addPathInfo(String, long) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the path_info string.
addPathInfo(String, boolean) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the path_info string.
addPathInfo(RequestParameters) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair for every entry in a RequestParameters object to the path_info string.
addQueryData(String, Object) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the query string.
addQueryData(String, String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the query string.
addQueryData(String, double) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the query string.
addQueryData(String, int) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the query string.
addQueryData(String, long) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair to the query string.
addQueryData(RequestParameters) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Adds a name=value pair for every entry in a RequestParameters object to the query string.
ANCHOR_STATIC_PART_LENGTH - Static variable in class org.codehaus.plexus.summit.util.UriBuilder
Length of static part of an A tag
APPLICATION_ROOT - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Application root.

B

BaseParameterConverter - Class in org.codehaus.plexus.summit.parameters
Base implementation of a ParameterConverter which relies on an underlying Map of name/value pairs where each value is an array of strings (even if it contains a single value).
BaseParameterConverter(Map) - Constructor for class org.codehaus.plexus.summit.parameters.BaseParameterConverter
Constructor that takes a map of parameters and uses the default character encoding, "US-ASCII", when converting to byte arrays.
BaseParameterConverter(Map, String) - Constructor for class org.codehaus.plexus.summit.parameters.BaseParameterConverter
Constructor that takes a map of parameters and a character encoding that is used when converting to byte arrays.
BaseRequestParameterParser - Class in org.codehaus.plexus.summit.parameters
Default implementation of a RequestParameterParser.
BaseRequestParameterParser() - Constructor for class org.codehaus.plexus.summit.parameters.BaseRequestParameterParser
 

C

characterEncoding - Variable in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
The character encoding to use when converting to byte arrays.
ClassicBufferedDisplay - Class in org.codehaus.plexus.summit.display

A ClassicDisplay takes a Resolution computed by the ClassicResolver and displays the resolution according to the Turbine 2.x model where we have something like the following:

+------------------------------------------------+ | DefaultLayout.vm | | +--------------------------------------------+ | | | TopNavigation.vm | | | +--------------------------------------------+ | | | | +--------------------------------------------+ | | | | | | | | | | | $screenViewContent | | | | | | | | | | | +--------------------------------------------+ | | | | +--------------------------------------------+ | | | TopNavigation.vm | | | +--------------------------------------------+ | +------------------------------------------------+

This example uses Velocity templates as an example but this Display strategy could just as easily be applied to a set of JSPs.

ClassicBufferedDisplay() - Constructor for class org.codehaus.plexus.summit.display.ClassicBufferedDisplay
 
ClassicResolver - Class in org.codehaus.plexus.summit.resolver
This resolving strategy emulates the Turbine 2.x process of matching a target up with:

A layout module A layout view A screen module

The navigation views are stated explicitly in the layout view according to the resolving process in Turbine 2.x so this resolver doesn't have to do any work in this respect.

ClassicResolver() - Constructor for class org.codehaus.plexus.summit.resolver.ClassicResolver
 
configure(PlexusConfiguration) - Method in class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 
configureValve(PlexusConfiguration) - Method in class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 
containsKey(Object) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
containsKey(Object) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Determine whether a given key has been inserted
ContentUriBuilder - Class in org.codehaus.plexus.summit.pull.tools
Utility class to allow the easy inclusion of images in templates: <img src="$content.getURI("image.jpg")">
ContentUriBuilder() - Constructor for class org.codehaus.plexus.summit.pull.tools.ContentUriBuilder
Default constructor
contextualize(Context) - Method in class org.codehaus.plexus.summit.AbstractSummitComponent
 
contextualize(Context) - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
 
createContext(RunData) - Method in class org.codehaus.plexus.summit.pipeline.valve.ActionValve
 
CreateViewContextValve - Class in org.codehaus.plexus.summit.pipeline.valve
 
CreateViewContextValve() - Constructor for class org.codehaus.plexus.summit.pipeline.valve.CreateViewContextValve
 

D

data - Variable in class org.codehaus.plexus.summit.util.UriBuilder
The RunData object.
DEFAULT_APPLICATION_VIEW - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Tag for the default application view.
DEFAULT_SCREEN_MODULE - Static variable in class org.codehaus.plexus.summit.resolver.SimpleResolver
 
DefaultExceptionHandler - Class in org.codehaus.plexus.summit.exception
 
DefaultExceptionHandler() - Constructor for class org.codehaus.plexus.summit.exception.DefaultExceptionHandler
 
DefaultPullService - Class in org.codehaus.plexus.summit.pull
This is a default implementation of the pull service.
DefaultPullService() - Constructor for class org.codehaus.plexus.summit.pull.DefaultPullService
 
DefaultRunData - Class in org.codehaus.plexus.summit.rundata
 
DefaultRunData() - Constructor for class org.codehaus.plexus.summit.rundata.DefaultRunData
 
DefaultView - Class in org.codehaus.plexus.summit.view
The default View implemenation.
DefaultView(String) - Constructor for class org.codehaus.plexus.summit.view.DefaultView
Constructor.
DefaultViewContext - Class in org.codehaus.plexus.summit.view
Default ViewContext implementation.
DefaultViewContext() - Constructor for class org.codehaus.plexus.summit.view.DefaultViewContext
 
DetermineTargetValve - Class in org.codehaus.plexus.summit.pipeline.valve
 
DetermineTargetValve() - Constructor for class org.codehaus.plexus.summit.pipeline.valve.DetermineTargetValve
 
Display - Interface in org.codehaus.plexus.summit.display
A Display uses a previously computed Resolution to render the target view along with any of its sibling views and the execution of any accompanying Modules.
DisplayValve - Class in org.codehaus.plexus.summit.pipeline.valve
 
DisplayValve() - Constructor for class org.codehaus.plexus.summit.pipeline.valve.DisplayValve
 
dispose() - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
 
dispose() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.codehaus.plexus.summit.Summit
 
doParse(HttpServletRequest, Map) - Method in class org.codehaus.plexus.summit.parameters.BaseRequestParameterParser
Invoked as part of the parse template method to provide a hook for additional parsing of parameters.
doParse(HttpServletRequest, Map) - Method in class org.codehaus.plexus.summit.parameters.SummitRequestParameterParser
Parses the query info and path info for the parameters associated with this request.
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.codehaus.plexus.summit.Summit
 

E

EXCEPTION_HANDLER - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Configuration key for the ExceptionHandler that Turbine will use.
ExceptionHandler - Interface in org.codehaus.plexus.summit.exception
Interface that defines an exception handler for the Summit servlet.

G

get(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
get(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a String for the given name.
get(Object) - Method in class org.codehaus.plexus.summit.resolver.Resolution
 
get(String) - Method in class org.codehaus.plexus.summit.view.DefaultViewContext
 
get(String) - Method in interface org.codehaus.plexus.summit.view.ViewContext
 
getA(String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Create an anchor object.
getAttributes() - Method in class org.codehaus.plexus.summit.pull.tools.TemplatePageAttributes
 
getBigDecimal(String, BigDecimal) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getBigDecimal(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getBigDecimal(String, BigDecimal) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a BigDecimal for the given name.
getBigDecimal(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a BigDecimal for the given name.
getBigDecimals(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getBigDecimals(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of BigDecimals for the given name.
getBool(String, boolean) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getBool(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getBool(String, boolean) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a Boolean for the given name.
getBool(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a Boolean for the given name.
getBoolean(String, boolean) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getBoolean(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getBoolean(String, boolean) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a boolean for the given name.
getBoolean(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a boolean for the given name.
getByte(String, byte) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getByte(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getByte(String, byte) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a byte for the given name.
getByte(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a byte for the given name.
getBytes(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getBytes(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of bytes for the given name.
getContainer() - Method in class org.codehaus.plexus.summit.AbstractSummitComponent
 
getContainer() - Method in interface org.codehaus.plexus.summit.SummitComponent
 
getContentType() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the HTTP content type to return.
getContentType() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the HTTP content type to return.
getContextPath() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
getContextPath() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Get the servlet's context path for this webapp.
getDate(String, DateFormat, Date) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getDate(String, DateFormat) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getDate(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getDate(String, DateFormat, Date) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Returns a Date object.
getDate(String, DateFormat) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Returns a Date object.
getDate(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Returns a Date object.
getDefaultEncoding() - Method in class org.codehaus.plexus.summit.display.AbstractDisplay
 
getDefaultView() - Method in class org.codehaus.plexus.summit.resolver.AbstractResolver
 
getDefaultView() - Method in interface org.codehaus.plexus.summit.resolver.Resolver
 
getDouble(String, double) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getDouble(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getDouble(String, double) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a double for the given name.
getDouble(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a double for the given name.
getError() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
getError() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Get the error that occurred during request processing
getErrorView() - Method in class org.codehaus.plexus.summit.resolver.AbstractResolver
 
getErrorView() - Method in interface org.codehaus.plexus.summit.resolver.Resolver
 
getFileItem(String) - Method in class org.codehaus.plexus.summit.parameters.RequestParameters
Get the FileItem, which represents a file that was uploaded as part of an HTTP request, associated with the specified parameter name.
getFileItems(String) - Method in class org.codehaus.plexus.summit.parameters.RequestParameters
Get the FileItem[]s, which represents one or more files that were uploaded as part of an HTTP request, associated with the specified parameter name.
getFloat(String, float) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getFloat(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getFloat(String, float) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a float for the given name.
getFloat(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a float for the given name.
getInitialView() - Method in class org.codehaus.plexus.summit.resolver.AbstractResolver
 
getInitialView() - Method in interface org.codehaus.plexus.summit.resolver.Resolver
 
getInt(String, int) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getInt(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getInt(String, int) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an int for the given name.
getInt(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an int for the given name.
getInteger(String, int) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getInteger(String, Integer) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getInteger(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getInteger(String, int) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an Integer for the given name.
getInteger(String, Integer) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an Integer for the given name.
getInteger(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an Integer for the given name.
getIntegers(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getIntegers(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of Integers for the given name.
getInts(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getInts(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of ints for the given name.
getKeys() - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getKeys() - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Get an array of all the parameter names.
getLink(String) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Create a static link to resources in the webapp space.
getLong(String, long) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getLong(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getLong(String, long) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a long for the given name.
getLong(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a long for the given name.
getLongObjects(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getLongObjects(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of Longs for the given name.
getLongs(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getLongs(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of longs for the given name.
getMap() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the map attribute of the AbstractRunData object
getMap() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the map attribute of the RunData object
getName() - Method in class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 
getName() - Method in class org.codehaus.plexus.summit.pull.Tool
 
getName() - Method in class org.codehaus.plexus.summit.view.AbstractView
 
getName() - Method in interface org.codehaus.plexus.summit.view.View
Get the name of the view.
getObject(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getObject(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an Object for the given name.
getObjects(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getObjects(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of Objects for the given name.
getPage() - Method in class org.codehaus.plexus.summit.pull.tools.RelativeTemplateLink
Gets the target variable used by the Template Service.
getPage() - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLink
Gets the template variable used by the Template Service.
getParameters() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the request parameters.
getParameters() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the request parameters.
getParametersMap() - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getPossibleViews(String, String) - Static method in class org.codehaus.plexus.summit.resolver.ResolverUtils
Get the parsed module name for the specified template.
getRenderer(String) - Method in class org.codehaus.plexus.summit.pull.tools.TemplateRenderer
 
getRenderer(String) - Method in class org.codehaus.plexus.summit.resolver.AbstractResolver
 
getRenderer(String) - Method in class org.codehaus.plexus.summit.resolver.ClassicResolver
 
getRenderer(String) - Method in class org.codehaus.plexus.summit.resolver.SimpleResolver
 
getRequest() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the request attribute of the AbstractRunData object
getRequest() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the request attribute of the RunData object
getResolution() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the Resolver attribute of the AbstractRunData object
getResolution() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the Resolver attribute of the RunData object
getResponse() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the response attribute of the AbstractRunData object
getResponse() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the response attribute of the RunData object
getResultMessages() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
getResultMessages() - Method in interface org.codehaus.plexus.summit.rundata.RunData
 
getResultMessagesView() - Method in class org.codehaus.plexus.summit.resolver.AbstractResolver
 
getResultMessagesView() - Method in interface org.codehaus.plexus.summit.resolver.Resolver
 
getRole() - Method in class org.codehaus.plexus.summit.pull.Tool
 
getRoleHint() - Method in class org.codehaus.plexus.summit.pull.Tool
 
getScope() - Method in class org.codehaus.plexus.summit.pull.Tool
 
getScriptName() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
getScriptName() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Get the initial script name.
getScriptName() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Gets the script name (/servlets/Turbine).
getServerName() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
getServerName() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Get the server name.
getServerName() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Gets the server name.
getServerPort() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
getServerPort() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Get the server port.
getServerPort() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Gets the server port.
getServerScheme() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
getServerScheme() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Get the server scheme.
getServerScheme() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Gets the server scheme (HTTP or HTTPS).
getServletConfig() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the servletConfig attribute of the AbstractRunData object
getServletConfig() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the servletConfig attribute of the RunData object
getServletContext() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
getServletContext() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Get the servlet context for this turbine webapp.
getServletInfo() - Method in class org.codehaus.plexus.summit.Summit
 
getSession() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the session attribute of the AbstractRunData object
getSession() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the session attribute of the RunData object
getString(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getString(String, String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getString(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a String for the given name.
getString(String, String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return a String for the given name.
getStrings(String) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getStrings(String, String[]) - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
getStrings(String) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of Strings for the given name.
getStrings(String, String[]) - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Return an array of Strings for the given name.
getTarget() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Gets the target attribute of the AbstractRunData object
getTarget() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Gets the target attribute of the RunData object
getTitle() - Method in class org.codehaus.plexus.summit.pull.tools.TemplatePageAttributes
 
getURI(String) - Method in class org.codehaus.plexus.summit.pull.tools.ContentUriBuilder
Returns a URI pointing to the given content (where content is a path relative to the webapp root.
getURI() - Method in class org.codehaus.plexus.summit.pull.tools.RelativeTemplateLink
Returns the URI leaving the source intact.
getURI() - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLink
Returns the URI leaving the source intact.
getValves() - Method in class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 
getValves() - Method in interface org.codehaus.plexus.summit.pipeline.Pipeline
 
getView(String) - Method in class org.codehaus.plexus.summit.resolver.AbstractResolver
Gets the view attribute of the AbstractResolver object
getView(String, String) - Method in class org.codehaus.plexus.summit.resolver.AbstractResolver
Gets the view attribute of the AbstractResolver object
getView(String, String, String) - Method in class org.codehaus.plexus.summit.resolver.AbstractResolver
Gets the view attribute of the AbstractResolver object
getView(String) - Method in class org.codehaus.plexus.summit.resolver.Resolution
 
getWriter(RunData) - Method in class org.codehaus.plexus.summit.display.AbstractDisplay
 
GLOBAL_SCOPE - Static variable in class org.codehaus.plexus.summit.pull.DefaultPullService
 

H

handleException(RunData, Throwable) - Method in class org.codehaus.plexus.summit.exception.DefaultExceptionHandler
 
handleException(RunData, Throwable) - Method in interface org.codehaus.plexus.summit.exception.ExceptionHandler
This method will be called to handle a throwable thrown by the pipeline
hasError() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
hasError() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Determine whether an error has occured during request processing
hasPathInfo() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Does this URI have path info.
hasQueryData() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Does this URI have query data.
hasResultMessages() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
hasResultMessages() - Method in interface org.codehaus.plexus.summit.rundata.RunData
 
hasTarget() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Description of the Method
hasTarget() - Method in interface org.codehaus.plexus.summit.rundata.RunData
Description of the Method
HTTP - Static variable in class org.codehaus.plexus.summit.util.UriBuilder
HTTP protocol.
HTTPS - Static variable in class org.codehaus.plexus.summit.util.UriBuilder
HTTPS protocol.

I

init() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Initializes the builder for use by clearing any previous state.
init(RunData) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Initialize with a RunData object
initialize() - Method in class org.codehaus.plexus.summit.parameters.BaseRequestParameterParser
 
initialize() - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
 
initialize() - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
internalContainsKey(Object) - Method in class org.codehaus.plexus.summit.renderer.VelocityContextAdapter
 
internalGet(String) - Method in class org.codehaus.plexus.summit.renderer.VelocityContextAdapter
 
internalGetKeys() - Method in class org.codehaus.plexus.summit.renderer.VelocityContextAdapter
 
internalPut(String, Object) - Method in class org.codehaus.plexus.summit.renderer.VelocityContextAdapter
 
internalRemove(Object) - Method in class org.codehaus.plexus.summit.renderer.VelocityContextAdapter
 
invoke(RunData) - Method in class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 
invoke(RunData) - Method in interface org.codehaus.plexus.summit.pipeline.Pipeline
Cause the specified request and response to be processed by the sequence of Valves associated with this pipeline, until one of these Valves decides to end the processing.
invoke(RunData) - Method in class org.codehaus.plexus.summit.pipeline.valve.ActionValve
 
invoke(RunData) - Method in class org.codehaus.plexus.summit.pipeline.valve.CreateViewContextValve
 
invoke(RunData) - Method in class org.codehaus.plexus.summit.pipeline.valve.DetermineTargetValve
 
invoke(RunData) - Method in class org.codehaus.plexus.summit.pipeline.valve.DisplayValve
 
invoke(RunData) - Method in class org.codehaus.plexus.summit.pipeline.valve.ResolverValve
 
invoke(RunData) - Method in interface org.codehaus.plexus.summit.pipeline.valve.Valve
 
invoke(RunData) - Method in class org.codehaus.plexus.summit.pull.PullToolReleaseValve
 
invoke(RunData) - Method in class org.codehaus.plexus.summit.pull.PullToolValve
 
isEncodeUrl() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Will a call to toString() add session info if needed to maintain a session.
isRelative() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Will a call to toString() generate a relative url?

K

keys() - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
 
keys() - Method in interface org.codehaus.plexus.summit.parameters.ParameterConverter
Get an Iterator for the parameter names.

L

LAYOUT_VIEW - Static variable in class org.codehaus.plexus.summit.resolver.ClassicResolver
Tag for the layout view in the resolution.
LOGGING_ROOT - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Description of the Field
lookup(String, String) - Method in class org.codehaus.plexus.summit.AbstractSummitComponent
 
lookup(String) - Method in class org.codehaus.plexus.summit.AbstractSummitComponent
 
lookup(String) - Method in interface org.codehaus.plexus.summit.SummitComponent
 
lookup(String, String) - Method in interface org.codehaus.plexus.summit.SummitComponent
 

N

name - Variable in class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 
NAVIGATION_VIEW - Static variable in class org.codehaus.plexus.summit.resolver.ClassicResolver
Tag for the navigation module in the resolution.
nocache - Variable in class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 

O

org.codehaus.plexus.summit - package org.codehaus.plexus.summit
 
org.codehaus.plexus.summit.display - package org.codehaus.plexus.summit.display
 
org.codehaus.plexus.summit.exception - package org.codehaus.plexus.summit.exception
 
org.codehaus.plexus.summit.parameters - package org.codehaus.plexus.summit.parameters
 
org.codehaus.plexus.summit.pipeline - package org.codehaus.plexus.summit.pipeline
 
org.codehaus.plexus.summit.pipeline.valve - package org.codehaus.plexus.summit.pipeline.valve
 
org.codehaus.plexus.summit.pull - package org.codehaus.plexus.summit.pull
 
org.codehaus.plexus.summit.pull.tools - package org.codehaus.plexus.summit.pull.tools
 
org.codehaus.plexus.summit.renderer - package org.codehaus.plexus.summit.renderer
 
org.codehaus.plexus.summit.resolver - package org.codehaus.plexus.summit.resolver
 
org.codehaus.plexus.summit.rundata - package org.codehaus.plexus.summit.rundata
 
org.codehaus.plexus.summit.util - package org.codehaus.plexus.summit.util
 
org.codehaus.plexus.summit.view - package org.codehaus.plexus.summit.view
 

P

ParameterConverter - Interface in org.codehaus.plexus.summit.parameters
Interface that provides type-conversion methods for the values of a parameter map.
parameters - Variable in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
Map used to store the parameters that were parsed.
parse(HttpServletRequest) - Method in class org.codehaus.plexus.summit.parameters.BaseRequestParameterParser
Parses the query info for the parameters associated with this request as well as any uploaded files sent with the HTTP request.
parse(HttpServletRequest) - Method in interface org.codehaus.plexus.summit.parameters.RequestParameterParser
Parses the query info and path info of an HTTP request for parameters in the form of name/value pairs.
parseTargetPath(String, StringBuffer) - Static method in class org.codehaus.plexus.summit.resolver.ResolverUtils
Parse the template name collected from URL parameters or template context to a path name.
PATH_INFO - Static variable in class org.codehaus.plexus.summit.util.UriBuilder
P = 0 for path info.
pathInfo - Variable in class org.codehaus.plexus.summit.util.UriBuilder
A Vector that contains all the path info if any.
Pipeline - Interface in org.codehaus.plexus.summit.pipeline
A Pipeline is the entity which controls the flow of the request/response lifecyle in Summit.
populateContext(ViewContext, RunData) - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
 
populateContext(ViewContext, RunData) - Method in interface org.codehaus.plexus.summit.pull.PullService
Populate the given context with all request, session and persistent scope tools (it is assumed that the context already wraps the global context, and thus already contains the global tools).
populateViewContext(RunData, ViewContext) - Method in class org.codehaus.plexus.summit.pipeline.valve.CreateViewContextValve
Populate the velocityContext.
populateWithGlobalTools(ViewContext) - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
 
populateWithRequestTools(ViewContext, RunData) - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
 
populateWithSessionTools(ViewContext, RunData) - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
An attempt to populate the session with tools.
PullService - Interface in org.codehaus.plexus.summit.pull
The Pull Service manages the creation of application tools that are available to all templates in a Turbine application.
PullToolReleaseValve - Class in org.codehaus.plexus.summit.pull
PullToolValve uses the PullService to populate the ViewContext.
PullToolReleaseValve() - Constructor for class org.codehaus.plexus.summit.pull.PullToolReleaseValve
 
PullToolValve - Class in org.codehaus.plexus.summit.pull
PullToolValve uses the PullService to populate the ViewContext.
PullToolValve() - Constructor for class org.codehaus.plexus.summit.pull.PullToolValve
 
put(Object, Object) - Method in class org.codehaus.plexus.summit.resolver.Resolution
 
put(String, Object) - Method in class org.codehaus.plexus.summit.view.DefaultViewContext
 
put(String, Object) - Method in interface org.codehaus.plexus.summit.view.ViewContext
 
putAll(Map) - Method in class org.codehaus.plexus.summit.view.DefaultViewContext
 
putAll(Map) - Method in interface org.codehaus.plexus.summit.view.ViewContext
 

Q

QUERY_DATA - Static variable in class org.codehaus.plexus.summit.util.UriBuilder
Q = 1 for query data.
queryData - Variable in class org.codehaus.plexus.summit.util.UriBuilder
A Vectory that contains all the query data if any.

R

redirect - Variable in class org.codehaus.plexus.summit.util.UriBuilder
Whether we want to redirect or not.
refresh() - Method in interface org.codehaus.plexus.summit.pull.RequestTool
Refresh the application tool.
refresh() - Method in class org.codehaus.plexus.summit.pull.tools.ContentUriBuilder
Refresh method - does nothing
refresh() - Method in class org.codehaus.plexus.summit.pull.tools.RelativeTemplateLink
 
refresh() - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLink
 
refresh() - Method in class org.codehaus.plexus.summit.pull.tools.TemplatePageAttributes
 
refresh() - Method in class org.codehaus.plexus.summit.pull.tools.TemplateRenderer
 
RelativeTemplateLink - Class in org.codehaus.plexus.summit.pull.tools
A customized version of the RelativeDynamicUriBuilder to be used in Templates.
RelativeTemplateLink() - Constructor for class org.codehaus.plexus.summit.pull.tools.RelativeTemplateLink
Default constructor

The init method must be called before use.

releaseTools(ViewContext) - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
 
releaseTools(ViewContext, Map) - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
 
releaseTools(ViewContext) - Method in interface org.codehaus.plexus.summit.pull.PullService
Release tool instances from the given context to the object pool
remove(int, String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
If the type is P (0), then remove name/value from the pathInfo hashtable.
remove(String) - Method in class org.codehaus.plexus.summit.view.DefaultViewContext
 
remove(String) - Method in interface org.codehaus.plexus.summit.view.ViewContext
 
removePairByName(ArrayList, String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Helper method to remove one or more pairs by its name (ie key).
removePathInfo() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Removes all the path info elements.
removePathInfo(String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Removes a name=value pair from the path info.
removeQueryData() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Removes all the query string elements.
removeQueryData(String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Removes a name=value pair from the query string.
render(RunData) - Method in class org.codehaus.plexus.summit.display.AbstractDisplay
 
render(RunData) - Method in class org.codehaus.plexus.summit.display.ClassicBufferedDisplay
 
render(RunData) - Method in interface org.codehaus.plexus.summit.display.Display
 
render(String, String) - Method in class org.codehaus.plexus.summit.pull.tools.TemplateRenderer
 
render(RunData, String) - Method in class org.codehaus.plexus.summit.renderer.AbstractRenderer
 
render(RunData, String, Writer) - Method in class org.codehaus.plexus.summit.renderer.AbstractRenderer
 
render(RunData, String) - Method in interface org.codehaus.plexus.summit.renderer.Renderer
 
render(RunData, String, Writer) - Method in interface org.codehaus.plexus.summit.renderer.Renderer
 
render(RunData, String, Writer) - Method in class org.codehaus.plexus.summit.renderer.VelocityRenderer
 
Renderer - Interface in org.codehaus.plexus.summit.renderer
A Renderer is a
RENDERER - Static variable in class org.codehaus.plexus.summit.resolver.ClassicResolver
The renderer for this resolution
renderPairs(ArrayList, StringBuffer, char, char) - Method in class org.codehaus.plexus.summit.util.UriBuilder
This method takes a List of key/value arrays and converts it into a URL encoded key/value pair format with the appropriate separator.
renderPathInfo(Vector) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Deprecated. Prefer the ArrayList / StringBuffer form.
renderPathInfo(ArrayList, StringBuffer) - Method in class org.codehaus.plexus.summit.util.UriBuilder
This method takes a Vector of key/value arrays and writes it to the supplied StringBuffer as encoded path info.
renderQueryString(Vector) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Deprecated. Prefer the ArrayList / StringBuffer form.
renderQueryString(ArrayList, StringBuffer) - Method in class org.codehaus.plexus.summit.util.UriBuilder
This method takes a List of key/value arrays and writes it to the provided StringBuffer in encoded query string format.
REQUEST_SCOPE - Static variable in class org.codehaus.plexus.summit.pull.DefaultPullService
 
RequestParameterParser - Interface in org.codehaus.plexus.summit.parameters
Parses an HTTP GET/POST request for parameters passed via the query info and/or path info.
RequestParameters - Class in org.codehaus.plexus.summit.parameters
Provides numerous convienence methods which operate on a map of parameters contained within this object.
RequestParameters(Map) - Constructor for class org.codehaus.plexus.summit.parameters.RequestParameters
Constructor that takes a map of parameters and uses the default character encoding, "US-ASCII", when converting to byte arrays.
RequestParameters(Map, String) - Constructor for class org.codehaus.plexus.summit.parameters.RequestParameters
Constructor that takes a map of parameters and a character encoding that is used when converting to byte arrays.
RequestTool - Interface in org.codehaus.plexus.summit.pull
Tools that go into the Toolbox should implement this interface.
res - Variable in class org.codehaus.plexus.summit.util.UriBuilder
Servlet response interface.
Resolution - Class in org.codehaus.plexus.summit.resolver
A Resolution is the result of target view processing that occurs within a Resolver.
Resolution() - Constructor for class org.codehaus.plexus.summit.resolver.Resolution
 
resolve(String) - Method in class org.codehaus.plexus.summit.pull.tools.TemplateRenderer
 
resolve(String) - Method in class org.codehaus.plexus.summit.resolver.ClassicResolver
Description of the Method
resolve(String) - Method in interface org.codehaus.plexus.summit.resolver.Resolver
 
resolve(String) - Method in class org.codehaus.plexus.summit.resolver.SimpleResolver
 
Resolver - Interface in org.codehaus.plexus.summit.resolver
A resolver is a strategy for determining how target view will be rendered.
RESOLVER - Static variable in interface org.codehaus.plexus.summit.SummitConstants
What resolver Turbine will use
ResolverUtils - Class in org.codehaus.plexus.summit.resolver
A set of utilities that help with fulling resolving a target view.
ResolverUtils() - Constructor for class org.codehaus.plexus.summit.resolver.ResolverUtils
 
ResolverValve - Class in org.codehaus.plexus.summit.pipeline.valve
 
ResolverValve() - Constructor for class org.codehaus.plexus.summit.pipeline.valve.ResolverValve
 
RESULT_MESSAGES - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Tag for result messages.
ROLE - Static variable in interface org.codehaus.plexus.summit.display.Display
 
ROLE - Static variable in interface org.codehaus.plexus.summit.exception.ExceptionHandler
 
ROLE - Static variable in interface org.codehaus.plexus.summit.parameters.RequestParameterParser
The role.
ROLE - Static variable in interface org.codehaus.plexus.summit.pipeline.Pipeline
 
ROLE - Static variable in interface org.codehaus.plexus.summit.pipeline.valve.Valve
 
ROLE - Static variable in interface org.codehaus.plexus.summit.pull.PullService
The Avalon role
ROLE - Static variable in interface org.codehaus.plexus.summit.renderer.Renderer
 
ROLE - Static variable in interface org.codehaus.plexus.summit.resolver.Resolver
 
ROLE - Static variable in interface org.codehaus.plexus.summit.rundata.RunData
 
ROLE - Static variable in class org.codehaus.plexus.summit.util.UriBuilder
 
RunData - Interface in org.codehaus.plexus.summit.rundata
RunData is an interface to run-rime information that is passed within Summit.
RUNDATA - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Rundata

S

SCREEN_MODULE - Static variable in class org.codehaus.plexus.summit.resolver.SimpleResolver
 
SCREEN_VIEW - Static variable in class org.codehaus.plexus.summit.resolver.ClassicResolver
Tag for the screen view in the resolution.
SCREEN_VIEW - Static variable in class org.codehaus.plexus.summit.resolver.SimpleResolver
 
SELECTOR_ROLE - Static variable in interface org.codehaus.plexus.summit.pipeline.Pipeline
 
SESSION_SCOPE - Static variable in class org.codehaus.plexus.summit.pull.DefaultPullService
 
setAbsolute(boolean) - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLink
Set to false to skip the scheme, host, and port sections of the url.
setAction(String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Sets the action= value for this URL.
setAttribute(String, String) - Method in class org.codehaus.plexus.summit.pull.tools.TemplatePageAttributes
 
setContentType(String) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Sets the HTTP content type to return.
setContentType(String) - Method in interface org.codehaus.plexus.summit.rundata.RunData
Sets the HTTP content type to return.
setEncodeUrl(boolean) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Can be used to disable url rewriting.
setEncodeURLOff() - Method in class org.codehaus.plexus.summit.pull.tools.RelativeTemplateLink
This will turn off the execution of res.encodeURL() by making res == null.
setEncodeURLOff() - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLink
This will turn off the execution of res.encodeURL().
setError(Throwable) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
setError(Throwable) - Method in interface org.codehaus.plexus.summit.rundata.RunData
Set the error that occurred during request processing
setMap(Map) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Sets the map attribute of the AbstractRunData object
setMap(Map) - Method in interface org.codehaus.plexus.summit.rundata.RunData
Sets the map attribute of the RunData object
setName(String) - Method in class org.codehaus.plexus.summit.view.AbstractView
 
setName(String) - Method in interface org.codehaus.plexus.summit.view.View
Set the name of the view.
setPage(String) - Method in class org.codehaus.plexus.summit.pull.tools.RelativeTemplateLink
Sets the target variable used by the Template Service.
setPage(String) - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLink
Sets the template variable used by the Template Service.
setPage(String) - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLinkWithSlash
Sets the template variable used by the Template Service.
setRedirect(boolean) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Sets whether we want to redirect or not.
setRelative(boolean) - Method in class org.codehaus.plexus.summit.util.UriBuilder
if true, the scheme, domain, and port will not be included in the String representation of this uri..
setRequest(HttpServletRequest) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Sets the request attribute of the AbstractRunData object
setRequest(HttpServletRequest) - Method in interface org.codehaus.plexus.summit.rundata.RunData
Sets the request attribute of the RunData object
setRequestRunData(Object, RunData) - Method in class org.codehaus.plexus.summit.pull.DefaultPullService
Set the appropriate runtime data for components that extend RequestTool.
setResolution(Resolution) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Sets the Resolver attribute of the AbstractRunData object
setResolution(Resolution) - Method in interface org.codehaus.plexus.summit.rundata.RunData
Sets the Resolver attribute of the RunData object
setResponse(HttpServletResponse) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Sets the response attribute of the AbstractRunData object
setResponse(HttpServletResponse) - Method in interface org.codehaus.plexus.summit.rundata.RunData
Sets the response attribute of the RunData object
setResultMessages(List) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
 
setResultMessages(List) - Method in interface org.codehaus.plexus.summit.rundata.RunData
 
setRunData(RunData) - Method in interface org.codehaus.plexus.summit.pull.RequestTool
Initialize the RequestTool with RunData from the request.
setRunData(RunData) - Method in class org.codehaus.plexus.summit.pull.tools.ContentUriBuilder
Initialize this object using the given RunData object
setRunData(RunData) - Method in class org.codehaus.plexus.summit.pull.tools.RelativeTemplateLink
 
setRunData(RunData) - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLink
 
setRunData(RunData) - Method in class org.codehaus.plexus.summit.pull.tools.TemplatePageAttributes
 
setRunData(RunData) - Method in class org.codehaus.plexus.summit.pull.tools.TemplateRenderer
 
setServletConfig(ServletConfig) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Sets the servletConfig attribute of the AbstractRunData object
setServletConfig(ServletConfig) - Method in interface org.codehaus.plexus.summit.rundata.RunData
Sets the servletConfig attribute of the RunData object
setTarget(String) - Method in class org.codehaus.plexus.summit.rundata.AbstractRunData
Sets the target attribute of the AbstractRunData object
setTarget(String) - Method in interface org.codehaus.plexus.summit.rundata.RunData
Sets the target attribute of the RunData object
setTarget(String) - Method in class org.codehaus.plexus.summit.util.UriBuilder
Sets the target = value for this URL.
setTitle(String) - Method in class org.codehaus.plexus.summit.pull.tools.TemplatePageAttributes
 
SimpleResolver - Class in org.codehaus.plexus.summit.resolver
 
SimpleResolver() - Constructor for class org.codehaus.plexus.summit.resolver.SimpleResolver
 
STACK_TRACE - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Tag for stack trace.
Summit - Class in org.codehaus.plexus.summit
 
Summit() - Constructor for class org.codehaus.plexus.summit.Summit
 
SUMMIT_VIEW_ID_KEY - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Key used to store the summit view's id in the context
SUMMIT_VIEW_KEY - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Key used to store the summit view in the context
SUMMIT_VIEW_NAME_KEY - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Key used to store the summit view's name in the context
SummitComponent - Interface in org.codehaus.plexus.summit
 
SummitConstants - Interface in org.codehaus.plexus.summit
A set of constants used by Summit.
SummitException - Exception in org.codehaus.plexus.summit.exception
 
SummitException(String) - Constructor for exception org.codehaus.plexus.summit.exception.SummitException
 
SummitException(String, Throwable) - Constructor for exception org.codehaus.plexus.summit.exception.SummitException
 
SummitPipeline - Class in org.codehaus.plexus.summit.pipeline
Flexible implementation of a Pipeline.
SummitPipeline() - Constructor for class org.codehaus.plexus.summit.pipeline.SummitPipeline
 
SummitRequestParameterParser - Class in org.codehaus.plexus.summit.parameters
Summit implementation of a RequestParameterParser.
SummitRequestParameterParser() - Constructor for class org.codehaus.plexus.summit.parameters.SummitRequestParameterParser
 

T

TARGET - Static variable in interface org.codehaus.plexus.summit.SummitConstants
The target for a request.
TemplateLink - Class in org.codehaus.plexus.summit.pull.tools
A customized version of the UriBuilder to be used in Templates.
TemplateLink() - Constructor for class org.codehaus.plexus.summit.pull.tools.TemplateLink
Default constructor

The init method must be called before use.

TemplateLinkWithSlash - Class in org.codehaus.plexus.summit.pull.tools
This class allows one to specify paths in the setPage method using '/' slash as opposed to the ',' used in TemplateLink.
TemplateLinkWithSlash() - Constructor for class org.codehaus.plexus.summit.pull.tools.TemplateLinkWithSlash
Default constructor

The init method must be called before use.

TemplatePageAttributes - Class in org.codehaus.plexus.summit.pull.tools
Template context tool that will set various attributes of the HTML page.
TemplatePageAttributes() - Constructor for class org.codehaus.plexus.summit.pull.tools.TemplatePageAttributes
 
TemplateRenderer - Class in org.codehaus.plexus.summit.pull.tools
This class is a hack that allows you to render templates via the old Turbine 3 style.
TemplateRenderer() - Constructor for class org.codehaus.plexus.summit.pull.tools.TemplateRenderer
 
Tool - Class in org.codehaus.plexus.summit.pull
 
Tool() - Constructor for class org.codehaus.plexus.summit.pull.Tool
 
toString() - Method in class org.codehaus.plexus.summit.parameters.BaseParameterConverter
Provides a textual representation of the parameters represented by this object.
toString() - Method in class org.codehaus.plexus.summit.pull.tools.RelativeTemplateLink
Returns the URI.
toString() - Method in class org.codehaus.plexus.summit.pull.tools.TemplateLink
Returns the URI.
toString() - Method in class org.codehaus.plexus.summit.pull.tools.TemplatePageAttributes
A dummy toString method that returns an empty string.
toString() - Method in class org.codehaus.plexus.summit.util.UriBuilder
Builds the URL with all of the data URL-encoded as well as encoded using HttpServletResponse.encodeUrl().
toString(RunData) - Static method in class org.codehaus.plexus.summit.util.UriBuilder
Given a RunData object, get a URI for the request.
toString(RunData, boolean) - Static method in class org.codehaus.plexus.summit.util.UriBuilder
Given a RunData object, get a URI for the request.

U

UriBuilder - Class in org.codehaus.plexus.summit.util
This creates a Dynamic URI for use within the Turbine system

If you use this class to generate all of your href tags as well as all of your URI's, then you will not need to worry about having session data setup for you or using HttpServletRequest.encodeUrl() since this class does everything for you.

UriBuilder() - Constructor for class org.codehaus.plexus.summit.util.UriBuilder
Default constructor - the init() method must be called befroe use.
UriBuilder(RunData) - Constructor for class org.codehaus.plexus.summit.util.UriBuilder
Constructor that takes the RunData as an argument.

V

Valve - Interface in org.codehaus.plexus.summit.pipeline.valve
 
ValveInvocationException - Exception in org.codehaus.plexus.summit.pipeline.valve
 
ValveInvocationException(String) - Constructor for exception org.codehaus.plexus.summit.pipeline.valve.ValveInvocationException
 
ValveInvocationException(String, Throwable) - Constructor for exception org.codehaus.plexus.summit.pipeline.valve.ValveInvocationException
 
valves - Variable in class org.codehaus.plexus.summit.pipeline.AbstractPipeline
 
VelocityContextAdapter - Class in org.codehaus.plexus.summit.renderer
We use the Adapter pattern to create a wrapper around a ViewContext so that Velocity can use it as a Velocity Context to render the view.
VelocityContextAdapter(ViewContext) - Constructor for class org.codehaus.plexus.summit.renderer.VelocityContextAdapter
Constructor
VelocityRenderer - Class in org.codehaus.plexus.summit.renderer
A Renderer that can process Velocity templates.
VelocityRenderer() - Constructor for class org.codehaus.plexus.summit.renderer.VelocityRenderer
 
View - Interface in org.codehaus.plexus.summit.view
A View is a container for the name of a resolved view and anything else that might eventually be associated with a view.
VIEW_CONTEXT - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Tag for view context.
ViewContext - Interface in org.codehaus.plexus.summit.view
The collection of values that a native tool will use to render against.
viewExists(String) - Method in class org.codehaus.plexus.summit.renderer.AbstractRenderer
 
viewExists(String) - Method in interface org.codehaus.plexus.summit.renderer.Renderer
 
viewExists(String) - Method in class org.codehaus.plexus.summit.renderer.VelocityRenderer
Check the existence of a Velocity template.
ViewNotFoundException - Exception in org.codehaus.plexus.summit.view
Exception thrown when the requested View, or a default ViewViewNotFoundException(String) - Constructor for exception org.codehaus.plexus.summit.view.ViewNotFoundException
 
ViewNotFoundException(String, Throwable) - Constructor for exception org.codehaus.plexus.summit.view.ViewNotFoundException
 

W

WEB_CONTEXT - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Description of the Field
WEBAPP_ROOT - Static variable in interface org.codehaus.plexus.summit.SummitConstants
Description of the Field
writeEncoded(String, StringBuffer) - Static method in class org.codehaus.plexus.summit.util.UriBuilder
URL encodes in and writes it to out.
writeFastEncoded(String, StringBuffer) - Static method in class org.codehaus.plexus.summit.util.UriBuilder
URL encodes in and writes it to out.

A B C D E G H I K L N O P Q R S T U V W

Copyright © 2001-2006 Codehaus. All Rights Reserved.