General Actions:
org.xwiki.action.Action
void execute() throws ActionException; void execute(Object additionalData) throws ActionException;
error
org.xwiki.action.ActionManager
/** * @exception ActionException when we haven't been able to use the error action to handle * the original exception */ void handleRequest() throws ActionException; /** * Force execution of a specific action. * @exception ActionException when we haven't been able to use the error action to handle * the original exception */ void handleRequest(String actionName) throws ActionException; void handleRequest(String actionName, Object additionalData) throws ActionException;
org.xwiki.cache.CacheFactory
/** * Create and return a custom cache. * * @param <T> the class of the data stored in the cache. * @param config the cache configuration. * @return a new {@link Cache}. * @throws CacheException error when creating the cache. */ <T> Cache<T> newCache(CacheConfiguration config) throws CacheException;
defaultjbosscache
jbosscache/local
oscache
oscache/local
org.xwiki.configuration.ConfigurationManager
void initializeConfiguration(Object configurationBean, List<ConfigurationSource> sources, String namespace) throws InitializationException;
org.xwiki.configuration.ConfigurationSourceCollection
void initializeConfiguration(Object configurationBean, List<ConfigurationSource> sources, String namespace) throws InitializationException;
defaultorg.xwiki.container.Container
ApplicationContext getApplicationContext(); void setApplicationContext(ApplicationContext context); Request getRequest(); void setRequest(Request request); void removeRequest(); void pushRequest(Request request); void popRequest(); Response getResponse(); void setResponse(Response response); void removeResponse(); void pushResponse(Response response); void popResponse(); Session getSession(); void setSession(Session session); void removeSession(); void pushSession(Session session); void popSession();
defaultorg.xwiki.container.RequestInitializerManager
/** * Perform initializations here, such as storing objects in the Request. * * @param request the XWiki Request object * @throws RequestInitializerException if the initialization fails. It's expected that the * application should stop if this happens. */ void initialize(Request request) throws RequestInitializerException;
defaultorg.xwiki.container.portlet.PortletContainerInitializer
void initializeRequest(javax.portlet.PortletRequest request, Object xwikiContext) throws PortletContainerException; void initializeResponse(javax.portlet.PortletResponse response); void initializeSession(javax.portlet.PortletRequest request); void initializeApplicationContext(PortletContext servletContext);
defaultorg.xwiki.container.servlet.ServletContainerInitializer
void initializeRequest(HttpServletRequest request, Object xwikiContext) throws ServletContainerException; void initializeRequest(HttpServletRequest request) throws ServletContainerException; void initializeResponse(HttpServletResponse response); void initializeSession(HttpServletRequest request); void initializeApplicationContext(ServletContext servletContext);
defaultorg.xwiki.context.Execution
ExecutionContext getContext(); void setContext(ExecutionContext context); void pushContext(ExecutionContext context); void popContext(); void removeContext();
defaultorg.xwiki.context.ExecutionContextInitializerManager
void initialize(ExecutionContext context) throws ExecutionContextInitializerException;defaultorg.xwiki.observation.ObservationManager
/** * Add a listener. * * @param event the event to register the listener against; acts as a template that filters out only specific events * the istener is interested in * @param eventListener the listener to register */ void addListener(Event event, EventListener eventListener); /** * Remove a listener from a specific event. * * @param event the event to remove the listener from. * @param eventListener the listener to remove. */ void removeListener(Event event, EventListener eventListener); /** * Remove a listener from all events it is registered by. Convenient way of cleaning up an listener object being * destroyed. * * @param eventListener the listener to remove. */ void removeListener(EventListener eventListener); /** * Call the registered listeners. The definition of <em>source</em> and <em>data</em> is purely up to the * communicating classes. * * @param event the event to pass to the registered listeners * @param source the source of the event (or <code>null</code>) * @param data the additional data related to the event (or <code>null</code>) */ void notify(Event event, Object source, Object data); /** * Convenience front-end where the additional data parameter is <code>null</code>. * * @param event the event to pass to the registered listeners * @param source the source of the event (or <code>null</code>) * @see #notify(org.xwiki.observation.event.Event, Object, Object) */ void notify(Event event, Object source);