org.kohsuke.stapler

Class StaticViewFacet

java.lang.Object

org.kohsuke.stapler.Facet

org.kohsuke.stapler.StaticViewFacet

public class StaticViewFacet
extends Facet

Author:

Kohsuke Kawaguchi

Field Summary

Fields inherited from class org.kohsuke.stapler.Facet

LOGGER

Constructor Summary

Constructors

Constructor and Description
StaticViewFacet(java.util.Collection<java.lang.String> allowedExtensions)
StaticViewFacet(java.lang.String... allowedExtensions)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtension(java.lang.String ext)
void	buildViewDispatchers(MetaClass owner, java.util.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, java.lang.Object it, java.lang.String viewName) Creates a RequestDispatcher that handles the given view, or return null if no such view was found.
protected java.net.URL	findResource(Klass c, java.lang.String fileName) Determines if this resource can be served
boolean	handleIndexRequest(RequestImpl req, ResponseImpl rsp, java.lang.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, createRequestDispatcher, discover, discoverExtensions, getKlass

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticViewFacet

public StaticViewFacet(java.lang.String... allowedExtensions)

StaticViewFacet

public StaticViewFacet(java.util.Collection<java.lang.String> allowedExtensions)

Method Detail

addExtension

public void addExtension(java.lang.String ext)

buildViewDispatchers

public void buildViewDispatchers(MetaClass owner,
                        java.util.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

findResource

protected java.net.URL findResource(Klass c,
                        java.lang.String fileName)

Determines if this resource can be served

createRequestDispatcher

public javax.servlet.RequestDispatcher createRequestDispatcher(RequestImpl request,
                                                      Klass<?> type,
                                                      java.lang.Object it,
                                                      java.lang.String viewName)
                                                        throws java.io.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:

java.io.IOException

handleIndexRequest

public boolean handleIndexRequest(RequestImpl req,
                         ResponseImpl rsp,
                         java.lang.Object node,
                         MetaClass nodeMetaClass)
                           throws java.io.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:

java.io.IOException

javax.servlet.ServletException