You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@turbine.apache.org by tv...@apache.org on 2015/10/01 15:18:37 UTC
svn commit: r1706239 [1/4] - in /turbine/core/trunk/src:
java/org/apache/turbine/ java/org/apache/turbine/modules/
java/org/apache/turbine/modules/actions/
java/org/apache/turbine/modules/layouts/
java/org/apache/turbine/modules/navigations/ java/org/a...
Author: tv
Date: Thu Oct 1 13:18:35 2015
New Revision: 1706239
URL: http://svn.apache.org/viewvc?rev=1706239&view=rev
Log:
Cleanup JavaDoc and do some minor refactorings
Modified:
turbine/core/trunk/src/java/org/apache/turbine/Turbine.java
turbine/core/trunk/src/java/org/apache/turbine/modules/Action.java
turbine/core/trunk/src/java/org/apache/turbine/modules/ActionEvent.java
turbine/core/trunk/src/java/org/apache/turbine/modules/GenericLoader.java
turbine/core/trunk/src/java/org/apache/turbine/modules/Layout.java
turbine/core/trunk/src/java/org/apache/turbine/modules/Loader.java
turbine/core/trunk/src/java/org/apache/turbine/modules/Navigation.java
turbine/core/trunk/src/java/org/apache/turbine/modules/NavigationLoader.java
turbine/core/trunk/src/java/org/apache/turbine/modules/Page.java
turbine/core/trunk/src/java/org/apache/turbine/modules/PageLoader.java
turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJob.java
turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJobLoader.java
turbine/core/trunk/src/java/org/apache/turbine/modules/ScreenLoader.java
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/AccessController.java
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/DefaultAction.java
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/LogoutUser.java
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocityAction.java
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocitySecureAction.java
turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/DirectResponseLayout.java
turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/JspLayout.java
turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java
turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityDirectLayout.java
turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityOnlyLayout.java
turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityXslLayout.java
turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/BaseJspNavigation.java
turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/TemplateNavigation.java
turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/VelocityNavigation.java
turbine/core/trunk/src/java/org/apache/turbine/modules/pages/DefaultPage.java
turbine/core/trunk/src/java/org/apache/turbine/modules/pages/VelocityPage.java
turbine/core/trunk/src/java/org/apache/turbine/modules/screens/BaseJspScreen.java
turbine/core/trunk/src/java/org/apache/turbine/modules/screens/Error.java
turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityCachedScreen.java
turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityDirectScreen.java
turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityScreen.java
turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocitySecureScreen.java
turbine/core/trunk/src/java/org/apache/turbine/om/OMTool.java
turbine/core/trunk/src/java/org/apache/turbine/om/Retriever.java
turbine/core/trunk/src/java/org/apache/turbine/om/RetrieverFactory.java
turbine/core/trunk/src/java/org/apache/turbine/om/security/DefaultUserImpl.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/AbstractValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/CleanUpValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultACLCreationValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultLoginValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultPipelineData.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionTimeoutValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionValidationValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineActionValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineRedirectRequestedValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineTargetValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/ExecutePageValve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/Pipeline.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/TurbinePipeline.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/Valve.java
turbine/core/trunk/src/java/org/apache/turbine/pipeline/ValveContext.java
turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitable.java
turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitableBroker.java
turbine/core/trunk/src/java/org/apache/turbine/services/BaseServiceBroker.java
turbine/core/trunk/src/java/org/apache/turbine/services/BaseUnicastRemoteService.java
turbine/core/trunk/src/java/org/apache/turbine/services/Initable.java
turbine/core/trunk/src/java/org/apache/turbine/services/InitableBroker.java
turbine/core/trunk/src/java/org/apache/turbine/services/ServiceManager.java
turbine/core/trunk/src/java/org/apache/turbine/services/TurbineBaseService.java
turbine/core/trunk/src/java/org/apache/turbine/services/TurbineServiceProvider.java
turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/AssemblerFactory.java
turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/java/JavaBaseFactory.java
turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/python/PythonBaseFactory.java
turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineAvalonComponentService.java
turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineYaafiComponentService.java
turbine/core/trunk/src/java/org/apache/turbine/services/intake/IntakeTool.java
turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JSONProcessor.java
turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JsonRpcService.java
turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpc.java
turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpcService.java
turbine/core/trunk/src/java/org/apache/turbine/services/jsp/util/JspNavigation.java
turbine/core/trunk/src/java/org/apache/turbine/services/localization/LocalizationTool.java
turbine/core/trunk/src/java/org/apache/turbine/services/naming/NamingService.java
turbine/core/trunk/src/java/org/apache/turbine/services/pull/PullService.java
turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePull.java
turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePullService.java
turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/ContentTool.java
turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/TemplateLink.java
turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/UITool.java
turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/DateFormatter.java
turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/SessionData.java
turbine/core/trunk/src/java/org/apache/turbine/services/rundata/DefaultTurbineRunData.java
turbine/core/trunk/src/java/org/apache/turbine/services/rundata/TurbineRunDataService.java
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/AbstractJobEntry.java
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobEntryQuartz.java
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobQueue.java
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/SchedulerTool.java
turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultUserManager.java
turbine/core/trunk/src/java/org/apache/turbine/services/security/SecurityService.java
turbine/core/trunk/src/java/org/apache/turbine/services/security/TurbineSecurity.java
turbine/core/trunk/src/java/org/apache/turbine/services/security/UserManager.java
turbine/core/trunk/src/java/org/apache/turbine/services/security/passive/PassiveUserManager.java
turbine/core/trunk/src/java/org/apache/turbine/services/servlet/TurbineServlet.java
turbine/core/trunk/src/java/org/apache/turbine/services/session/SessionTool.java
turbine/core/trunk/src/java/org/apache/turbine/services/session/TurbineSession.java
turbine/core/trunk/src/java/org/apache/turbine/services/template/TemplateEngineService.java
turbine/core/trunk/src/java/org/apache/turbine/services/template/TemplateService.java
turbine/core/trunk/src/java/org/apache/turbine/services/template/TurbineTemplate.java
turbine/core/trunk/src/java/org/apache/turbine/services/template/TurbineTemplateService.java
turbine/core/trunk/src/java/org/apache/turbine/services/template/mapper/BaseMapper.java
turbine/core/trunk/src/java/org/apache/turbine/services/template/mapper/Mapper.java
turbine/core/trunk/src/java/org/apache/turbine/services/ui/TurbineUI.java
turbine/core/trunk/src/java/org/apache/turbine/services/ui/UIService.java
turbine/core/trunk/src/java/org/apache/turbine/services/uniqueid/TurbineUniqueIdService.java
turbine/core/trunk/src/java/org/apache/turbine/services/uniqueid/UniqueIdService.java
turbine/core/trunk/src/java/org/apache/turbine/util/BrowserDetector.java
turbine/core/trunk/src/java/org/apache/turbine/util/DateSelector.java
turbine/core/trunk/src/java/org/apache/turbine/util/GenerateUniqueId.java
turbine/core/trunk/src/java/org/apache/turbine/util/HttpUtils.java
turbine/core/trunk/src/java/org/apache/turbine/util/SecurityCheck.java
turbine/core/trunk/src/java/org/apache/turbine/util/TimeSelector.java
turbine/core/trunk/src/java/org/apache/turbine/util/TurbineConfig.java
turbine/core/trunk/src/java/org/apache/turbine/util/TurbineXmlConfig.java
turbine/core/trunk/src/java/org/apache/turbine/util/template/HtmlPageAttributes.java
turbine/core/trunk/src/java/org/apache/turbine/util/template/SelectorBox.java
turbine/core/trunk/src/java/org/apache/turbine/util/template/TemplateInfo.java
turbine/core/trunk/src/java/org/apache/turbine/util/template/TemplateNavigation.java
turbine/core/trunk/src/java/org/apache/turbine/util/template/TemplateScreen.java
turbine/core/trunk/src/java/org/apache/turbine/util/velocity/VelocityActionEvent.java
turbine/core/trunk/src/java/org/apache/turbine/util/velocity/VelocityEmail.java
turbine/core/trunk/src/java/org/apache/turbine/util/velocity/VelocityHtmlEmail.java
turbine/core/trunk/src/test-cactus/org/apache/turbine/modules/screens/ErrorTest.java
turbine/core/trunk/src/test/org/apache/turbine/modules/actions/VelocityActionDoesNothing.java
turbine/core/trunk/src/test/org/apache/turbine/modules/actions/VelocityActionThrowsException.java
turbine/core/trunk/src/test/org/apache/turbine/modules/actions/VelocityActionWithServiceInjection.java
Modified: turbine/core/trunk/src/java/org/apache/turbine/Turbine.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/Turbine.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/Turbine.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/Turbine.java Thu Oct 1 13:18:35 2015
@@ -180,6 +180,7 @@ public class Turbine
*
* @exception ServletException a servlet exception.
*/
+ @Override
public void init() throws ServletException
{
synchronized (Turbine.class)
@@ -303,20 +304,20 @@ public class Turbine
null);
if (StringUtils.isNotEmpty(confFile))
{
- confStyle = "XML";
+ confStyle = "XML";
} else // // second test
{
confFile = findInitParameter(context, config,
TurbineConfig.PROPERTIES_PATH_KEY,
- null);
- if (StringUtils.isNotEmpty((confFile)) )
+ null);
+ if (StringUtils.isNotEmpty((confFile)) )
{
confStyle = "Properties";
}
}
// more tests ..
// last test
- if (confStyle.equals( "unset" ))
+ if (confStyle.equals( "unset" ))
{ // last resort
confFile = findInitParameter(context, config,
TurbineConfig.PROPERTIES_PATH_KEY,
@@ -324,15 +325,15 @@ public class Turbine
confStyle = "Properties";
}
// now begin loading
- if (!confStyle.equals( "unset" ))
+ if (!confStyle.equals( "unset" ))
{
if (confStyle.equals( "XML" )) {
- if (confFile.startsWith( "/" ))
+ if (confFile.startsWith( "/" ))
{
confFile = confFile.substring( 1 ); // cft. RFC2396 should not start with a slash, if not absolute path
}
DefaultConfigurationBuilder configurationBuilder = new DefaultConfigurationBuilder(confFile);
- confPath = new File(applicationRoot).toURI().toString();// relative base path used for this and child configuration files
+ confPath = new File(applicationRoot).toURI().toString();// relative base path used for this and child configuration files
configurationBuilder.setBasePath(confPath);
configuration = configurationBuilder.getConfiguration();
} else {
@@ -481,7 +482,7 @@ public class Turbine
* <li>The directory to write the log files to (relative to the
* web application root), or <code>null</code> for the default of
* <code>/logs</code>. The directory is specified via the {@link
- * TurbineConstants#LOGGING_ROOT} parameter.</li>
+ * TurbineConstants#LOGGING_ROOT_KEY} parameter.</li>
*
* </ul>
*
@@ -738,6 +739,7 @@ public class Turbine
* The <code>Servlet</code> destroy method. Invokes
* <code>ServiceBroker</code> tear down method.
*/
+ @Override
public void destroy()
{
// Shut down all Turbine Services.
@@ -756,6 +758,7 @@ public class Turbine
* @exception IOException a servlet exception.
* @exception ServletException a servlet exception.
*/
+ @Override
public void doGet(HttpServletRequest req, HttpServletResponse res)
throws IOException, ServletException
{
@@ -834,6 +837,7 @@ public class Turbine
* @exception IOException a servlet exception.
* @exception ServletException a servlet exception.
*/
+ @Override
public void doPost(HttpServletRequest req, HttpServletResponse res)
throws IOException, ServletException
{
@@ -845,6 +849,7 @@ public class Turbine
*
* @return a string with the servlet information.
*/
+ @Override
public String getServletInfo()
{
return "Turbine Servlet";
@@ -859,7 +864,7 @@ public class Turbine
* including the servlet engine log file, the Turbine log file and
* on the screen.
*
- * @param data A Turbine PipelineData object.
+ * @param pipelineData A Turbine PipelineData object.
* @param res Servlet response.
* @param t The exception to report.
*/
@@ -958,7 +963,7 @@ public class Turbine
/**
* Save some information about this servlet so that
* it can be utilized by object instances that do not
- * have direct access to RunData.
+ * have direct access to PipelineData.
*
* @param data Turbine request data
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/Action.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/Action.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/Action.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/Action.java Thu Oct 1 13:18:35 2015
@@ -53,9 +53,9 @@ public abstract class Action extends Ass
/**
* A subclass must override this method to perform itself. The
- * Action can also set the screen that is associated with RunData.
+ * Action can also set the screen that is associated with {@link PipelineData}.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
public abstract void doPerform(PipelineData pipelineData) throws Exception;
@@ -65,7 +65,7 @@ public abstract class Action extends Ass
* functionality. This method is protected to force clients to
* use ActionLoader to perform an Action.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
protected void perform(PipelineData pipelineData) throws Exception
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/ActionEvent.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/ActionEvent.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/ActionEvent.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/ActionEvent.java Thu Oct 1 13:18:35 2015
@@ -190,7 +190,7 @@ public abstract class ActionEvent extend
* doEvent() method. If that fails, then it will execute the
* doPerform() method instead.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/GenericLoader.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/GenericLoader.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/GenericLoader.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/GenericLoader.java Thu Oct 1 13:18:35 2015
@@ -36,7 +36,7 @@ import org.apache.turbine.services.assem
* @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
* @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
* @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
- * @version $Id$
+ * @param <T> the specialized assembler type
*/
public abstract class GenericLoader<T extends Assembler>
{
@@ -63,6 +63,8 @@ public abstract class GenericLoader<T ex
/**
* Attempts to load and execute the external action that has been
* set.
+ * @param pipelineData the Turbine request
+ * @param name the name of the assembler module
* @exception Exception a generic exception.
*/
public abstract void exec(PipelineData pipelineData, String name)
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/Layout.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/Layout.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/Layout.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/Layout.java Thu Oct 1 13:18:35 2015
@@ -55,7 +55,7 @@ public abstract class Layout
/**
* A subclass must override this method to perform itself. The
* Action can also set the screen that is associated with PipelineData.
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
protected abstract void doBuild(PipelineData pipelineData) throws Exception;
@@ -65,7 +65,7 @@ public abstract class Layout
* functionality. This method is protected to force clients to
* use ActionLoader to perform an Action.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
protected void build(PipelineData pipelineData) throws Exception
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/Loader.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/Loader.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/Loader.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/Loader.java Thu Oct 1 13:18:35 2015
@@ -24,9 +24,8 @@ package org.apache.turbine.modules;
* A common interface for Screen, Layout and Navigation Loader
*
* @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
- * @version $Id$
+ * @param <T> the specialized assembler type
*/
-
public interface Loader<T extends Assembler>
{
/**
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/Navigation.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/Navigation.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/Navigation.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/Navigation.java Thu Oct 1 13:18:35 2015
@@ -60,7 +60,7 @@ public abstract class Navigation
* RunData or to write the navigation to the output stream
* referenced in RunData.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
protected abstract ConcreteElement doBuild(PipelineData pipelineData) throws Exception;
@@ -70,7 +70,7 @@ public abstract class Navigation
* functionality. This method is protected to force clients to
* use NavigationLoader to build a Navigation.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
protected ConcreteElement build(PipelineData pipelineData)
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/NavigationLoader.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/NavigationLoader.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/NavigationLoader.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/NavigationLoader.java Thu Oct 1 13:18:35 2015
@@ -55,8 +55,9 @@ public class NavigationLoader
* value. This allows you to easily chain the execution of
* Navigation modules together.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param name Name of object that will execute the navigation.
+ * @return the navigation module output
* @exception Exception a generic exception.
*/
public ConcreteElement eval(PipelineData pipelineData, String name)
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/Page.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/Page.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/Page.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/Page.java Thu Oct 1 13:18:35 2015
@@ -57,7 +57,7 @@ public abstract class Page
* A subclass must override this method to build itself.
* Subclasses override this method to store the page in PipelineData or
* to write the page to the output stream referenced in PipelineData.
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
protected abstract void doBuild(PipelineData pipelineData) throws Exception;
@@ -67,7 +67,7 @@ public abstract class Page
* functionality. This method is protected to force clients to
* use PageLoader to build a Page.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
protected void build(PipelineData pipelineData)
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/PageLoader.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/PageLoader.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/PageLoader.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/PageLoader.java Thu Oct 1 13:18:35 2015
@@ -50,7 +50,7 @@ public class PageLoader
/**
* Attempts to load and execute the external page.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param name Name of object that will execute the page.
* @exception Exception a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJob.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJob.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJob.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJob.java Thu Oct 1 13:18:35 2015
@@ -38,11 +38,11 @@ public abstract class ScheduledJob exten
{
/** Prefix for scheduler job related classes */
public static final String PREFIX = "scheduledjobs";
-
- /** The key for the schedulder job cache size if module caching is on. */
+
+ /** The key for the scheduler job cache size if module caching is on. */
public static final String CACHE_SIZE_KEY = "scheduledjob.cache.size";
-
- /** The default size of the schedulder job cache if module caching is on. */
+
+ /** The default size of the scheduler job cache if module caching is on. */
public static final int CACHE_SIZE_DEFAULT = 10;
/** Represents Scheduled Job Objects */
@@ -51,6 +51,7 @@ public abstract class ScheduledJob exten
/**
* @see org.apache.turbine.modules.Assembler#getPrefix()
*/
+ @Override
public String getPrefix()
{
return PREFIX;
@@ -60,6 +61,7 @@ public abstract class ScheduledJob exten
* Run the Jobentry from the scheduler queue.
*
* @param job The job to run.
+ * @throws Exception if something goes wrong
*/
public abstract void run(JobEntry job)
throws Exception;
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJobLoader.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJobLoader.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJobLoader.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/ScheduledJobLoader.java Thu Oct 1 13:18:35 2015
@@ -72,14 +72,14 @@ public class ScheduledJobLoader
* independently of an HTTP request. This should not extend
* GenericLoader! Thoughts??
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param name Name of object that will execute the job.
* @exception Exception a generic exception.
* @deprecated
*/
@Deprecated
@Override
- public void exec(PipelineData data, String name)
+ public void exec(PipelineData pipelineData, String name)
throws Exception
{
throw new Exception("PipelineData objects not accepted for Scheduled jobs");
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/ScreenLoader.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/ScreenLoader.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/ScreenLoader.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/ScreenLoader.java Thu Oct 1 13:18:35 2015
@@ -57,8 +57,9 @@ public class ScreenLoader
* This allows you to easily chain the execution of Screen modules
* together.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param name Name of object that will execute the screen.
+ * @return the output of the screen module
* @exception Exception a generic exception.
*/
public ConcreteElement eval(PipelineData pipelineData, String name)
@@ -73,7 +74,7 @@ public class ScreenLoader
* want to execute a Screen which returns its output via the
* data.getPage() object.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param name Name of object that will execute the screen.
* @exception Exception a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/actions/AccessController.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/actions/AccessController.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/actions/AccessController.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/actions/AccessController.java Thu Oct 1 13:18:35 2015
@@ -84,7 +84,7 @@ public class AccessController
* <code>TurbineSecurity.getACL()</code> and added to the current
* session.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception FulcrumSecurityException problem with the security service.
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/actions/DefaultAction.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/actions/DefaultAction.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/actions/DefaultAction.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/actions/DefaultAction.java Thu Oct 1 13:18:35 2015
@@ -38,7 +38,7 @@ public class DefaultAction extends Actio
/**
* Execute the action.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @throws Exception a generic exception.
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/actions/LogoutUser.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/actions/LogoutUser.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/actions/LogoutUser.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/actions/LogoutUser.java Thu Oct 1 13:18:35 2015
@@ -64,7 +64,7 @@ public class LogoutUser
* that the session validator does handle setting the screen/template
* for a logged out (read not-logged-in) user.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception FulcrumSecurityException a problem occurred in the security
* service.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocityAction.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocityAction.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocityAction.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocityAction.java Thu Oct 1 13:18:35 2015
@@ -44,7 +44,7 @@ public abstract class VelocityAction ext
/**
* You SHOULD NOT override this method and implement it in your action.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @throws Exception a generic exception.
*/
@Override
@@ -67,7 +67,7 @@ public abstract class VelocityAction ext
/**
* You SHOULD override this method and implement it in your action.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param context Context for web pages.
* @throws Exception a generic exception.
*/
@@ -81,7 +81,7 @@ public abstract class VelocityAction ext
* action.event.bubbleexception is true, then it bubbles it farther up, or
* traps it there.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @throws Exception a generic exception.
*/
@Override
@@ -104,7 +104,7 @@ public abstract class VelocityAction ext
* This method is used when you want to short circuit an Action and change
* the template that will be executed next.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param template The template that will be executed next.
*/
public void setTemplate(PipelineData pipelineData, String template)
@@ -115,7 +115,7 @@ public abstract class VelocityAction ext
/**
* Return the Context needed by Velocity.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return Context, a context for web pages.
*/
protected Context getContext(PipelineData pipelineData)
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocitySecureAction.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocitySecureAction.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocitySecureAction.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/actions/VelocitySecureAction.java Thu Oct 1 13:18:35 2015
@@ -46,7 +46,7 @@ public abstract class VelocitySecureActi
/**
* Implement this to add information to the context.
* Should revert to abstract when RunData has gone.
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param context Context for web pages.
* @throws Exception a generic exception.
*/
@@ -62,7 +62,7 @@ public abstract class VelocitySecureActi
* This method overrides the method in WebMacroSiteAction to
* perform a security check first.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @throws Exception a generic exception.
*/
@Override
@@ -79,7 +79,7 @@ public abstract class VelocitySecureActi
* You should set the template in this method that you want the
* user to be sent to if they're unauthorized.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return True if the user is authorized to access the screen.
* @throws Exception a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/DirectResponseLayout.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/DirectResponseLayout.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/DirectResponseLayout.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/DirectResponseLayout.java Thu Oct 1 13:18:35 2015
@@ -39,7 +39,7 @@ public class DirectResponseLayout extend
/**
* Ensures that a direct response has been declared.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception TurbineException if a direct response has not been declared.
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/JspLayout.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/JspLayout.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/JspLayout.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/JspLayout.java Thu Oct 1 13:18:35 2015
@@ -52,7 +52,7 @@ public class JspLayout
/**
* Method called by LayoutLoader.
*
- * @param data PipelineData
+ * @param pipelineData PipelineData
* @throws Exception generic exception
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java Thu Oct 1 13:18:35 2015
@@ -58,7 +58,7 @@ public class VelocityCachedLayout
* Method called by LayoutLoader.
*
*
- * @param data PipelineData
+ * @param pipelineData PipelineData
* @throws Exception generic exception
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityDirectLayout.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityDirectLayout.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityDirectLayout.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityDirectLayout.java Thu Oct 1 13:18:35 2015
@@ -64,7 +64,7 @@ public class VelocityDirectLayout
* Method called by LayoutLoader.
*
*
- * @param data PipelineData
+ * @param pipelineData PipelineData
* @throws Exception generic exception
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityOnlyLayout.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityOnlyLayout.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityOnlyLayout.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityOnlyLayout.java Thu Oct 1 13:18:35 2015
@@ -90,7 +90,7 @@ public class VelocityOnlyLayout
* of the HttpServletResponse object.
*
*
- * @param data PipelineData
+ * @param pipelineData PipelineData
* @throws Exception generic exception
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityXslLayout.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityXslLayout.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityXslLayout.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityXslLayout.java Thu Oct 1 13:18:35 2015
@@ -82,7 +82,7 @@ public class VelocityXslLayout extends L
* Build the layout. Also sets the ContentType and Locale headers
* of the HttpServletResponse object.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception a generic exception.
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/BaseJspNavigation.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/BaseJspNavigation.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/BaseJspNavigation.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/BaseJspNavigation.java Thu Oct 1 13:18:35 2015
@@ -50,7 +50,7 @@ public class BaseJspNavigation
/**
* Method to be overridden by subclasses to include data in beans, etc.
*
- * @param data the PipelineData object
+ * @param pipelineData the PipelineData object
* @throws Exception a generic exception.
*/
@Override
@@ -63,7 +63,7 @@ public class BaseJspNavigation
/**
* Method that sets up beans and forward the request to the JSP.
*
- * @param data the PipelineData object
+ * @param pipelineData the PipelineData object
* @return null - the JSP sends the information
* @throws Exception a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/TemplateNavigation.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/TemplateNavigation.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/TemplateNavigation.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/TemplateNavigation.java Thu Oct 1 13:18:35 2015
@@ -40,7 +40,7 @@ public abstract class TemplateNavigation
* method to perform any particular business logic and add
* information to the context.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @throws Exception a generic exception.
*/
protected abstract void doBuildTemplate(PipelineData pipelineData) throws Exception;
@@ -56,7 +56,7 @@ public abstract class TemplateNavigation
/**
* Calls doBuildTemplate() and then buildTemplate().
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return A ConcreteElement.
* @throws Exception a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/VelocityNavigation.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/VelocityNavigation.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/VelocityNavigation.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/navigations/VelocityNavigation.java Thu Oct 1 13:18:35 2015
@@ -63,7 +63,7 @@ public class VelocityNavigation
* method to perform any particular business logic and add
* information to the context.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param context Context for web pages.
* @exception Exception, a generic exception.
*/
@@ -92,7 +92,7 @@ public class VelocityNavigation
/**
* This builds the Velocity template.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return A ConcreteElement.
* @exception Exception, a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/pages/DefaultPage.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/pages/DefaultPage.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/pages/DefaultPage.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/pages/DefaultPage.java Thu Oct 1 13:18:35 2015
@@ -116,7 +116,7 @@ public class DefaultPage
/**
* Builds the Page.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception, a generic exception.
*/
@Override
@@ -181,7 +181,7 @@ public class DefaultPage
* PipelineData so that it is available to the Action module and the
* Screen module via getContext(). It does nothing here.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception, a generic exception.
*/
protected void doBuildBeforeAction(PipelineData pipelineData)
@@ -194,7 +194,7 @@ public class DefaultPage
* Can be overridden by template Pages to set up data needed to
* process a template. It does nothing here.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception, a generic exception.
*/
protected void doBuildAfterAction(PipelineData pipelineData)
@@ -207,7 +207,7 @@ public class DefaultPage
* Can be overridden to perform actions when the request is
* fully processed. It does nothing here.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception, a generic exception.
*/
protected void doPostBuild(PipelineData pipelineData)
@@ -223,7 +223,7 @@ public class DefaultPage
* Html40Transitional, or Html40Frameset. Additionally the
* default can be supplied as two strings giving the dtd and uri.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception, a generic exception.
*/
private void setDefaultDoctype(RunData data)
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/pages/VelocityPage.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/pages/VelocityPage.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/pages/VelocityPage.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/pages/VelocityPage.java Thu Oct 1 13:18:35 2015
@@ -47,7 +47,7 @@ public class VelocityPage
* Stuffs the Context into the PipelineData so that it is available to
* the Action module and the Screen module via getContext().
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception, a generic exception.
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/screens/BaseJspScreen.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/screens/BaseJspScreen.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/screens/BaseJspScreen.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/screens/BaseJspScreen.java Thu Oct 1 13:18:35 2015
@@ -54,7 +54,7 @@ public class BaseJspScreen
/**
* Method that sets up beans and forward the request to the JSP.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return null - the JSP sends the information.
* @exception Exception, a generic exception.
*/
@@ -85,7 +85,7 @@ public class BaseJspScreen
/**
* Method to be overridden by subclasses to include data in beans, etc.
*
- * @param data, the PipelineData object
+ * @param pipelineData the PipelineData object
* @exception Exception, a generic exception.
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/screens/Error.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/screens/Error.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/screens/Error.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/screens/Error.java Thu Oct 1 13:18:35 2015
@@ -46,7 +46,7 @@ public class Error extends Screen
/**
* Build screen.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return ConcreteElement the page with all the error information.
* @throws Exception a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityCachedScreen.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityCachedScreen.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityCachedScreen.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityCachedScreen.java Thu Oct 1 13:18:35 2015
@@ -46,7 +46,7 @@ public class VelocityCachedScreen
/**
* This builds the Velocity template.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return A ConcreteElement.
* @exception Exception, a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityDirectScreen.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityDirectScreen.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityDirectScreen.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityDirectScreen.java Thu Oct 1 13:18:35 2015
@@ -47,7 +47,7 @@ public class VelocityDirectScreen
/**
* This builds the Velocity template.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return A ConcreteElement.
* @exception Exception, a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityScreen.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityScreen.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityScreen.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocityScreen.java Thu Oct 1 13:18:35 2015
@@ -87,7 +87,7 @@ public class VelocityScreen
* actual method that you should override is the one with the
* context in the parameter list.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception, a generic exception.
*/
@Override
Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocitySecureScreen.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocitySecureScreen.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocitySecureScreen.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/screens/VelocitySecureScreen.java Thu Oct 1 13:18:35 2015
@@ -45,7 +45,7 @@ public abstract class VelocitySecureScre
/**
* Implement this to add information to the context.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @param context Context for web pages.
* @exception Exception, a generic exception.
*/
@@ -58,7 +58,7 @@ public abstract class VelocitySecureScre
* This method overrides the method in VelocityScreen to
* perform a security check first.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @exception Exception, a generic exception.
*/
@Override
@@ -77,7 +77,7 @@ public abstract class VelocitySecureScre
* user to be sent to if they're unauthorized. See the
* VelocitySecurityCheck utility.
*
- * @param data Turbine information.
+ * @param pipelineData Turbine information.
* @return True if the user is authorized to access the screen.
* @exception Exception, a generic exception.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/om/OMTool.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/om/OMTool.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/om/OMTool.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/om/OMTool.java Thu Oct 1 13:18:35 2015
@@ -1,6 +1,5 @@
package org.apache.turbine.om;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -20,11 +19,11 @@ package org.apache.turbine.om;
* under the License.
*/
-
-import java.util.HashMap;
-import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
import org.apache.fulcrum.pool.Recyclable;
+import org.apache.turbine.Turbine;
import org.apache.turbine.services.pull.ApplicationTool;
/**
@@ -36,8 +35,7 @@ import org.apache.turbine.services.pull.
*/
public class OMTool implements ApplicationTool, Recyclable
{
- // private RunData data;
- protected HashMap<String, Object> omMap;
+ protected ConcurrentHashMap<String, Object> omMap;
// note the following could be a static attribute to reduce memory
// footprint. Might require a service to front load the
@@ -45,7 +43,8 @@ public class OMTool implements Applicati
// though
/** The cache of PullHelpers. **/
- private static Map<String, OMTool.PullHelper> pullMap = new HashMap<String, OMTool.PullHelper>();
+ private ConcurrentMap<String, OMTool.PullHelper> pullMap =
+ new ConcurrentHashMap<String, OMTool.PullHelper>();
/**
* The Factory responsible for retrieving the
@@ -53,27 +52,33 @@ public class OMTool implements Applicati
*/
protected RetrieverFactory omFactory;
- public OMTool()throws Exception
+ /**
+ * Default constructor
+ * @throws Exception if creating the factory fails
+ */
+ public OMTool() throws Exception
{
- omMap = new HashMap<String, Object>();
- //String className = Turbine.getConfiguration()
- // .getString("tool.om.factory");
- // RetrieverFactory omFactory =
- // (RetrieverFactory)Class.forName(className).newInstance();
+ omMap = new ConcurrentHashMap<String, Object>();
+ String className = Turbine.getConfiguration().getString("tool.om.factory");
+ this.omFactory = (RetrieverFactory)Class.forName(className).newInstance();
}
/**
* Prepares tool for a single request
+ *
+ * @param data the initialization data
*/
- public void init(Object runData)
+ @Override
+ public void init(Object data)
{
- // data = (RunData)runData;
+ // data = (RunData)data;
}
/**
* Implementation of ApplicationTool interface is not needed for this
* method as the tool is request scoped
*/
+ @Override
public void refresh()
{
// empty
@@ -95,8 +100,8 @@ public class OMTool implements Applicati
throws Exception
{
Object om = null;
-
String inputKey = omName + key;
+
if (omMap.containsKey(inputKey))
{
om = omMap.get(inputKey);
@@ -111,34 +116,29 @@ public class OMTool implements Applicati
}
}
- public Object get(String omName) throws Exception
+ /**
+ * Get the {@link PullHelper} object with the given name
+ * @param omName the object name
+ * @return the PullHelper
+ * @throws Exception if retrieving the object fails
+ */
+ public PullHelper get(String omName) throws Exception
{
- if (!pullMap.containsKey(omName))
- {
- // MT could overwrite a PullHelper, but that is not a problem
- // should still synchronize to avoid two threads adding at
- // same time
- synchronized (this.getClass())
- {
- pullMap.put(omName, new OMTool.PullHelper(omName));
- }
- }
-
- return pullMap.get(omName);
+ return pullMap.putIfAbsent(omName, new OMTool.PullHelper(omName));
}
+ /**
+ * Get the object with the given name and key
+ * @param omName the object name
+ * @param key the object key
+ * @return the object
+ * @throws Exception if retrieving the object fails
+ */
public Object get(String omName, String key) throws Exception
{
- return ((OMTool.PullHelper) get(omName)).setKey(key);
+ return get(omName).setKey(key);
}
-
- public String getName()
- {
- return "om";
- }
-
-
// ****************** Recyclable implementation ************************
private boolean disposed;
@@ -153,6 +153,7 @@ public class OMTool implements Applicati
* methods whenever applicable.
* The recycle methods must call their super.
*/
+ @Override
public void recycle()
{
disposed = false;
@@ -163,10 +164,10 @@ public class OMTool implements Applicati
* when the object is returned to its pool.
* The dispose method must call its super.
*/
+ @Override
public void dispose()
{
omMap.clear();
- // data = null;
disposed = true;
}
@@ -174,16 +175,9 @@ public class OMTool implements Applicati
* Checks whether the recyclable has been disposed.
* @return true, if the recyclable is disposed.
*/
+ @Override
public boolean isDisposed()
{
return disposed;
}
}
-
-
-
-
-
-
-
-
Modified: turbine/core/trunk/src/java/org/apache/turbine/om/Retriever.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/om/Retriever.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/om/Retriever.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/om/Retriever.java Thu Oct 1 13:18:35 2015
@@ -33,7 +33,9 @@ public interface Retriever
* Gets an object of the same type as the object implementing
* this method according to the key.
*
+ * @param key the key for the object
* @return the object that matches the key
+ * @throws Exception if something goes wrong
*/
Object retrieve(String key)
throws Exception;
Modified: turbine/core/trunk/src/java/org/apache/turbine/om/RetrieverFactory.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/om/RetrieverFactory.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/om/RetrieverFactory.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/om/RetrieverFactory.java Thu Oct 1 13:18:35 2015
@@ -22,7 +22,7 @@ package org.apache.turbine.om;
/**
- *
+ * A factory that can provide retrievers
*
* @author <a href="mailto:jmcnally@collab.net">John D. McNally</a>
* @version $Id$
@@ -32,7 +32,9 @@ public interface RetrieverFactory
/**
* Gets an object capable of retrieving objects of type "className"
*
- * @return the object that matches the key
+ * @param className the class name of the {@link Retriever} implementation
+ * @return the {@link Retriever} instance
+ * @throws Exception if the instance could not be provided
*/
Retriever getInstance(String className)
throws Exception;
Modified: turbine/core/trunk/src/java/org/apache/turbine/om/security/DefaultUserImpl.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/om/security/DefaultUserImpl.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/om/security/DefaultUserImpl.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/om/security/DefaultUserImpl.java Thu Oct 1 13:18:35 2015
@@ -76,7 +76,7 @@ public class DefaultUserImpl implements
* Implement this method if you wish to be notified when the User
* has been Bound to the session.
*
- * @param event Indication of value/session binding.
+ * @param hsbe Indication of value/session binding.
*/
@Override
public void valueBound(HttpSessionBindingEvent hsbe)
@@ -88,7 +88,7 @@ public class DefaultUserImpl implements
* Implement this method if you wish to be notified when the User
* has been Unbound from the session.
*
- * @param event Indication of value/session unbinding.
+ * @param hsbe Indication of value/session unbinding.
*/
@Override
public void valueUnbound(HttpSessionBindingEvent hsbe)
@@ -119,6 +119,7 @@ public class DefaultUserImpl implements
*
* @return The Name of the SecurityEntity.
*/
+ @Override
public String getName()
{
return userDelegate.getName();
@@ -130,6 +131,7 @@ public class DefaultUserImpl implements
* @param name
* Name of the SecurityEntity.
*/
+ @Override
public void setName(String name)
{
userDelegate.setName(name);
@@ -140,6 +142,7 @@ public class DefaultUserImpl implements
*
* @return The Id of the SecurityEntity.
*/
+ @Override
public Object getId()
{
return userDelegate.getId();
@@ -151,6 +154,7 @@ public class DefaultUserImpl implements
* @param id
* The new Id of the SecurityEntity
*/
+ @Override
public void setId(Object id)
{
userDelegate.setId(id);
@@ -168,6 +172,7 @@ public class DefaultUserImpl implements
*
* @return A String with the password for the user.
*/
+ @Override
public String getPassword()
{
return userDelegate.getPassword();
@@ -180,6 +185,7 @@ public class DefaultUserImpl implements
*
* @param password The new password.
*/
+ @Override
public void setPassword(String password)
{
userDelegate.setPassword(password);
@@ -191,6 +197,7 @@ public class DefaultUserImpl implements
* @return A String with the user's first name.
*/
+ @Override
public String getFirstName()
{
return userDelegate.getFirstName();
@@ -201,6 +208,7 @@ public class DefaultUserImpl implements
*
* @param firstName User's first name.
*/
+ @Override
public void setFirstName(String firstName)
{
userDelegate.setFirstName(firstName);
@@ -211,6 +219,7 @@ public class DefaultUserImpl implements
*
* @return A String with the user's last name.
*/
+ @Override
public String getLastName()
{
return userDelegate.getLastName();
@@ -221,6 +230,7 @@ public class DefaultUserImpl implements
*
* @param lastName User's last name.
*/
+ @Override
public void setLastName(String lastName)
{
userDelegate.setLastName(lastName);
@@ -231,6 +241,7 @@ public class DefaultUserImpl implements
*
* @return A String with the user's email address.
*/
+ @Override
public String getEmail()
{
return userDelegate.getEmail();
@@ -241,6 +252,7 @@ public class DefaultUserImpl implements
*
* @param address The email address.
*/
+ @Override
public void setEmail(String address)
{
userDelegate.setEmail(address);
@@ -254,6 +266,7 @@ public class DefaultUserImpl implements
*
* @return The bytes in the objectdata for this user
*/
+ @Override
public byte[] getObjectdata()
{
return userDelegate.getObjectdata();
@@ -264,6 +277,7 @@ public class DefaultUserImpl implements
*
* @param objectdata The new permanent storage for the user
*/
+ @Override
public void setObjectdata(byte[] objectdata)
{
userDelegate.setObjectdata(objectdata);
@@ -274,6 +288,7 @@ public class DefaultUserImpl implements
*
* @return a set of User/Group/Role relations
*/
+ @Override
public <T extends TurbineUserGroupRole> Set<T> getUserGroupRoleSet()
{
return userDelegate.getUserGroupRoleSet();
@@ -285,6 +300,7 @@ public class DefaultUserImpl implements
* @param userGroupRoleSet
* a set of User/Group/Role relations
*/
+ @Override
public <T extends TurbineUserGroupRole> void setUserGroupRoleSet(Set<T> userGroupRoleSet)
{
userDelegate.setUserGroupRoleSet(userGroupRoleSet);
@@ -296,6 +312,7 @@ public class DefaultUserImpl implements
* @param userGroupRole
* a User/Group/Role relation to add
*/
+ @Override
public void addUserGroupRole(TurbineUserGroupRole userGroupRole)
{
userDelegate.addUserGroupRole(userGroupRole);
@@ -307,6 +324,7 @@ public class DefaultUserImpl implements
* @param userGroupRole
* a User/Group/Role relation to remove
*/
+ @Override
public void removeUserGroupRole(TurbineUserGroupRole userGroupRole)
{
userDelegate.removeUserGroupRole(userGroupRole);
@@ -447,7 +465,7 @@ public class DefaultUserImpl implements
* This should only be used in the case where we want to make the
* data persistent.
*
- * @param storage A Map.
+ * @param permStorage A Map.
*/
@Override
public void setPermStorage(Map<String, Object> permStorage)
@@ -478,7 +496,7 @@ public class DefaultUserImpl implements
* This should only be used in the case where we want to save the
* data to the database.
*
- * @param storage A Map.
+ * @param tempStorage A Map.
*/
@Override
public void setTempStorage(Map<String, Object> tempStorage)
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/AbstractValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/AbstractValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/AbstractValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/AbstractValve.java Thu Oct 1 13:18:35 2015
@@ -41,6 +41,7 @@ public abstract class AbstractValve
*
* @throws Exception
*/
+ @Override
public void initialize()
throws Exception
{
@@ -48,20 +49,22 @@ public abstract class AbstractValve
}
/**
- * @see org.apache.turbine.Valve#invoke(PipelineData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
+ @Override
public abstract void invoke(PipelineData data, ValveContext context)
throws IOException, TurbineException;
/**
- * utility for getting RunData out of the pielineData object.
+ * utility for getting RunData out of the pipelineData object.
* @param pipelineData
- * @return
+ * @return the RunData object extracted from pipelineData
*/
public final RunData getRunData(PipelineData pipelineData)
{
- if(!(pipelineData instanceof RunData)){
+ if(!(pipelineData instanceof RunData))
+ {
throw new RuntimeException("Can't cast pipelineData to rundata");
}
return (RunData)pipelineData;
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/CleanUpValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/CleanUpValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/CleanUpValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/CleanUpValve.java Thu Oct 1 13:18:35 2015
@@ -52,7 +52,7 @@ public class CleanUpValve
}
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException
@@ -73,7 +73,7 @@ public class CleanUpValve
/**
* Perform clean up after processing the request.
*
- * @param data The run-time data.
+ * @param pipelineData The run-time data.
*/
protected void cleanUp(PipelineData pipelineData)
throws Exception
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultACLCreationValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultACLCreationValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultACLCreationValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultACLCreationValve.java Thu Oct 1 13:18:35 2015
@@ -29,7 +29,6 @@ import org.apache.turbine.annotation.Tur
import org.apache.turbine.annotation.TurbineLoader;
import org.apache.turbine.modules.Action;
import org.apache.turbine.modules.ActionLoader;
-import org.apache.turbine.util.RunData;
import org.apache.turbine.util.TurbineException;
/**
@@ -52,8 +51,9 @@ public class DefaultACLCreationValve
private Configuration config;
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
+ @Override
public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException
{
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultLoginValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultLoginValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultLoginValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultLoginValve.java Thu Oct 1 13:18:35 2015
@@ -60,7 +60,7 @@ public class DefaultLoginValve
private Configuration config;
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
@Override
public void invoke(PipelineData pipelineData, ValveContext context)
@@ -83,7 +83,7 @@ public class DefaultLoginValve
* Handles user sessions, parsing of the action from the query
* string, and access control.
*
- * @param data The run-time data.
+ * @param pipelineData The run-time data.
*/
protected void process(PipelineData pipelineData)
throws Exception
@@ -150,7 +150,7 @@ public class DefaultLoginValve
/**
* cleans the Velocity Context if available.
*
- * @param data A RunData Object
+ * @param pipelineData A RunData Object
*
* @throws Exception A problem while cleaning out the Template Context occured.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultPipelineData.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultPipelineData.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultPipelineData.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultPipelineData.java Thu Oct 1 13:18:35 2015
@@ -45,9 +45,10 @@ public class DefaultPipelineData impleme
/**
* Put a configured map of objects into the pipeline data object
*
- * @param name the key class
+ * @param key the key class
* @param value the value map
*/
+ @Override
public void put(Class<?> key, Map<Class<?>, ? super Object> value)
{
map.put(key, value);
@@ -56,9 +57,10 @@ public class DefaultPipelineData impleme
/**
* Get the configured map of objects for the given key
*
- * @param name the key class
+ * @param key the key class
* @return the value map or null if no such key exists
*/
+ @Override
public Map<Class<?>, ? super Object> get(Class<?> key)
{
return map.get(key);
@@ -71,6 +73,7 @@ public class DefaultPipelineData impleme
* @param innerKey the key into the value map
* @return the inner value or null if no such keys exist
*/
+ @Override
@SuppressWarnings("unchecked")
public <T> T get(Class<?> key, Class<T> innerKey)
{
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionTimeoutValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionTimeoutValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionTimeoutValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionTimeoutValve.java Thu Oct 1 13:18:35 2015
@@ -48,20 +48,18 @@ public class DefaultSessionTimeoutValve
* reused, so we get the timeout from the configuration..
*/
public DefaultSessionTimeoutValve()
- throws Exception
{
Configuration cfg = Turbine.getConfiguration();
// Get the session timeout.
-
timeout = cfg.getInt(TurbineConstants.SESSION_TIMEOUT_KEY,
TurbineConstants.SESSION_TIMEOUT_DEFAULT);
-
}
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
+ @Override
public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException
{
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionValidationValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionValidationValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionValidationValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/DefaultSessionValidationValve.java Thu Oct 1 13:18:35 2015
@@ -29,7 +29,6 @@ import org.apache.turbine.annotation.Tur
import org.apache.turbine.annotation.TurbineLoader;
import org.apache.turbine.modules.Action;
import org.apache.turbine.modules.ActionLoader;
-import org.apache.turbine.util.RunData;
import org.apache.turbine.util.TurbineException;
/**
@@ -52,8 +51,9 @@ public class DefaultSessionValidationVal
private Configuration config;
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
+ @Override
public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException
{
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineActionValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineActionValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineActionValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineActionValve.java Thu Oct 1 13:18:35 2015
@@ -44,7 +44,7 @@ public class DetermineActionValve
= LogFactory.getLog(DetermineActionValve.class);
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineRedirectRequestedValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineRedirectRequestedValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineRedirectRequestedValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineRedirectRequestedValve.java Thu Oct 1 13:18:35 2015
@@ -49,7 +49,7 @@ public class DetermineRedirectRequestedV
}
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException
@@ -70,7 +70,7 @@ public class DetermineRedirectRequestedV
/**
* Perform clean up after processing the request.
*
- * @param data The run-time data.
+ * @param pipelineData The run-time data.
*/
protected void redirectRequested(PipelineData pipelineData)
throws Exception
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineTargetValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineTargetValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineTargetValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/DetermineTargetValve.java Thu Oct 1 13:18:35 2015
@@ -48,7 +48,7 @@ public class DetermineTargetValve
= LogFactory.getLog(DetermineTargetValve.class);
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/ExecutePageValve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/ExecutePageValve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/ExecutePageValve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/ExecutePageValve.java Thu Oct 1 13:18:35 2015
@@ -58,7 +58,7 @@ public class ExecutePageValve
private Configuration config;
/**
- * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
+ * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
*/
public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException
@@ -79,7 +79,7 @@ public class ExecutePageValve
/**
* execute the page generation.
*
- * @param data The run-time data.
+ * @param pipelineData The run-time data.
*/
protected void executePage(PipelineData pipelineData)
throws Exception
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/Pipeline.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/Pipeline.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/Pipeline.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/Pipeline.java Thu Oct 1 13:18:35 2015
@@ -54,8 +54,9 @@ public interface Pipeline
{
/**
* Initializes this instance. Called once by the Turbine servlet.
+ * @throws Exception if the initialization fails
*/
- public void initialize()
+ void initialize()
throws Exception;
/**
@@ -66,7 +67,7 @@ public interface Pipeline
* @exception IllegalStateException If the pipeline has not been
* initialized.
*/
- public void addValve(Valve valve);
+ void addValve(Valve valve);
/**
* Return the set of all Valves in the pipeline. If there are no
@@ -74,7 +75,7 @@ public interface Pipeline
*
* @return An array of valves.
*/
- public Valve[] getValves();
+ Valve[] getValves();
/**
* <p>Cause the specified request and response to be processed by
@@ -86,12 +87,12 @@ public interface Pipeline
* same Pipeline without interfering with each other's control
* flow.</p>
*
- * @param data The run-time information, including the servlet
+ * @param pipelineData The run-time information, including the servlet
* request and response we are processing.
- *
- * @exception IOException an input/output error occurred.
+ * @throws TurbineException if the invocation fails
+ * @throws IOException an input/output error occurred.
*/
- public void invoke(PipelineData data)
+ void invoke(PipelineData pipelineData)
throws TurbineException, IOException;
/**
@@ -100,5 +101,5 @@ public interface Pipeline
*
* @param valve Valve to be removed.
*/
- public void removeValve(Valve valve);
+ void removeValve(Valve valve);
}
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/TurbinePipeline.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/TurbinePipeline.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/TurbinePipeline.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/TurbinePipeline.java Thu Oct 1 13:18:35 2015
@@ -24,7 +24,6 @@ package org.apache.turbine.pipeline;
import java.io.IOException;
import org.apache.turbine.annotation.AnnotationProcessor;
-import org.apache.turbine.util.RunData;
import org.apache.turbine.util.TurbineException;
/**
@@ -66,6 +65,7 @@ public class TurbinePipeline
/**
* @see org.apache.turbine.pipeline.Pipeline#initialize()
*/
+ @Override
public void initialize()
throws Exception
{
@@ -108,6 +108,7 @@ public class TurbinePipeline
/**
* @see org.apache.turbine.pipeline.Pipeline#addValve(Valve)
*/
+ @Override
public void addValve(Valve valve)
{
// Add this Valve to the set associated with this Pipeline
@@ -123,6 +124,7 @@ public class TurbinePipeline
/**
* @see org.apache.turbine.pipeline.Pipeline#getValves()
*/
+ @Override
public Valve[] getValves()
{
synchronized (valves)
@@ -136,6 +138,7 @@ public class TurbinePipeline
/**
* @see org.apache.turbine.pipeline.Pipeline#removeValve(Valve)
*/
+ @Override
public void removeValve(Valve valve)
{
synchronized (valves)
@@ -171,8 +174,9 @@ public class TurbinePipeline
}
/**
- * @see org.apache.turbine.pipeline.Pipeline#invoke(RunData)
+ * @see org.apache.turbine.pipeline.Pipeline#invoke(PipelineData)
*/
+ @Override
public void invoke(PipelineData pipelineData)
throws TurbineException, IOException
{
@@ -184,8 +188,9 @@ public class TurbinePipeline
}
/**
- * @see org.apache.turbine.pipeline.ValveContext#invokeNext(RunData)
+ * @see org.apache.turbine.pipeline.ValveContext#invokeNext(PipelineData)
*/
+ @Override
public void invokeNext(PipelineData pipelineData)
throws TurbineException, IOException
{
Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/Valve.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/Valve.java?rev=1706239&r1=1706238&r2=1706239&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/pipeline/Valve.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/Valve.java Thu Oct 1 13:18:35 2015
@@ -40,7 +40,7 @@ import org.apache.turbine.util.TurbineEx
* @author Peter Donald
* @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
*
- * @see #invoke(RunData, ValveContext)
+ * @see #invoke(PipelineData, ValveContext)
*/
public interface Valve
{
@@ -81,7 +81,7 @@ public interface Valve
* returned.
* </ul>
*
- * @param data The run-time information, including the servlet
+ * @param pipelineData The run-time information, including the servlet
* request and response we are processing.
* @param context The valve context used to invoke the next valve
* in the current processing pipeline
@@ -89,11 +89,12 @@ public interface Valve
* @exception IOException Thrown by a subsequent Valve.
* @exception TurbineException Thrown by a subsequent Valve.
*/
- public void invoke(PipelineData data, ValveContext context)
+ public void invoke(PipelineData pipelineData, ValveContext context)
throws IOException, TurbineException;
/**
* Initialize the valve before using in a pipeline.
+ * @throws Exception if initialization fails
*/
public void initialize()
throws Exception;