org.kohsuke.stapler

Class Facet

java.lang.Object

org.kohsuke.stapler.Facet

Direct Known Subclasses:

GroovyFacet, JellyFacet, JSPFacet, StaticViewFacet

public abstract class Facet
extends java.lang.Object

Aspect of stapler that brings in an optional language binding. Put MetaInfServices on subtypes so that Stapler can discover them.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
Facet()

Method Summary

Methods

Modifier and Type	Method and Description
void	buildFallbackDispatchers(MetaClass owner, java.util.List<Dispatcher> dispatchers) Adds Dispatchers that do catch-all behaviours like "doDispatch" does.
abstract 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, java.lang.Class type, java.lang.Object it, java.lang.String viewName)
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.
static java.util.List<Facet>	discover(java.lang.ClassLoader cl) Discovers all the facets in the classloader.
static <T> java.util.List<T>	discoverExtensions(java.lang.Class<T> type, java.lang.ClassLoader... cls)
Klass<?>	getKlass(java.lang.Object o) Maps an instance to a Klass.
abstract 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 java.lang.Object

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

Field Detail

LOGGER

public static final java.util.logging.Logger LOGGER

Constructor Detail

Facet

public Facet()

Method Detail

buildViewDispatchers

public abstract 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.

buildFallbackDispatchers

public void buildFallbackDispatchers(MetaClass owner,
                            java.util.List<Dispatcher> dispatchers)

Adds Dispatchers that do catch-all behaviours like "doDispatch" does.

discover

public static java.util.List<Facet> discover(java.lang.ClassLoader cl)

Discovers all the facets in the classloader.

discoverExtensions

public static <T> java.util.List<T> discoverExtensions(java.lang.Class<T> type,
                                       java.lang.ClassLoader... cls)

createRequestDispatcher

public javax.servlet.RequestDispatcher createRequestDispatcher(RequestImpl request,
                                                      Klass<?> type,
                                                      java.lang.Object it,
                                                      java.lang.String viewName)
                                                        throws java.io.IOException

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

Parameters:

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

Throws:

java.io.IOException

createRequestDispatcher

public javax.servlet.RequestDispatcher createRequestDispatcher(RequestImpl request,
                                                      java.lang.Class type,
                                                      java.lang.Object it,
                                                      java.lang.String viewName)
                                                        throws java.io.IOException

Throws:

java.io.IOException

handleIndexRequest

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

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

Returns:

true if the processing succeeds. Otherwise false.

Throws:

java.io.IOException

javax.servlet.ServletException

getKlass

public Klass<?> getKlass(java.lang.Object o)

Maps an instance to a Klass. This is the generalization of o.getClass(). This is for those languages that use something other than Class to represent the concept of a class. Those facets that are fine with o.getClass() should return null so that it gives other facets a chance to map it better.