Modified: turbine/core/trunk/src/java/org/apache/turbine/pipeline/ValveContext.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/pipeline/ValveContext.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/pipeline/ValveContext.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/pipeline/ValveContext.java Thu Oct 1 13:18:35 2015 @@ -56,7 +56,7 @@ public interface ValveContext * <p>If there are no more Valves to be executed, execution of * this method will result in a no op.</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 Thrown by a subsequent Valve. @@ -64,6 +64,6 @@ public interface ValveContext * @exception TurbineException No further Valves configured in the * Pipeline currently being processed. */ - public void invokeNext(PipelineData data) + public void invokeNext(PipelineData pipelineData) throws IOException, TurbineException; }
Modified: turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitable.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitable.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitable.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitable.java Thu Oct 1 13:18:35 2015 @@ -57,6 +57,7 @@ public class BaseInitable * * @param broker The InitableBroker that instantiated this object. */ + @Override public void setInitableBroker(InitableBroker broker) { this.initableBroker = broker; @@ -83,21 +84,23 @@ public class BaseInitable * @exception InitializationException Initialization of this * class was not successful. */ + @Override public void init(Object data) throws InitializationException { // empty } /** - * Performs late initializtion. Called when the Service is requested + * Performs late initialization. Called when the Service is requested * for the first time (if not already completely initialized by the * early initializer). * - * Late intialization of a BaseInitable is alwas successful. + * Late initialization of a BaseInitable is always successful. * * @exception InitializationException Initialization of this * class was not successful. */ + @Override public void init() throws InitializationException { // empty @@ -109,6 +112,7 @@ public class BaseInitable * Calls setInit(false) to mark that we are no longer in initialized * state. */ + @Override public void shutdown() { setInit(false); @@ -119,13 +123,14 @@ public class BaseInitable * * @return True if the initable is initialized. */ + @Override public boolean getInit() { return isInitialized; } /** - * Sets initailization status. + * Sets initialization status. * * @param value The new initialization status. */ Modified: turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitableBroker.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitableBroker.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitableBroker.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/BaseInitableBroker.java Thu Oct 1 13:18:35 2015 @@ -92,6 +92,7 @@ public abstract class BaseInitableBroker * @param data An Object to be used for initialization activities. * @exception InitializationException Initialization was not successful. */ + @Override public void initClass(String className, Object data) throws InitializationException { @@ -101,8 +102,8 @@ public abstract class BaseInitableBroker int pos = stack.search(className); if (pos != -1) { - StringBuffer msg = new StringBuffer().append(className) - .append(" couldn't be initialized because of circular depency chain:\n"); + StringBuilder msg = new StringBuilder().append(className) + .append(" couldn't be initialized because of circular dependency chain:\n"); for (int i = pos; i > 0; i--) { msg.append(stack.elementAt(stack.size() - i - 1) + "->"); @@ -133,11 +134,12 @@ public abstract class BaseInitableBroker * Shuts down an <code>Initable</code>. * * This method is used to release resources allocated by an - * <code>Initable</code>, and return it to its initial (uninitailized) + * <code>Initable</code>, and return it to its initial (uninitialized) * state. * * @param className The name of the class to be uninitialized. */ + @Override public void shutdownClass(String className) { try @@ -161,16 +163,17 @@ public abstract class BaseInitableBroker /** * Provides an instance of Initable class ready to work. * - * If the requested class couldn't be instatiated or initialized, + * If the requested class couldn't be instantiated or initialized, * an InstantiationException will be thrown. You needn't handle * this exception in your code, since it indicates fatal - * misconfigurtion of the system. + * misconfiguration of the system. * * @param className The name of the Initable requested. * @return An instance of the requested Initable. * @exception InstantiationException if there was a problem * during instantiation or initialization of the Initable. */ + @Override public Initable getInitable(String className) throws InstantiationException { Modified: turbine/core/trunk/src/java/org/apache/turbine/services/BaseServiceBroker.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/BaseServiceBroker.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/BaseServiceBroker.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/BaseServiceBroker.java Thu Oct 1 13:18:35 2015 @@ -149,6 +149,7 @@ public abstract class BaseServiceBroker /** * Initialize this service manager. + * @throws InitializationException if the initialization fails */ public void init() throws InitializationException { @@ -311,6 +312,7 @@ public abstract class BaseServiceBroker * @param serviceName The name of the service whose existence to check. * @return Registration predicate for the desired services. */ + @Override public boolean isRegistered(String serviceName) { return (services.get(serviceName) != null); @@ -356,6 +358,7 @@ public abstract class BaseServiceBroker * @exception InitializationException Initialization of this * service was not successful. */ + @Override public synchronized void initService(String name) throws InitializationException { @@ -400,6 +403,8 @@ public abstract class BaseServiceBroker * to initialize. * * @param report <code>true</code> if you want exceptions thrown. + * @throws InstantiationException if the service could not be instantiated + * @throws InitializationException if the service could not be initialized */ public void initServices(boolean report) throws InstantiationException, InitializationException @@ -460,6 +465,7 @@ public abstract class BaseServiceBroker * @param name The name of the <code>Service</code> to be * uninitialized. */ + @Override public synchronized void shutdownService(String name) { try @@ -489,6 +495,7 @@ public abstract class BaseServiceBroker * Shuts down all Turbine services, releasing allocated resources and * returning them to their initial (uninitialized) state. */ + @Override public void shutdownServices() { log.info("Shutting down all services!"); @@ -526,6 +533,7 @@ public abstract class BaseServiceBroker * @exception InstantiationException if the service is unknown or * can't be initialized. */ + @Override public Object getService(String name) throws InstantiationException { Service service; @@ -660,6 +668,7 @@ public abstract class BaseServiceBroker * @param name The name of the service. * @return Configuration of requested Service. */ + @Override public Configuration getConfiguration(String name) { return configuration.subset(SERVICE_PREFIX + name); Modified: turbine/core/trunk/src/java/org/apache/turbine/services/BaseUnicastRemoteService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/BaseUnicastRemoteService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/BaseUnicastRemoteService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/BaseUnicastRemoteService.java Thu Oct 1 13:18:35 2015 @@ -25,8 +25,6 @@ import java.rmi.RemoteException; import java.rmi.server.UnicastRemoteObject; import java.util.Properties; -import javax.servlet.ServletConfig; - import org.apache.commons.configuration.Configuration; import org.apache.commons.configuration.ConfigurationConverter; @@ -50,6 +48,10 @@ public class BaseUnicastRemoteService ex private String name; private ServiceBroker serviceBroker; + /** + * Default constructor + * @throws RemoteException if the remote object cannot be created + */ public BaseUnicastRemoteService() throws RemoteException { @@ -64,6 +66,7 @@ public class BaseUnicastRemoteService ex * * @return The configuration of this service. */ + @Override public Configuration getConfiguration() { if (name == null) @@ -80,27 +83,29 @@ public class BaseUnicastRemoteService ex } } - public void init(ServletConfig config) - { - setInit(true); - } - + @Override public void setInitableBroker(InitableBroker broker) { this.initableBroker = broker; } + /** + * Get the {@link InitableBroker} instance + * @return the broker instance + */ public InitableBroker getInitableBroker() { return initableBroker; } + @Override public void init(Object data) throws InitializationException { - init((ServletConfig) data); + init(); } + @Override public void init() throws InitializationException { setInit(true); @@ -111,6 +116,7 @@ public class BaseUnicastRemoteService ex isInitialized = value; } + @Override public boolean getInit() { return isInitialized; @@ -119,31 +125,40 @@ public class BaseUnicastRemoteService ex /** * Shuts down this service. */ + @Override public void shutdown() { setInit(false); } + @Override public Properties getProperties() { return ConfigurationConverter.getProperties(getConfiguration()); } + @Override public void setName(String name) { this.name = name; } + @Override public String getName() { return name; } + /** + * Get the {@link ServiceBroker} instance + * @return the broker instance + */ public ServiceBroker getServiceBroker() { return serviceBroker; } + @Override public void setServiceBroker(ServiceBroker broker) { this.serviceBroker = broker; Modified: turbine/core/trunk/src/java/org/apache/turbine/services/Initable.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/Initable.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/Initable.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/Initable.java Thu Oct 1 13:18:35 2015 @@ -45,7 +45,7 @@ public interface Initable void setInitableBroker(InitableBroker broker); /** - * Performs early initailization of an Initable + * Performs early initialization of an Initable * * During the startup of the system, different objects may be * passed to your class using this method. It should ignore any @@ -60,7 +60,7 @@ public interface Initable * throw an exception and complain. * * @param data An Object to use for initialization activities. - * @exception InitializationException if initilaization of this + * @exception InitializationException if initialization of this * class was not successful. */ void init(Object data) throws InitializationException; Modified: turbine/core/trunk/src/java/org/apache/turbine/services/InitableBroker.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/InitableBroker.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/InitableBroker.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/InitableBroker.java Thu Oct 1 13:18:35 2015 @@ -41,8 +41,8 @@ package org.apache.turbine.services; * <li>Providing instances of <code>Initables</code> to requesting * parties.</li> * - * <li>Maintainging dependencies between <code>Initables</code> during - * early initalization phases, including circular dependencies + * <li>Maintaining dependencies between <code>Initables</code> during + * early initialization phases, including circular dependencies * detection.</li> * * </ul> @@ -62,7 +62,7 @@ public interface InitableBroker * to you, before you try to retrieve that Initable's instance with * getInitable(). * - * @param className The name of the class to be initailized. + * @param className The name of the class to be initialized. * @param data An object to be used for initialization activities. * @exception InitializationException if initialization of this * class was not successful. @@ -74,7 +74,7 @@ public interface InitableBroker * Shutdowns an Initable class. * * This method is used to release resources allocated by an - * Initable class, and return it to initial (uninitailized) + * Initable class, and return it to initial (uninitialized) * state. * * @param className The name of the class to be uninitialized. Modified: turbine/core/trunk/src/java/org/apache/turbine/services/ServiceManager.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/ServiceManager.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/ServiceManager.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/ServiceManager.java Thu Oct 1 13:18:35 2015 @@ -40,6 +40,7 @@ public interface ServiceManager extends { /** * Initialize this service manager. + * @throws InitializationException if the service manager could not be initialized */ void init() throws InitializationException; Modified: turbine/core/trunk/src/java/org/apache/turbine/services/TurbineBaseService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/TurbineBaseService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/TurbineBaseService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/TurbineBaseService.java Thu Oct 1 13:18:35 2015 @@ -62,7 +62,7 @@ public abstract class TurbineBaseService /** * Performs early initialization. Overrides init() method in * BaseService to detect objects used in Turbine's Service - * initialization and pass them to apropriate init() methods. + * initialization and pass them to appropriate init() methods. * * @param data An Object to use for initialization activities. * @exception InitializationException if initialization of this @@ -85,31 +85,16 @@ public abstract class TurbineBaseService /** * Performs early initialization. * - * @deprecated Use the PipelineData version instead. - * @param data An RunData to use for initialization activities. + * @param pipelineData A PipelineData to use for initialization activities. * @exception InitializationException if initialization of this * class was not successful. */ - @Deprecated - public void init(RunData data) throws InitializationException + public void init(PipelineData pipelineData) throws InitializationException { // empty } /** - * Performs early initialization. - * - * @param data A PipelineData to use for initialization activities. - * @exception InitializationException if initialization of this - * class was not successful. - */ - public void init(PipelineData data) throws InitializationException - { - // empty - } - - - /** * Performs late initialization. * * If your class relies on early initialization, and the object it @@ -128,7 +113,7 @@ public abstract class TurbineBaseService /** * Returns to uninitialized state. * - * You can use this method to release resources thet your Service + * You can use this method to release resources that your Service * allocated when Turbine shuts down. */ @Override Modified: turbine/core/trunk/src/java/org/apache/turbine/services/TurbineServiceProvider.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/TurbineServiceProvider.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/TurbineServiceProvider.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/TurbineServiceProvider.java Thu Oct 1 13:18:35 2015 @@ -32,7 +32,7 @@ public interface TurbineServiceProvider { /** * Returns an instance of the requested service. If the - * given servise is not available/found we throw a RuntimeException + * given service is not available/found we throw a RuntimeException * since this is less intrusive. * * @param roleName the name of the requested service @@ -51,6 +51,8 @@ public interface TurbineServiceProvider /** * Is the service known to the service container? + * @param roleName the name of the requested service + * @return true if the service is known to the provider */ public boolean exists(String roleName); } Modified: turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/AssemblerFactory.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/AssemblerFactory.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/AssemblerFactory.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/AssemblerFactory.java Thu Oct 1 13:18:35 2015 @@ -28,7 +28,7 @@ import org.apache.turbine.modules.Loader * Interface for AssemblerFactory's * * @author <a href="mailto:[email protected]";>Leon Messerschmidt</a> - * @version $Id$ + * @param <T> the specialized assembler type */ public interface AssemblerFactory<T extends Assembler> extends Loader<T> { Modified: turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/java/JavaBaseFactory.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/java/JavaBaseFactory.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/java/JavaBaseFactory.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/java/JavaBaseFactory.java Thu Oct 1 13:18:35 2015 @@ -37,7 +37,7 @@ import org.apache.turbine.services.assem * * @author <a href="mailto:[email protected]";>Leon Messerschmidt</a> * @author <a href="mailto:[email protected]";>Henning P. Schmiedehausen</a> - * @version $Id$ + * @param <T> the specialized assembler type */ public abstract class JavaBaseFactory<T extends Assembler> implements AssemblerFactory<T> Modified: turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/python/PythonBaseFactory.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/python/PythonBaseFactory.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/python/PythonBaseFactory.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/assemblerbroker/util/python/PythonBaseFactory.java Thu Oct 1 13:18:35 2015 @@ -42,7 +42,7 @@ import org.python.util.PythonInterpreter * * @author <a href="mailto:[email protected]";>Leon Messerschmidt</a> * @author <a href="mailto:[email protected]";>Henning P. Schmiedehausen</a> - * @version $Id$ + * @param <T> the specialized assembler type */ public abstract class PythonBaseFactory<T extends Assembler> implements AssemblerFactory<T> @@ -86,7 +86,7 @@ public abstract class PythonBaseFactory< String confName = path + "/" + PYTHON_CONFIG_FILE; // The filename of the Python script - StringBuffer fName = new StringBuffer(); + StringBuilder fName = new StringBuilder(); fName.append(path); fName.append("/"); @@ -163,6 +163,7 @@ public abstract class PythonBaseFactory< * * @return a Loader */ + @Override public abstract Loader<T> getLoader(); /** @@ -170,6 +171,7 @@ public abstract class PythonBaseFactory< * * @return the size of the cache in bytes */ + @Override public int getCacheSize() { Modified: turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineAvalonComponentService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineAvalonComponentService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineAvalonComponentService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineAvalonComponentService.java Thu Oct 1 13:18:35 2015 @@ -96,6 +96,7 @@ public class TurbineAvalonComponentServi * @throws InitializationException Something went wrong in the init * stage */ + @Override public void init() throws InitializationException { @@ -116,6 +117,7 @@ public class TurbineAvalonComponentServi * implement this interface * */ + @Override public void shutdown() { dispose(); @@ -131,6 +133,7 @@ public class TurbineAvalonComponentServi * * @throws Exception generic exception */ + @Override public void initialize() throws Exception { org.apache.commons.configuration.Configuration conf @@ -209,6 +212,7 @@ public class TurbineAvalonComponentServi /** * Disposes of the container and releases resources */ + @Override public void dispose() { manager.dispose(); @@ -219,8 +223,8 @@ public class TurbineAvalonComponentServi * * @param roleName Name of the role the component fills. * @return an instance of the named component - * @throws ComponentException generic exception */ + @Override public Object lookup(String roleName) throws ServiceException { @@ -239,6 +243,7 @@ public class TurbineAvalonComponentServi * * @param component the component to release */ + @Override public void release(Object component) { if( component instanceof Component ) @@ -250,6 +255,7 @@ public class TurbineAvalonComponentServi /** * @see org.apache.avalon.framework.service.ServiceManager#hasService(java.lang.String) */ + @Override public boolean hasService(String roleName) { return manager.hasComponent(roleName); @@ -262,6 +268,7 @@ public class TurbineAvalonComponentServi /** * @see org.apache.turbine.services.TurbineServiceProvider#exists(java.lang.String) */ + @Override public boolean exists(String roleName) { return this.hasService(roleName); @@ -270,6 +277,7 @@ public class TurbineAvalonComponentServi /** * @see org.apache.turbine.services.TurbineServiceProvider#get(java.lang.String) */ + @Override public Object get(String roleName) throws InstantiationException { try Modified: turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineYaafiComponentService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineYaafiComponentService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineYaafiComponentService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/avaloncomponent/TurbineYaafiComponentService.java Thu Oct 1 13:18:35 2015 @@ -41,7 +41,7 @@ import org.apache.turbine.services.Turbi /** * An implementation of Turbine service initializing the YAAFI container * - * @author <a href="mailto:[email protected]";>Siegfried Goeschl</a> + * @author <a href="mailto:[email protected]";>Siegfried Goeschl</a> */ public class TurbineYaafiComponentService extends TurbineBaseService @@ -65,21 +65,13 @@ public class TurbineYaafiComponentServic /** YAFFI container */ private ServiceContainer container; - // ------------------------------------------------------------- - // Service initialization - // ------------------------------------------------------------- - - public TurbineYaafiComponentService() - { - // nothing to do - } - /** * Load all configured components and initialize them. This is a zero parameter variant which * queries the Turbine Servlet for its config. * * @throws InitializationException Something went wrong in the init stage */ + @Override public void init() throws InitializationException { try @@ -100,6 +92,7 @@ public class TurbineYaafiComponentServic * interface * */ + @Override public void shutdown() { log.info( "Disposing TurbineYaafiComponentService ..." ); @@ -116,6 +109,7 @@ public class TurbineYaafiComponentServic * * @throws Exception generic exception */ + @Override public void initialize() throws Exception { // get the configuration from the baseclass @@ -153,6 +147,7 @@ public class TurbineYaafiComponentServic /** * Disposes of the container and releases resources */ + @Override public void dispose() { if (this.container != null) @@ -167,8 +162,8 @@ public class TurbineYaafiComponentServic * * @param roleName Name of the role the component fills. * @return an instance of the named component - * @throws Exception generic exception */ + @Override public Object lookup(String roleName) throws ServiceException { return this.container.lookup(roleName); @@ -179,6 +174,7 @@ public class TurbineYaafiComponentServic * * @param component the component to release */ + @Override public void release(Object component) { this.container.release( component ); @@ -187,6 +183,7 @@ public class TurbineYaafiComponentServic /** * @see org.apache.avalon.framework.service.ServiceManager#hasService(java.lang.String) */ + @Override public boolean hasService(String roleName) { return this.container.hasService(roleName); @@ -280,6 +277,7 @@ public class TurbineYaafiComponentServic /** * @see org.apache.turbine.services.TurbineServiceProvider#exists(java.lang.String) */ + @Override public boolean exists(String roleName) { return this.hasService(roleName); @@ -288,6 +286,7 @@ public class TurbineYaafiComponentServic /** * @see org.apache.turbine.services.TurbineServiceProvider#get(java.lang.String) */ + @Override public Object get(String roleName) throws InstantiationException { try Modified: turbine/core/trunk/src/java/org/apache/turbine/services/intake/IntakeTool.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/intake/IntakeTool.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/intake/IntakeTool.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/intake/IntakeTool.java Thu Oct 1 13:18:35 2015 @@ -138,6 +138,11 @@ public class IntakeTool } } + /** + * Add all registered group ids to the value parser + * + * @param vp the value parser + */ public void addGroupsToParameters(ValueParser vp) { for (Group group : groups.values()) @@ -160,6 +165,8 @@ public class IntakeTool * $intake.newForm() and $intake.declareGroup($group) for the relevant * groups in the form. * + * @return the HTML that declares all groups to Intake in hidden input fields + * */ public String declareGroups() { @@ -174,6 +181,9 @@ public class IntakeTool /** * A convenience method to write out the hidden form fields * that notify intake of the group. + * + * @param group the group to declare + * @return the HTML that declares the group to Intake in a hidden input field */ public String declareGroup(Group group) { @@ -185,6 +195,8 @@ public class IntakeTool /** * xhtml valid hidden input field(s) that notifies intake of the * group's presence. + * @param group the group to declare + * @param sb a String Builder where the hidden field HTML will be appended */ public void declareGroup(Group group, StringBuilder sb) { @@ -200,6 +212,9 @@ public class IntakeTool group.appendHtmlFormInput(sb); } + /** + * Declare that a new form starts + */ public void newForm() { declaredGroups.clear(); @@ -326,6 +341,8 @@ public class IntakeTool /** * get a specific group + * @param groupName the name of the group + * @return a {@link PullHelper} wrapper around the group */ public PullHelper get(String groupName) { @@ -335,7 +352,9 @@ public class IntakeTool /** * Get a specific group * + * @param groupName the name of the group * @param throwExceptions if false, exceptions will be suppressed. + * @return a {@link PullHelper} wrapper around the group * @throws IntakeException could not retrieve group */ public PullHelper get(String groupName, boolean throwExceptions) @@ -347,6 +366,7 @@ public class IntakeTool /** * Loops through all of the Groups and checks to see if * the data within the Group is valid. + * @return true if all groups are valid */ public boolean isAllValid() { @@ -360,26 +380,25 @@ public class IntakeTool /** * Get a specific group by name and key. + * @param groupName the name of the group + * @param key the key for the group + * @return the {@link Group} + * @throws IntakeException if the group could not be retrieved */ public Group get(String groupName, String key) throws IntakeException { - if (groupName == null) - { - throw new IntakeException("IntakeServiceFacade.get: groupName == null"); - } - if (key == null) - { - throw new IntakeException("IntakeServiceFacade.get: key == null"); - } - - PullHelper ph = get(groupName); - return (ph == null) ? null : ph.setKey(key); + return get(groupName, key, true); } /** * Get a specific group by name and key. Also specify * whether or not you want to create a new group. + * @param groupName the name of the group + * @param key the key for the group + * @param create true if a new group should be created + * @return the {@link Group} + * @throws IntakeException if the group could not be retrieved */ public Group get(String groupName, String key, boolean create) throws IntakeException @@ -401,6 +420,7 @@ public class IntakeTool * Removes group. Primary use is to remove a group that has * been processed by an action and is no longer appropriate * in the view (screen). + * @param group the group instance to remove */ public void remove(Group group) { Modified: turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JSONProcessor.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JSONProcessor.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JSONProcessor.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JSONProcessor.java Thu Oct 1 13:18:35 2015 @@ -12,12 +12,23 @@ import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; - +/** + * Process a JSON RPC call + * + * @author <a href="mailto:[email protected]";>Scott Eade</a> + */ public class JSONProcessor { /** Log. */ private static Log log = LogFactory.getLog(JSONProcessor.class); + /** + * Process a JSON RPC call + * @param cdata the JSON data + * @param json_bridge the {@link JSONRPCBridge} object + * @param request the request + * @return the return object of the JSON RPC call + */ public static Object processCall(CharArrayWriter cdata, JSONRPCBridge json_bridge, HttpServletRequest request) { // Process the request @@ -33,7 +44,7 @@ public class JSONProcessor // If this a CallableReference it will have a non-zero objectID int object_id = json_req.optInt("objectID"); - StringBuffer sb = new StringBuffer(".doprocessCall(): call "); + StringBuilder sb = new StringBuilder(".doprocessCall(): call "); if (object_id != 0) { sb.append("objectID=").append(object_id).append(" "); Modified: turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JsonRpcService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JsonRpcService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JsonRpcService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/JsonRpcService.java Thu Oct 1 13:18:35 2015 @@ -40,14 +40,45 @@ public interface JsonRpcService /** TurbineJsonRpcService. */ public static final String SERVICE_NAME = "JsonRpcService"; + /** + * Process a JSON RPC call + * @param cdata the JSON data + * @param json_bridge the {@link JSONRPCBridge} object + * @param request the request + * @return the return object of the JSON RPC call + */ public Object processCall(CharArrayWriter cdata, JSONRPCBridge json_bridge, HttpServletRequest request); + /** + * Register an object with the {@link JSONRPCBridge} in a given session + * + * @param session the session + * @param key the name of the object in the session + * @param value the object to register + */ public void registerObject(HttpSession session, String key, Object value); + /** + * Register an object with the {@link JSONRPCBridge} globally + * + * @param key the name of the object in the session + * @param value the object to register + */ public void registerObjectGlobal(String key, Object value); + /** + * Get the {@link JSONRPCBridge} from the session + * + * @param session the session + * @return the {@link JSONRPCBridge} instance + */ public JSONRPCBridge getBridge(HttpSession session); + /** + * Remove the {@link JSONRPCBridge} from the session + * + * @param session the session + */ public void clearBridge(HttpSession session); } Modified: turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpc.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpc.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpc.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpc.java Thu Oct 1 13:18:35 2015 @@ -47,27 +47,58 @@ public abstract class TurbineJsonRpc .getService(JsonRpcService.SERVICE_NAME); } - public static Object processCall(CharArrayWriter cdata, + /** + * Process a JSON RPC call + * @param cdata the JSON data + * @param json_bridge the {@link JSONRPCBridge} object + * @param request the request + * @return the return object of the JSON RPC call + */ + public static Object processCall(CharArrayWriter cdata, JSONRPCBridge json_bridge, HttpServletRequest request) { return getService().processCall(cdata, json_bridge, request); } + /** + * Register an object with the {@link JSONRPCBridge} in a given session + * + * @param session the session + * @param key the name of the object in the session + * @param value the object to register + */ public static void registerObject(HttpSession session, String key, Object value) { getService().registerObject(session, key, value); } + /** + * Register an object with the {@link JSONRPCBridge} globally + * + * @param key the name of the object in the session + * @param value the object to register + */ public static void registerObjectGlobal(String key, Object value) { getService().registerObjectGlobal(key, value); } + /** + * Get the {@link JSONRPCBridge} from the session + * + * @param session the session + * @return the {@link JSONRPCBridge} instance + */ public static JSONRPCBridge getBridge(HttpSession session) { return getService().getBridge(session); } + /** + * Remove the {@link JSONRPCBridge} from the session + * + * @param session the session + */ public static void clearBridge(HttpSession session) { getService().clearBridge(session); Modified: turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpcService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpcService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpcService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/jsonrpc/TurbineJsonRpcService.java Thu Oct 1 13:18:35 2015 @@ -24,8 +24,6 @@ import java.io.CharArrayWriter; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpSession; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.apache.turbine.services.TurbineBaseService; import org.jabsorb.JSONRPCBridge; @@ -40,34 +38,30 @@ public class TurbineJsonRpcService extends TurbineBaseService implements JsonRpcService { - /** Log. */ - private static Log log = LogFactory.getLog(TurbineJsonRpcService.class); - /** The key used to store the bridge in the session. */ public static final String JSON_BRIDGE_KEY = "JSONRPCBridge"; - /** - * The debug option for the bridge can be enabled by enabling debug level - * logging for this class. - */ - private static final boolean DEBUG = log.isDebugEnabled(); + @Override public Object processCall(CharArrayWriter cdata, JSONRPCBridge json_bridge, HttpServletRequest request) { return JSONProcessor.processCall(cdata, json_bridge, request); } + @Override public void registerObjectGlobal(String key, Object value) { JSONRPCBridge.getGlobalBridge().registerObject(key, value); } + @Override public void registerObject(HttpSession session, String key, Object value) { JSONRPCBridge json_bridge = getBridge(session); json_bridge.registerObject(key, value); } + @Override public JSONRPCBridge getBridge(HttpSession session) { JSONRPCBridge json_bridge = (JSONRPCBridge) session.getAttribute(JSON_BRIDGE_KEY); @@ -79,12 +73,13 @@ public class TurbineJsonRpcService return json_bridge; } + @Override public void clearBridge(HttpSession session) { session.removeAttribute(JSON_BRIDGE_KEY); } -// The following is modeled on XmlRpcSercice. +// The following is modeled on XmlRpcSercice. // /** // * Initialize the JsonRpcService. // * Modified: turbine/core/trunk/src/java/org/apache/turbine/services/jsp/util/JspNavigation.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/jsp/util/JspNavigation.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/jsp/util/JspNavigation.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/jsp/util/JspNavigation.java Thu Oct 1 13:18:35 2015 @@ -53,7 +53,7 @@ public class JspNavigation /** * Constructor * - * @param data + * @param data Turbine request data */ public JspNavigation(RunData data) { Modified: turbine/core/trunk/src/java/org/apache/turbine/services/localization/LocalizationTool.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/localization/LocalizationTool.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/localization/LocalizationTool.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/localization/LocalizationTool.java Thu Oct 1 13:18:35 2015 @@ -129,35 +129,6 @@ public class LocalizationTool implements } /** - * Formats a localized value using the provided object. - * - * @param key The identifier for the localized text to retrieve, - * @param arg1 The object to use as {0} when formatting the localized text. - * @return Formatted localized text. - * @see #format(String, Locale, String, Object[]) - */ - public String format(String key, Object arg1) - { - return getLocalizationService() - .format(getBundleName(null), getLocale(), key, arg1); - } - - /** - * Formats a localized value using the provided objects. - * - * @param key The identifier for the localized text to retrieve, - * @param arg1 The object to use as {0} when formatting the localized text. - * @param arg2 The object to use as {1} when formatting the localized text. - * @return Formatted localized text. - * @see #format(String, Locale, String, Object[]) - */ - public String format(String key, Object arg1, Object arg2) - { - return getLocalizationService() - .format(getBundleName(null), getLocale(), key, arg1, arg2); - } - - /** * Formats a localized value using the provided objects. * * @param key The identifier for the localized text to retrieve, @@ -165,7 +136,7 @@ public class LocalizationTool implements * formatting the localized text. * @return Formatted localized text. */ - public String format(String key, Object[] args) + public String format(String key, Object... args) { return getLocalizationService() .format(getBundleName(null), getLocale(), key, args); @@ -177,6 +148,7 @@ public class LocalizationTool implements * Sets the request to get the <code>Accept-Language</code> header * from (reset on each request). */ + @Override public void init(Object data) { if (data instanceof RunData) @@ -190,6 +162,7 @@ public class LocalizationTool implements /** * No-op. */ + @Override public void refresh() { locale = null; Modified: turbine/core/trunk/src/java/org/apache/turbine/services/naming/NamingService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/naming/NamingService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/naming/NamingService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/naming/NamingService.java Thu Oct 1 13:18:35 2015 @@ -35,6 +35,9 @@ import org.apache.turbine.services.Servi public interface NamingService extends Service { + /** + * The service name + */ String SERVICE_NAME = "NamingService"; /** Modified: turbine/core/trunk/src/java/org/apache/turbine/services/pull/PullService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/pull/PullService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/pull/PullService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/pull/PullService.java Thu Oct 1 13:18:35 2015 @@ -115,7 +115,7 @@ public interface PullService * the global tools). * * @param context a Velocity Context to populate - * @param data a RunData object for request specific data + * @param pipelineData a RunData object for request specific data */ void populateContext(Context context, PipelineData pipelineData); Modified: turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePull.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePull.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePull.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePull.java Thu Oct 1 13:18:35 2015 @@ -75,6 +75,7 @@ public abstract class TurbinePull * <code>TurbineResources.props</code>, or no tools are specified * the TurbineVelocityService will behave in its traditional * manner. + * @return true if the service is registered within Turbine */ public static final boolean isRegistered() { @@ -111,7 +112,7 @@ public abstract class TurbinePull * the global tools). * * @param context a Velocity Context to populate - * @param data a RunData object for request specific data + * @param pipelineData a RunData object for request specific data */ public static void populateContext(Context context, PipelineData pipelineData) { Modified: turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePullService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePullService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePullService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/pull/TurbinePullService.java Thu Oct 1 13:18:35 2015 @@ -358,6 +358,7 @@ public class TurbinePullService * Pull Model. The tools are refreshed every time the * global Context is pulled. */ + @Override public Context getGlobalContext() { if (refreshToolsPerRequest) @@ -376,6 +377,7 @@ public class TurbinePullService * @param context a Velocity Context to populate * @param data a RunData object for request specific data */ + @Override public void populateContext(Context context, RunData data) { populateWithRequestTools(context, data); @@ -421,8 +423,9 @@ public class TurbinePullService * the global tools). * * @param context a Velocity Context to populate - * @param data a PipelineData object for request specific data + * @param pipelineData a PipelineData object for request specific data */ + @Override public void populateContext(Context context, PipelineData pipelineData) { // Map runDataMap = (Map) pipelineData.get(RunData.class); @@ -497,7 +500,7 @@ public class TurbinePullService * Populate the given context with the request-scope tools * * @param context a Velocity Context to populate - * @param data a RunData instance + * @param pipelineData a RunData instance */ private void populateWithRequestTools(Context context, RunData data) { @@ -530,7 +533,7 @@ public class TurbinePullService * Populate the given context with the request-scope tools * * @param context a Velocity Context to populate - * @param data a RunData instance + * @param pipelineData a RunData instance */ private void populateWithRequestTools(Context context, PipelineData pipelineData) { @@ -563,7 +566,7 @@ public class TurbinePullService * @param tools The list of tools with which to populate the * session. * @param context The context to populate. - * @param data The current RunData object + * @param pipelineData The current RunData object * @param user The <code>User</code> object whose storage to * retrieve the tool from. */ @@ -652,7 +655,7 @@ public class TurbinePullService * @param tools The list of tools with which to populate the * session. * @param context The context to populate. - * @param data The current RunData object + * @param pipelineData The current RunData object * @param user The <code>User</code> object whose storage to * retrieve the tool from. */ @@ -740,7 +743,7 @@ public class TurbinePullService * @param tools The list of tools with which to populate the * session. * @param context The context to populate. - * @param data The current RunData object + * @param pipelineData The current RunData object * @param user The <code>User</code> object whose storage to * retrieve the tool from. */ @@ -823,7 +826,7 @@ public class TurbinePullService * @param tools The list of tools with which to populate the * session. * @param context The context to populate. - * @param data The current RunData object + * @param pipelineData The current RunData object * @param user The <code>User</code> object whose storage to * retrieve the tool from. */ @@ -908,6 +911,7 @@ public class TurbinePullService * * @return the absolute path of the resources directory */ + @Override public String getAbsolutePathToResourcesDirectory() { return Turbine.getRealPath(resourcesDirectory); @@ -919,6 +923,7 @@ public class TurbinePullService * * @return the relative path of the resources directory */ + @Override public String getResourcesDirectory() { return resourcesDirectory; @@ -947,6 +952,7 @@ public class TurbinePullService * * @param context the Velocity Context to release tools from */ + @Override public void releaseTools(Context context) { // only the request tools can be released - other scoped @@ -1024,7 +1030,7 @@ public class TurbinePullService * Refresh a given Tool. * * @param tool A Tool Object - * @param data The current RunData Object + * @param pipelineData The current RunData Object */ private void refreshTool(Object tool, Object dataObject) { Modified: turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/ContentTool.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/ContentTool.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/ContentTool.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/ContentTool.java Thu Oct 1 13:18:35 2015 @@ -97,12 +97,13 @@ public class ContentTool */ /** - * This will initialise a ContentTool object that was + * This will initialize a ContentTool object that was * constructed with the default constructor (ApplicationTool * method). * - * @param data assumed to be a RunData object + * @param data assumed to be a PipelineData object */ + @Override public void init(Object data) { // we just blithely cast to RunData as if another object @@ -141,6 +142,7 @@ public class ContentTool /** * Refresh method - does nothing */ + @Override public void refresh() { // empty Modified: turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/TemplateLink.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/TemplateLink.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/TemplateLink.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/TemplateLink.java Thu Oct 1 13:18:35 2015 @@ -101,12 +101,13 @@ public class TemplateLink */ /** - * This will initialise a TemplateLink object that was + * This will initialize a TemplateLink object that was * constructed with the default constructor (ApplicationTool * method). * - * @param data assumed to be a RunData object + * @param data assumed to be a PipelineData object */ + @Override public void init(Object data) { // we just blithely cast to RunData as if another object @@ -137,6 +138,7 @@ public class TemplateLink /** * Refresh method - does nothing */ + @Override public void refresh() { // empty Modified: turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/UITool.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/UITool.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/UITool.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/pull/tools/UITool.java Thu Oct 1 13:18:35 2015 @@ -79,6 +79,7 @@ public class UITool implements Applicati /** * Refresh the tool. */ + @Override public void refresh() { TurbineUI.refresh(getSkin()); @@ -128,6 +129,7 @@ public class UITool implements Applicati /** * Retrieve the skin name. + * @return the selected skin name */ public String getSkin() { @@ -209,8 +211,9 @@ public class UITool implements Applicati * method would probably be enough, but I'm not absolutely positive. * * @param imageId the id of the image whose URL will be generated. - * @param data the RunDate to use as the source of the ServerData to use as + * @param data the RunData to use as the source of the ServerData to use as * the basis for the URL. + * @return the image URL */ public String image(String imageId, RunData data) { @@ -228,6 +231,7 @@ public class UITool implements Applicati * * @param imageId the id of the image whose URL will be generated. * @param serverData the serverData to use as the basis for the URL. + * @return the image URL */ public String image(String imageId, ServerData serverData) { @@ -239,6 +243,7 @@ public class UITool implements Applicati * stored in the WEBAPP/resources/ui/skins/[SKIN]/images directory. * * @param imageId the id of the image whose URL will be generated. + * @return the image URL */ public String image(String imageId) { @@ -255,8 +260,9 @@ public class UITool implements Applicati * a load balanced situation. I think in most cases the style() method would * probably be enough, but I'm not absolutely positive. * - * @param data the RunDate to use as the source of the ServerData to use as + * @param data the RunData to use as the source of the ServerData to use as * the basis for the URL. + * @return the CSS URL */ public String getStylecss(RunData data) { @@ -274,6 +280,7 @@ public class UITool implements Applicati * probably be enough, but I'm not absolutely positive. * * @param serverData the serverData to use as the basis for the URL. + * @return the CSS URL */ public String getStylecss(ServerData serverData) { @@ -284,6 +291,7 @@ public class UITool implements Applicati * Retrieve the URL for the style sheet that is part of the skin. The style * is stored in the WEBAPP/resources/ui/skins/[SKIN] directory with the * filename skin.css + * @return the CSS URL */ public String getStylecss() { @@ -302,6 +310,7 @@ public class UITool implements Applicati * @param filename the name of the script file whose URL will be generated. * @param data the RunDate to use as the source of the ServerData to use as * the basis for the URL. + * @return the script URL */ public String getScript(String filename, RunData data) { @@ -319,6 +328,7 @@ public class UITool implements Applicati * * @param filename the name of the script file whose URL will be generated. * @param serverData the serverData to use as the basis for the URL. + * @return the script URL */ public String getScript(String filename, ServerData serverData) { @@ -330,6 +340,7 @@ public class UITool implements Applicati * is stored in the WEBAPP/resources/ui/skins/[SKIN] directory. * * @param filename the name of the script file whose URL will be generated. + * @return the script URL */ public String getScript(String filename) { @@ -342,6 +353,7 @@ public class UITool implements Applicati * @param data This is null, RunData or User depending upon specified tool * scope. */ + @Override public void init(Object data) { if (data == null) Modified: turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/DateFormatter.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/DateFormatter.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/DateFormatter.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/DateFormatter.java Thu Oct 1 13:18:35 2015 @@ -62,6 +62,7 @@ public class DateFormatter * * @param data initialization data */ + @Override public void init(Object data) { dateFormat = Turbine.getConfiguration() @@ -75,6 +76,7 @@ public class DateFormatter * if it is using configuration information * that is typically cached after initialization */ + @Override public void refresh() { // empty Modified: turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/SessionData.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/SessionData.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/SessionData.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/pull/util/SessionData.java Thu Oct 1 13:18:35 2015 @@ -21,9 +21,9 @@ package org.apache.turbine.services.pull */ -import java.util.Map; import java.util.HashMap; import java.util.Iterator; +import java.util.Map; import org.apache.turbine.services.pull.ApplicationTool; @@ -46,6 +46,7 @@ public class SessionData implements Appl * * @param data initialization data */ + @Override public void init(Object data) { dataStorage = new HashMap<String, Object>(); @@ -54,6 +55,7 @@ public class SessionData implements Appl /** * Refresh the application tool. */ + @Override public void refresh() { // do nothing Modified: turbine/core/trunk/src/java/org/apache/turbine/services/rundata/DefaultTurbineRunData.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/rundata/DefaultTurbineRunData.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/rundata/DefaultTurbineRunData.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/rundata/DefaultTurbineRunData.java Thu Oct 1 13:18:35 2015 @@ -1412,7 +1412,7 @@ public class DefaultTurbineRunData * Gets the parameter parser without parsing the parameters. * * @return the parameter parser. - * @todo Does this method make sense? Pulling the parameter out of + * TODO Does this method make sense? Pulling the parameter out of * the run data object before setting a request (which happens * only in getParameters() leads to the Parameter parser having * no object and thus the default or even an undefined encoding Modified: turbine/core/trunk/src/java/org/apache/turbine/services/rundata/TurbineRunDataService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/rundata/TurbineRunDataService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/rundata/TurbineRunDataService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/rundata/TurbineRunDataService.java Thu Oct 1 13:18:35 2015 @@ -205,7 +205,7 @@ public class TurbineRunDataService * @return a new or recycled RunData object. * @throws TurbineException if the operation fails. * @throws IllegalArgumentException if any of the parameters are null. - * @todo The "key" parameter should be removed in favor of just looking up what class via the roleConfig avalon file. + * TODO The "key" parameter should be removed in favor of just looking up what class via the roleConfig avalon file. */ @Override public RunData getRunData(String key, Modified: turbine/core/trunk/src/java/org/apache/turbine/services/schedule/AbstractJobEntry.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/schedule/AbstractJobEntry.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/schedule/AbstractJobEntry.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/schedule/AbstractJobEntry.java Thu Oct 1 13:18:35 2015 @@ -27,6 +27,11 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.turbine.util.TurbineException; +/** + * This class provides the basic implementation of common features for a scheduled job entry. + * + * @author <a href="mailto:[email protected]";>Thomas Vandahl</a> + */ public abstract class AbstractJobEntry implements JobEntry { /** Logging */ @@ -39,7 +44,7 @@ public abstract class AbstractJobEntry i private long runtime = 0; /** schedule types **/ - public enum ScheduleType { + protected enum ScheduleType { SECOND, MINUTE, WEEK_DAY, Modified: turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobEntryQuartz.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobEntryQuartz.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobEntryQuartz.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobEntryQuartz.java Thu Oct 1 13:18:35 2015 @@ -31,7 +31,13 @@ import org.quartz.JobDetail; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.quartz.Trigger; +import org.quartz.core.QuartzScheduler; +/** + * This implements a Turbine scheduled job model for the {@link QuartzScheduler}. + * + * @author <a href="mailto:[email protected]";>Thomas Vandahl</a> + */ public class JobEntryQuartz implements JobEntry, Job { private int jobId; @@ -41,6 +47,9 @@ public class JobEntryQuartz implements J private boolean isnew = true; private AtomicBoolean active = new AtomicBoolean(false); + /** + * the default Quartz schedule group name for Turbine jobs + */ public static final String DEFAULT_JOB_GROUP_NAME = "TURBINE"; /** Modified: turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobQueue.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobQueue.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobQueue.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/schedule/JobQueue.java Thu Oct 1 13:18:35 2015 @@ -32,6 +32,7 @@ import org.apache.turbine.util.TurbineEx * @author <a href="mailto:[email protected]";>Dave Bryson</a> * @author <a href="mailto:[email protected]";>Quinton McCombs</a> * @version $Id: JobQueue.java 615328 2008-01-25 20:25:05Z tv $ + * @param <J> a specialized job entry type */ public class JobQueue<J extends JobEntry> { @@ -151,9 +152,9 @@ public class JobQueue<J extends JobEntry * Modify a job on the queue. * * @param je A JobEntry with the job to modify + * @throws TurbineException if the runtime calculation fails */ - public synchronized void modify(J je) - throws TurbineException + public synchronized void modify(J je) throws TurbineException { remove(je); je.calcRunTime(); Modified: turbine/core/trunk/src/java/org/apache/turbine/services/schedule/SchedulerTool.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/schedule/SchedulerTool.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/schedule/SchedulerTool.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/schedule/SchedulerTool.java Thu Oct 1 13:18:35 2015 @@ -75,6 +75,7 @@ public class SchedulerTool implements Ap /** * Determines if the scheduler service is currently enabled. + * @return true if the scheduler is enabled */ public boolean isEnabled() { @@ -84,7 +85,7 @@ public class SchedulerTool implements Ap /** * Gets the job identified by the jobId. * - * @param jobId Id of the job to retreive. + * @param jobId Id of the job to retrieve. * @return The job. Null if the jobId is not found. */ public JobEntry getJob(String jobId) Modified: turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultUserManager.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultUserManager.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultUserManager.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultUserManager.java Thu Oct 1 13:18:35 2015 @@ -72,6 +72,7 @@ public class DefaultUserManager implemen * * @param conf A Configuration object to init this Manager */ + @Override public void init(Configuration conf) { ServiceManager manager = TurbineServices.getInstance(); @@ -87,6 +88,7 @@ public class DefaultUserManager implemen * @return true if the specified account exists * @throws DataBackendException if there was an error accessing the data backend. */ + @Override public boolean accountExists(User user) throws DataBackendException { @@ -102,6 +104,7 @@ public class DefaultUserManager implemen * @return true if the specified account exists * @throws DataBackendException if there was an error accessing the data backend. */ + @Override public boolean accountExists(String userName) throws DataBackendException { @@ -119,6 +122,7 @@ public class DefaultUserManager implemen * @exception DataBackendException if there is a problem accessing the * storage. */ + @Override public <U extends User> U retrieve(String username) throws UnknownEntityException, DataBackendException { @@ -140,6 +144,7 @@ public class DefaultUserManager implemen * @throws DataBackendException if there is a problem accessing the * storage. */ + @Override public List<? extends User> retrieveList(Object criteria) throws DataBackendException { @@ -171,6 +176,7 @@ public class DefaultUserManager implemen * @exception DataBackendException if there is a problem accessing the * storage. */ + @Override public <U extends User> U retrieve(String username, String password) throws PasswordMismatchException, UnknownEntityException, DataBackendException @@ -189,6 +195,7 @@ public class DefaultUserManager implemen * @exception DataBackendException if there is a problem accessing the * storage. */ + @Override public void store(User user) throws UnknownEntityException, DataBackendException { @@ -216,6 +223,7 @@ public class DefaultUserManager implemen * @exception DataBackendException if there is a problem accessing the * storage. */ + @Override public void saveOnSessionUnbind(User user) throws UnknownEntityException, DataBackendException { @@ -236,6 +244,7 @@ public class DefaultUserManager implemen * @exception DataBackendException if there is a problem accessing the * storage. */ + @Override public void authenticate(User user, String password) throws PasswordMismatchException, UnknownEntityException, DataBackendException @@ -252,6 +261,7 @@ public class DefaultUserManager implemen * @throws DataBackendException if there was an error accessing the data backend. * @throws EntityExistsException if the user account already exists. */ + @Override public void createAccount(User user, String initialPassword) throws EntityExistsException, DataBackendException { @@ -265,6 +275,7 @@ public class DefaultUserManager implemen * @throws DataBackendException if there was an error accessing the data backend. * @throws UnknownEntityException if the user account is not present. */ + @Override public void removeAccount(User user) throws UnknownEntityException, DataBackendException { @@ -284,6 +295,7 @@ public class DefaultUserManager implemen * @exception DataBackendException if there is a problem accessing the * storage. */ + @Override public void changePassword(User user, String oldPassword, String newPassword) throws PasswordMismatchException, UnknownEntityException, @@ -309,6 +321,7 @@ public class DefaultUserManager implemen * @exception DataBackendException if there is a problem accessing the * storage. */ + @Override public void forcePassword(User user, String password) throws UnknownEntityException, DataBackendException { @@ -323,6 +336,7 @@ public class DefaultUserManager implemen * @throws UnknownEntityException * if the anonymous User object couldn't be constructed. */ + @Override public <T extends User> T getAnonymousUser() throws UnknownEntityException { TurbineUser u = umDelegate.getAnonymousUser(); @@ -333,12 +347,12 @@ public class DefaultUserManager implemen * Checks whether a passed user object matches the anonymous user pattern * according to the configured user manager * - * @param An - * user object + * @param u a user object * * @return True if this is an anonymous user * */ + @Override public boolean isAnonymousUser(User u) { return umDelegate.isAnonymousUser(u); @@ -354,6 +368,7 @@ public class DefaultUserManager implemen * @throws DataBackendException * if the object could not be instantiated. */ + @Override public <T extends User> T getUserInstance() throws DataBackendException { TurbineUser u = umDelegate.getUserInstance(); @@ -373,6 +388,7 @@ public class DefaultUserManager implemen * @throws DataBackendException * if the object could not be instantiated. */ + @Override public <T extends User> T getUserInstance(String userName) throws DataBackendException { TurbineUser u = umDelegate.getUserInstance(userName); @@ -388,6 +404,7 @@ public class DefaultUserManager implemen * if the implementation of ACL interface could not be * determined, or does not exist. */ + @Override public <T extends AccessControlList> T getACL(User user) throws UnknownEntityException { return umDelegate.getACL(user); Modified: turbine/core/trunk/src/java/org/apache/turbine/services/security/SecurityService.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/security/SecurityService.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/security/SecurityService.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/security/SecurityService.java Thu Oct 1 13:18:35 2015 @@ -233,7 +233,7 @@ public interface SecurityService * Checks whether a passed user object matches the anonymous user pattern * according to the configured user manager * - * @param An user object + * @param u a user object * * @return True if this is an anonymous user * @@ -259,6 +259,8 @@ public interface SecurityService * LastLogin, AccessCounter, persistent pull tools, and any data stored * in the permData hashtable that is not mapped to a column will be saved. * + * @param user the user object + * * @exception UnknownEntityException if the user's account does not * exist in the database. * @exception DataBackendException if there is a problem accessing the @@ -470,7 +472,7 @@ public interface SecurityService /** * Retrieve a Group object with specified Id. * - * @param name the name of the Group. + * @param id the id of the Group. * * @return an object representing the Group with specified name. * @@ -498,7 +500,7 @@ public interface SecurityService /** * Retrieve a Role object with specified Id. * - * @param name the name of the Role. + * @param id the id of the Role. * * @return an object representing the Role with specified name. * @@ -526,7 +528,7 @@ public interface SecurityService /** * Retrieve a Permission object with specified Id. * - * @param name the name of the Permission. + * @param id the id of the Permission. * * @return an object representing the Permission with specified name. * Modified: turbine/core/trunk/src/java/org/apache/turbine/services/security/TurbineSecurity.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/security/TurbineSecurity.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/security/TurbineSecurity.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/security/TurbineSecurity.java Thu Oct 1 13:18:35 2015 @@ -24,6 +24,7 @@ import org.apache.fulcrum.security.acl.A import org.apache.fulcrum.security.entity.Group; import org.apache.fulcrum.security.entity.Permission; import org.apache.fulcrum.security.entity.Role; +import org.apache.fulcrum.security.model.turbine.TurbineModelManager; import org.apache.fulcrum.security.util.DataBackendException; import org.apache.fulcrum.security.util.EntityExistsException; import org.apache.fulcrum.security.util.FulcrumSecurityException; @@ -47,7 +48,7 @@ import org.apache.turbine.services.Turbi * <p> Certain Roles that the Users may have in the system may are not related * to any specific resource nor entity. They are assigned within a special group * named 'global' that can be referenced in the code as - * {@link org.apache.turbine.om.security.Group#GLOBAL_GROUP_NAME}. + * {@link TurbineModelManager#GLOBAL_GROUP_NAME}. * * @author <a href="mailto:[email protected]";>Rafal Krzewski</a> * @author <a href="mailto:[email protected]";>Henning P. Schmiedehausen</a> @@ -212,6 +213,8 @@ public abstract class TurbineSecurity * LastLogin, AccessCounter, persistent pull tools, and any data stored * in the permData hashtable that is not mapped to a column will be saved. * + * @param user the user in the session + * * @exception UnknownEntityException if the user's account does not * exist in the database. * @exception DataBackendException if there is a problem accessing the @@ -497,7 +500,7 @@ public abstract class TurbineSecurity /** * Retrieve a Group object with specified Id. * - * @param name the name of the Group. + * @param groupId the id of the Group. * * @return an object representing the Group with specified name. * @@ -584,7 +587,7 @@ public abstract class TurbineSecurity /** * Retrieve a Role object with specified Id. * - * @param name the name of the Role. + * @param roleId the id of the Role. * * @return an object representing the Role with specified name. * @@ -618,7 +621,7 @@ public abstract class TurbineSecurity /** * Retrieve a Permission object with specified Id. * - * @param name the name of the Permission. + * @param permissionId the id of the Permission. * * @return an object representing the Permission with specified name. * Modified: turbine/core/trunk/src/java/org/apache/turbine/services/security/UserManager.java URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/security/UserManager.java?rev=1706239&r1=1706238&r2=1706239&view=diff ============================================================================== --- turbine/core/trunk/src/java/org/apache/turbine/services/security/UserManager.java (original) +++ turbine/core/trunk/src/java/org/apache/turbine/services/security/UserManager.java Thu Oct 1 13:18:35 2015 @@ -150,6 +150,8 @@ public interface UserManager * LastLogin, AccessCounter, persistent pull tools, and any data stored * in the permData hashtable that is not mapped to a column will be saved. * + * @param user the user in the session + * * @exception UnknownEntityException if the user's account does not * exist in the database. * @exception DataBackendException if there is a problem accessing the @@ -244,8 +246,7 @@ public interface UserManager * Checks whether a passed user object matches the anonymous user pattern * according to the configured user manager * - * @param An - * user object + * @param u a user object * * @return True if this is an anonymous user * @@ -281,8 +282,9 @@ public interface UserManager /** * Return a Class object representing the system's chosen implementation of - * of ACL interface. + * of ACL interface for the given user * + * @param user the user * @return systems's chosen implementation of ACL interface. * @throws UnknownEntityException * if the implementation of ACL interface could not be
