jahiaapplicationsdispatchingservice.java

java 写的一个新闻发布系统

//
//  JahiaApplicationsService
//  EV      29.11.2000
//
//  getAppOutput( fieldID, appID, params )
//

package org.jahia.services.applications;

import javax.servlet.http.HttpSession;

import org.jahia.exceptions.JahiaException;
import org.jahia.exceptions.JahiaInitializationException;
import org.jahia.params.ParamBean;
import org.jahia.services.JahiaInitializableService;
import org.jahia.settings.JahiaPrivateSettings;

/**
 * This service generates the dispatching and aggregation on an application.
 * This functionality is central to the portal behavior of Jahia, allowing it
 * to display multiple applications on a web page and interact with them
 * simultaneously.
 * @author Serge Huber, Eric Vassalli
 * @version 1.0
 */
public abstract class JahiaApplicationsDispatchingService extends JahiaInitializableService
{

    public abstract void init (JahiaPrivateSettings jSettings ) throws JahiaInitializationException;

   /**
    * Dispatches processing to an application, and retrieves it's output for
    * Jahia to aggregate
    * @param fieldID identifier of Jahia's field
    * @param appIDStr application identifier passed as a String (converted
    * from an integer)
    * @param jParams Jahia's ParamBean object, containing the standard request /
    * response pair, the servlet context, and additional information
    * @return String containing the output of the application
    * @exception JahiaException generated if there was a problem dispatching,
    * during processing of the application, or when recuperating the application's
    * output.
    */
    public abstract String getAppOutput( int fieldID, String appIDStr, ParamBean jParams )   throws JahiaException;

    /**
     * Flushes all the application caches (output and request) for the session.
     * Use this function instead of the two below ones because this one is MUCH
     * faster if you have to do both.
     * @param session the session in which to purge the caches
     */
    public abstract void flushAllSessionsCaches(HttpSession session);

    /**
     * Flushes the application output cache stored in the session.
     * @param session the session in which to purge the caches
     */
    public abstract void flushSessionOutputCache(HttpSession session);

    /**
     * Flushes the application request cache stored in the session.
     * @param session the session in which to purge the caches
     */
    public abstract void flushSessionRequestCache(HttpSession session);

    /**
     * Flushes the application request cache stored in the session.
     * @param session the session in which to purge the caches
     * @param appUniqueIDStr
     */
    public abstract void flushApplicationSessionRequestCache(HttpSession session,
            String appUniqueIDStr );

    /**
     * if session is null flush all output entries for the given appID
     *
     * @param session
     * @param appUniqueIDStr
     */
    public abstract void flushOutputCacheByAppUniqueID(HttpSession session,
            String appUniqueIDStr);

    public abstract void setApplicationSessionRequestCache(HttpSession session,
            PersistantServletRequest request );

} // end JahiaApplicationsService