org.kohsuke.stapler.jsp

Class JSPFacet

java.lang.Object

org.kohsuke.stapler.Facet

org.kohsuke.stapler.jsp.JSPFacet

@MetaInfServices
public class JSPFacet
extends Facet

Facet that adds JSP file support.

Author:

Kohsuke Kawaguchi

Field Summary

Fields inherited from class org.kohsuke.stapler.Facet

ALLOW_VIEW_NAME_PATH_TRAVERSAL, LOGGER

Constructor Summary

Constructors

Constructor and Description
JSPFacet()

Method Summary

Modifier and Type	Method and Description
void	buildViewDispatchers(MetaClass owner, List<Dispatcher> dispatchers) Adds Dispatchers that look at one token and binds that to the views associated with the 'it' object.
javax.servlet.RequestDispatcher	createRequestDispatcher(RequestImpl request, Klass type, Object it, String viewName) Creates a RequestDispatcher that handles the given view, or return null if no such view was found.
boolean	handleIndexRequest(RequestImpl req, ResponseImpl rsp, Object node, MetaClass nodeMetaClass) Attempts to route the HTTP request to the 'index' page of the 'it' object.

Methods inherited from class org.kohsuke.stapler.Facet

buildFallbackDispatchers, buildIndexDispatchers, createRequestDispatcher, createRequestDispatcher, createValidatingDispatcher, discover, discoverExtensions, getExtensionSuffix, getKlass, handleIndexRequest, isBasename

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSPFacet

public JSPFacet()

Method Detail

buildViewDispatchers

public void buildViewDispatchers(MetaClass owner,
                                 List<Dispatcher> dispatchers)

Description copied from class: Facet

Adds Dispatchers that look at one token and binds that to the views associated with the 'it' object.

Specified by:

buildViewDispatchers in class Facet

See Also:

Facet.createValidatingDispatcher(AbstractTearOff, ScriptExecutor)

createRequestDispatcher

public javax.servlet.RequestDispatcher createRequestDispatcher(RequestImpl request,
                                                               Klass type,
                                                               Object it,
                                                               String viewName)
                                                        throws IOException

Description copied from class: Facet

Creates a RequestDispatcher that handles the given view, or return null if no such view was found.

Overrides:

createRequestDispatcher in class Facet

type - If "it" is non-null, it.getClass(). Otherwise the class from which the view is searched.

Throws:

IOException

See Also:

Facet.createRequestDispatcher(AbstractTearOff, ScriptExecutor, Object, String)

handleIndexRequest

public boolean handleIndexRequest(RequestImpl req,
                                  ResponseImpl rsp,
                                  Object node,
                                  MetaClass nodeMetaClass)
                           throws IOException,
                                  javax.servlet.ServletException

Description copied from class: Facet

Attempts to route the HTTP request to the 'index' page of the 'it' object.

Specified by:

handleIndexRequest in class Facet

Returns:

true if the processing succeeds. Otherwise false.

Throws:

IOException

javax.servlet.ServletException

See Also:

Facet.handleIndexRequest(AbstractTearOff, ScriptExecutor, RequestImpl, ResponseImpl, Object)