org.apache.jetspeed.engine
Interface Engine

All Superinterfaces:
JetspeedEngineConstants

public interface Engine
extends JetspeedEngineConstants

Engine Abstraction - to run from both unit tests and servlet

Version:
$Id: Engine.java 187178 2004-08-02 19:00:15Z weaver $
Author:
David Sean Taylor

Field Summary
 
Fields inherited from interface org.apache.jetspeed.engine.JetspeedEngineConstants
APPLICATION_ROOT_DEFAULT, APPLICATION_ROOT_KEY, CONFIG_NAMESPACE, CONSOLE_LOGGER, DEFAULT_LOGGER, JETSPEED_PROPERTIES_DEFAULT, JETSPEED_PROPERTIES_KEY, JETSPEED_PROPERTIES_PATH_DEFAULT, JETSPEED_PROPERTIES_PATH_KEY, LOG4J_CONFIG_FILE, LOG4J_CONFIG_FILE_DEFAULT, LOGGING_ROOT, LOGGING_ROOT_DEFAULT, MAIL_SERVER_KEY, OVERRIDE_PROPERTIES, PIPELINE_CLASS, PIPELINE_DEFAULT, PIPELINE_DIRECTORY, SCHEDULER_LOG_FACILITY, SPRING_FILTER_KEY, SPRING_FILTER_KEY_DEFAULT, SPRING_FILTER_KEY_PROPERTIES, SPRING_FILTER_PROPERTIES, WEB_CONTEXT, WEBAPP_ROOT_KEY
 
Method Summary
 ComponentManager getComponentManager()
           
 PortalContext getContext()
          Get the Portal Context associated with running thread of the engine
 RequestContext getCurrentRequestContext()
          Returns the the RequestContext associated with the current thread.
 Pipeline getPipeline()
          Gets the engine's request default pipeline.
 Pipeline getPipeline(java.lang.String pipelineName)
          Gets the specified engine's request pipeline.
 java.lang.String getRealPath(java.lang.String path)
          Gets the real path to an application relative resource
 javax.servlet.ServletConfig getServletConfig()
          Get the servlet configuration if this engine is running under a servlet container.
 void service(RequestContext context)
          Makes a service request to the engine.
 void shutdown()
          Shuts down the Jetspeed engine and all associated services
 void start()
          Initializes the engine with a commons configuration, starting all early initable services.
 

Method Detail

start

void start()
           throws JetspeedException
Initializes the engine with a commons configuration, starting all early initable services.

Throws:
JetspeedException - when the engine fails to initilialize

shutdown

void shutdown()
              throws JetspeedException
Shuts down the Jetspeed engine and all associated services

Throws:
JetspeedException - when the engine fails to shutdown

service

void service(RequestContext context)
             throws JetspeedException
Makes a service request to the engine.

Parameters:
context - a RequestContext with the state of the request.
Throws:
JetspeedException - when the engine fails to initilialize

getPipeline

Pipeline getPipeline()
Gets the engine's request default pipeline.

Returns:
Pipeline The engine's request pipeline.

getPipeline

Pipeline getPipeline(java.lang.String pipelineName)
Gets the specified engine's request pipeline.

Returns:
Pipeline A specific request pipeline.

getContext

PortalContext getContext()
Get the Portal Context associated with running thread of the engine

Returns:
PortalContext associated with this engine's thread

getRealPath

java.lang.String getRealPath(java.lang.String path)
Gets the real path to an application relative resource

Parameters:
path - The application relative resource
Returns:
String The real path to that resource

getServletConfig

javax.servlet.ServletConfig getServletConfig()
Get the servlet configuration if this engine is running under a servlet container.

Returns:
config The servlet configuration

getCurrentRequestContext

RequestContext getCurrentRequestContext()
Returns the the RequestContext associated with the current thread. This can be accessed throught org.apache.jetspeed.Jetspeed environment class.

Returns:
RequestContext associated with the current thread.

getComponentManager

ComponentManager getComponentManager()


Copyright © 1999-2011 The Apache Software Foundation. All Rights Reserved.