Author: painter
Date: Mon Jan 7 18:48:42 2019
New Revision: 1850675
URL: http://svn.apache.org/viewvc?rev=1850675&view=rev
Log:
JavaDoc cleanup, only remaining issues I think are with torque generated classes
Modified:
turbine/core/trunk/src/java/org/apache/turbine/Turbine.java
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/sessionvalidator/SessionValidator.java
turbine/core/trunk/src/java/org/apache/turbine/om/security/DefaultUserImpl.java
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/QuartzSchedulerService.java
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/TorqueSchedulerService.java
turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultSecurityService.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/UserManager.java
turbine/core/trunk/src/java/org/apache/turbine/services/session/SessionTool.java
turbine/core/trunk/src/java/org/apache/turbine/services/template/mapper/DirectTemplateMapper.java
turbine/core/trunk/src/java/org/apache/turbine/util/ObjectUtils.java
turbine/core/trunk/src/java/org/apache/turbine/util/RunData.java
turbine/core/trunk/src/java/org/apache/turbine/util/TurbineConfig.java
turbine/core/trunk/src/java/org/apache/turbine/util/TurbineException.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/TemplateSecurityCheck.java
turbine/core/trunk/src/java/org/apache/turbine/util/uri/BaseURI.java
turbine/core/trunk/src/java/org/apache/turbine/util/uri/DataURI.java
turbine/core/trunk/src/java/org/apache/turbine/util/uri/TurbineURI.java
turbine/core/trunk/src/test/org/apache/turbine/pipeline/DefaultLoginValveTest.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=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/Turbine.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/Turbine.java Mon Jan 7
18:48:42 2019
@@ -73,11 +73,16 @@ import org.apache.turbine.util.TurbineEx
import org.apache.turbine.util.uri.URIConstants;
/**
+ * <p>
* Turbine is the main servlet for the entire system. If you
* need to perform initialization of a service, then you should implement the
* Services API and let your code be initialized by it.
+ * </p>
+ *
* <p>
* Turbine servlet recognizes the following initialization parameters.
+ * </p>
+ *
* <ul>
* <li><code>properties</code> the path to TurbineResources.properties file
* used to configure Turbine, relative to the application root.</li>
@@ -373,8 +378,8 @@ public class Turbine extends HttpServlet
* @param config the Servlet Configuration
* @param context Servlet Context
* @return The resolved Configuration Path
- * @throws IOException
- * @throws ConfigurationException
+ * @throws IOException if configuration path not found
+ * @throws ConfigurationException if failed to configure
*/
protected Path configureApplication( ServletConfig config, ServletContext
context )
throws IOException, ConfigurationException
@@ -479,6 +484,12 @@ public class Turbine extends HttpServlet
* parameter, looking first for a servlet-specific parameter, then
* for a global parameter, and using the provided default if not
* found.
+ *
+ * @param context the servlet context
+ * @param config configuration object
+ * @param name name of parameter
+ * @param defaultValue of the parameter
+ * @return String value of the parameter
*/
protected String findInitParameter(ServletContext context,
ServletConfig config, String name, String defaultValue)
@@ -900,7 +911,7 @@ public class Turbine extends HttpServlet
/**
* Checks Log4j 2 Context, loads log4File, if configured and configuration
is not already located.
* @param logConf Configuration file path
- * @throws IOException
+ * @throws IOException if path not found
*/
protected void configureLogging(Path logConf) throws IOException
{
Modified:
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
Mon Jan 7 18:48:42 2019
@@ -88,8 +88,9 @@ public class AnnotationProcessor
*
* @see #isAuthorized(AccessibleObject, TurbineAccessControlList,
ConditionType)
*
- * @param object
- * @param acl
+ * @param <A> ACL instance
+ * @param object accessible object to test
+ * @param acl access control list
* @return true if the execution is allowed
*/
public static <A extends TurbineAccessControlList<?>> boolean
isAuthorized(AccessibleObject object, A acl)
@@ -99,12 +100,13 @@ public class AnnotationProcessor
/**
* Check if the object given is authorized to be executed based on its
annotations
- * The method's return value depends on the conditonType, cft. {@link
RoleConditionType}.
+ * The method's return value depends on the conditonType, refer to the
ConditionType
*
+ * @param <A> ACL instance
* @param object the object
- * @param acl
- * @param conditonType either {@link RoleConditionType#COMPOUND}: The
method will return false if one of the annotations denies execution
- * or {@link RoleConditionType#SINGLE} : The method
will return true if one of the annotations allows execution
+ * @param acl access control list
+ * @param conditonType either {@link ConditionType#COMPOUND}: The method
will return false if one of the annotations denies execution
+ * or {@link ConditionType#ANY} : The method will
return true if one of the annotations allows execution
* @return true if the execution is allowed
*/
public static <A extends TurbineAccessControlList<?>> boolean
isAuthorized(AccessibleObject object, A acl, ConditionType conditonType)
Modified:
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/sessionvalidator/SessionValidator.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/actions/sessionvalidator/SessionValidator.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/sessionvalidator/SessionValidator.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/modules/actions/sessionvalidator/SessionValidator.java
Mon Jan 7 18:48:42 2019
@@ -36,16 +36,16 @@ import org.apache.turbine.util.RunData;
* TurbineResources.properties.
*
* <p>
- *
* Other systems generally have a database table which stores this
* information, but we take advantage of the Servlet API here to save
* a hit to the database for each and every connection that a user
* makes.
- *
+ * </p>
+ *
* <p>
- *
* This action is special in that it should only be executed by the
* Turbine servlet.
+ * </p>
*
* @author <a href="mailto:[email protected]";>Dave Bryson</a>
* @version $Id$
@@ -73,7 +73,7 @@ public abstract class SessionValidator e
// browsers back button and submitting stale data.
/**
*
- * @param data
+ * @param data RunData object
* @param screenOnly {@link DefaultSessionValidator}
*/
protected void handleFormCounterToken( RunData data, boolean screenOnly )
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=1850675&r1=1850674&r2=1850675&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
Mon Jan 7 18:48:42 2019
@@ -289,7 +289,8 @@ public class DefaultUserImpl implements
* Get the User/Group/Role set associated with this entity
*
* @return a set of User/Group/Role relations
- * @throws DataBackendException
+ * @throws DataBackendException if there was an error accessing the data
+ * backend.
*/
@Override
public <T extends TurbineUserGroupRole> Set<T> getUserGroupRoleSet()
throws DataBackendException
@@ -314,7 +315,8 @@ public class DefaultUserImpl implements
*
* @param userGroupRole
* a User/Group/Role relation to add
- * @throws DataBackendException
+ * @throws DataBackendException if there was an error accessing the data
+ * backend.
*/
@Override
public void addUserGroupRole(TurbineUserGroupRole userGroupRole) throws
DataBackendException
@@ -327,7 +329,8 @@ public class DefaultUserImpl implements
*
* @param userGroupRole
* a User/Group/Role relation to remove
- * @throws DataBackendException
+ * @throws DataBackendException if there was an error accessing the data
+ * backend.
*/
@Override
public void removeUserGroupRole(TurbineUserGroupRole userGroupRole) throws
DataBackendException
Modified:
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/QuartzSchedulerService.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/schedule/QuartzSchedulerService.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/QuartzSchedulerService.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/QuartzSchedulerService.java
Mon Jan 7 18:48:42 2019
@@ -293,7 +293,7 @@ public class QuartzSchedulerService
/**
* Sets the enabled status of the scheduler
*
- * @param enabled
+ * @param enabled true if enabled
*
*/
protected void setEnabled(boolean enabled)
Modified:
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/TorqueSchedulerService.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/schedule/TorqueSchedulerService.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/TorqueSchedulerService.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/services/schedule/TorqueSchedulerService.java
Mon Jan 7 18:48:42 2019
@@ -41,7 +41,7 @@ public class TorqueSchedulerService exte
* Load all jobs from configuration storage
*
* @return the list of pre-configured jobs
- * @throws TurbineException
+ * @throws TurbineException if unable to load jobs
*/
@Override
protected List<? extends JobEntry> loadJobs() throws TurbineException
Modified:
turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultSecurityService.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultSecurityService.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultSecurityService.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/services/security/DefaultSecurityService.java
Mon Jan 7 18:48:42 2019
@@ -861,8 +861,10 @@ public class DefaultSecurityService
* @param role the old role
* @param newRole the new role
*
- * @throws DataBackendException
- * @throws UnknownEntityException
+ * @throws DataBackendException if there was an error accessing the data
+ * backend.
+ * @throws UnknownEntityException if user account, group or role is not
+ * present.
*/
@Override
public void replaceRole(User user, Role role, Role newRole)
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=1850675&r1=1850674&r2=1850675&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
Mon Jan 7 18:48:42 2019
@@ -50,18 +50,23 @@ import org.apache.turbine.util.ObjectUti
* Turbine-specific ones.
*
*
- * <ol><li>either in a method with the same name (and very similar signature)
+ * <ol>
+ * <li>either in a method with the same name (and very similar signature)</li>
* <li>or mapped to method names as listed below:
- *
+ *
* <ul>
- * <li>method(s) in this manager -> Fulcrum manager method(s)
- * <li>{@link #createAccount(User, String)}createAccount -> addUser(User,
String)
- * <li>{@link #removeAccount(User)} -> removeUser(User)
- * <li>{@link #store(User)} -> saveUser(User)
- * <li>{@link #retrieve(String)} and {@link #retrieve(String, String)} ->
getUser(String), getUser(String, String)
- * <li>{@link #retrieveList(Object)} ->getAllUsers()
- * <li>{@link #accountExists(String)}, {@link #accountExists(User)} ->
checkExists(String), checkExists(User)
- *
+ * <li>method(s) in this manager -> Fulcrum manager method(s)
+ * <li>{@link #createAccount(User, String)}createAccount -> addUser(User,
String)
+ * <li>{@link #removeAccount(User)} -> removeUser(User)
+ * <li>{@link #store(User)} -> saveUser(User)
+ * <li>{@link #retrieve(String)} and {@link #retrieve(String, String)} ->
getUser(String), getUser(String, String)
+ * <li>{@link #retrieveList(Object)} -> getAllUsers()
+ * <li>{@link #accountExists(String)}, {@link #accountExists(User)} ->
checkExists(String), checkExists(User)
+ * </ul>
+ *
+ * </li>
+ * </ol>
+ *
* In this way all public methods of Fulcrum {@link TurbineUserManager}
interface are used by reference of the Fulcrum delegate {@link #umDelegate}
* and wrapped by this manager.
*
@@ -85,13 +90,13 @@ public class DefaultUserManager implemen
/**
* Wrap a Fulcrum user object into a Turbine user object
*
+ * @param <U> user class
* @param user the user object to delegate to
*
* @return the wrapped object
*/
protected <U extends User> U wrap(TurbineUser user)
{
- // U u = (U)new DefaultUserImpl(user);
@SuppressWarnings("unchecked")
U u = (U) getUserWrapper(user);
return u;
@@ -100,6 +105,7 @@ public class DefaultUserManager implemen
/**
* Exception could be ignored, as it is tested before in {@link
#init(Configuration)}.
*
+ * @param <U> user class
* @param user the user object to wrap
* @return instance extending {@link User}
*/
@@ -154,16 +160,11 @@ public class DefaultUserManager implemen
SecurityService.USER_WRAPPER_KEY,
SecurityService.USER_WRAPPER_DEFAULT);
-// String userClass = conf.getString(
-// SecurityService.USER_KEY,
-// SecurityService.USER_DEFAULT);
-
try
{
factoryService =
(FactoryService)manager.getService(FactoryService.ROLE);
// check instantiation
-
// should provide default constructor
TurbineUser turbineUser = umDelegate.getUserInstance();
//(TurbineUser)
factoryService.getInstance(userClass);
@@ -179,7 +180,6 @@ public class DefaultUserManager implemen
{
throw new InitializationException("Failed to instantiate user
wrapper class", e);
}
-
}
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=1850675&r1=1850674&r2=1850675&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
Mon Jan 7 18:48:42 2019
@@ -38,17 +38,23 @@ import org.apache.turbine.services.Servi
import org.apache.turbine.services.security.passive.PassiveUserManager;
/**
+ * <p>
* The Security Service manages Users, Groups Roles and Permissions in the
* system.
- *
+ * </p>
+ *
+ * <p>
* The task performed by the security service include creation and removal of
* accounts, groups, roles, and permissions; assigning users roles in groups;
* assigning roles specific permissions and construction of objects
* representing these logical entities.
+ * </p>
*
- * <p> Because of pluggable nature of the Services, it is possible to create
+ * <p>
+ * Because of pluggable nature of the Services, it is possible to create
* multiple implementations of SecurityService, for example employing database
- * and directory server as the data backend.<br>
+ * and directory server as the data backend.
+ * </p>
*
* @author <a href="mailto:[email protected]";>Rafal Krzewski</a>
* @author <a href="mailto:[email protected]";>Henning P. Schmiedehausen</a>
@@ -95,6 +101,7 @@ public interface SecurityService
/**
* Construct a blank User object.
*
+ * @param <U> user class
* @return an object implementing User interface.
* @throws UnknownEntityException if the object could not be instantiated.
*/
@@ -104,6 +111,7 @@ public interface SecurityService
/**
* Construct a blank User object.
*
+ * @param <U> user class
* @param userName The name of the user.
*
* @return an object implementing User interface.
@@ -115,6 +123,7 @@ public interface SecurityService
/**
* Construct a blank Group object.
*
+ * @param <G> group class
* @return an object implementing Group interface.
* @throws UnknownEntityException if the object could not be instantiated.
*/
@@ -124,6 +133,7 @@ public interface SecurityService
/**
* Construct a blank Group object.
*
+ * @param <G> group class
* @param groupName The name of the Group
*
* @return an object implementing Group interface.
@@ -135,6 +145,7 @@ public interface SecurityService
/**
* Construct a blank Permission object.
*
+ * @param <P> permission class
* @return an object implementing Permission interface.
* @throws UnknownEntityException if the object could not be instantiated.
*/
@@ -144,6 +155,7 @@ public interface SecurityService
/**
* Construct a blank Permission object.
*
+ * @param <P> permission class
* @param permName The name of the Permission
*
* @return an object implementing Permission interface.
@@ -155,6 +167,7 @@ public interface SecurityService
/**
* Construct a blank Role object.
*
+ * @param <R> role class
* @return an object implementing Role interface.
* @throws UnknownEntityException if the object could not be instantiated.
*/
@@ -164,6 +177,7 @@ public interface SecurityService
/**
* Construct a blank Role object.
*
+ * @param <R> role class
* @param roleName The name of the Role
*
* @return an object implementing Role interface.
@@ -208,6 +222,7 @@ public interface SecurityService
* Authenticates an user, and constructs an User object to represent
* him/her.
*
+ * @param <U> user class
* @param username The user name.
* @param password The user password.
* @return An authenticated Turbine User.
@@ -224,6 +239,7 @@ public interface SecurityService
* Constructs an User object to represent a registered user of the
* application.
*
+ * @param <U> user class
* @param username The user name.
* @return A Turbine User.
* @throws DataBackendException if there was an error accessing the data
@@ -237,6 +253,7 @@ public interface SecurityService
* Constructs an User object to represent an anonymous user of the
* application.
*
+ * @param <U> user class
* @return An anonymous Turbine User.
* @throws UnknownEntityException if the anonymous User object couldn't be
* constructed.
@@ -249,7 +266,6 @@ public interface SecurityService
* according to the configured user manager
*
* @param u a user object
- *
* @return True if this is an anonymous user
*
*/
@@ -359,6 +375,7 @@ public interface SecurityService
/**
* Constructs an AccessControlList for a specific user.
*
+ * @param <A> ACL class
* @param user the user for whom the AccessControlList are to be retrieved
* @return A new AccessControlList object.
* @throws DataBackendException if there was an error accessing the data
backend.
@@ -487,6 +504,7 @@ public interface SecurityService
* Provides a reference to the Group object that represents the
* <a href="#global">global group</a>.
*
+ * @param <G> group class
* @return A Group object that represents the global group.
*/
<G extends Group> G getGlobalGroup();
@@ -494,6 +512,7 @@ public interface SecurityService
/**
* Retrieve a Group object with specified name.
*
+ * @param <G> group class
* @param name the name of the Group.
* @return an object representing the Group with specified name.
* @throws DataBackendException if there was an error accessing the data
@@ -506,6 +525,7 @@ public interface SecurityService
/**
* Retrieve a Group object with specified Id.
*
+ * @param <G> group class
* @param id the id of the Group.
*
* @return an object representing the Group with specified name.
@@ -521,7 +541,8 @@ public interface SecurityService
/**
* Retrieve a Role object with specified name.
- *
+ *
+ * @param <R> role class
* @param name the name of the Role.
* @return an object representing the Role with specified name.
* @throws DataBackendException if there was an error accessing the data
@@ -534,6 +555,7 @@ public interface SecurityService
/**
* Retrieve a Role object with specified Id.
*
+ * @param <R> role class
* @param id the id of the Role.
*
* @return an object representing the Role with specified name.
@@ -550,6 +572,7 @@ public interface SecurityService
/**
* Retrieve a Permission object with specified name.
*
+ * @param <P> permission class
* @param name the name of the Permission.
* @return an object representing the Permission with specified name.
* @throws DataBackendException if there was an error accessing the data
@@ -562,6 +585,7 @@ public interface SecurityService
/**
* Retrieve a Permission object with specified Id.
*
+ * @param <P> permission class
* @param id the id of the Permission.
*
* @return an object representing the Permission with specified name.
@@ -612,6 +636,7 @@ public interface SecurityService
/**
* Creates a new group with specified attributes.
*
+ * @param <G> group class
* @param group the object describing the group to be created.
* @return the new Group object.
* @throws DataBackendException if there was an error accessing the data
@@ -624,6 +649,7 @@ public interface SecurityService
/**
* Creates a new role with specified attributes.
*
+ * @param <R> role class
* @param role The object describing the role to be created.
* @return the new Role object.
* @throws DataBackendException if there was an error accessing the data
@@ -636,6 +662,7 @@ public interface SecurityService
/**
* Creates a new permission with specified attributes.
*
+ * @param <P> permission class
* @param permission The object describing the permission to be created.
* @return the new Permission object.
* @throws DataBackendException if there was an error accessing the data
@@ -720,8 +747,9 @@ public interface SecurityService
* @param role the old role
* @param newRole the new role
*
- * @throws DataBackendException
- * @throws UnknownEntityException
+ * @throws DataBackendException if there was an error accessing the data
+ * backend.
+ * @throws UnknownEntityException if the permission does not exist.
*/
void replaceRole( User user, Role role, Role newRole )
throws DataBackendException, UnknownEntityException;
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=1850675&r1=1850674&r2=1850675&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
Mon Jan 7 18:48:42 2019
@@ -86,6 +86,7 @@ public interface UserManager
* Retrieve a user from persistent storage using username as the
* key.
*
+ * @param <U> user class
* @param username the name of the user.
* @return an User object.
* @throws UnknownEntityException if the user's record does not
@@ -119,6 +120,7 @@ public interface UserManager
* to authenticate to the server as the user whose data is being
* retrieved.
*
+ * @param <U> user class
* @param username the name of the user.
* @param password the user supplied password.
* @return an User object.
@@ -237,6 +239,7 @@ public interface UserManager
* Constructs an User object to represent an anonymous user of the
* application.
*
+ * @param <U> user class
* @return An anonymous Turbine User.
* @throws UnknownEntityException
* if the anonymous User object couldn't be constructed.
@@ -260,6 +263,7 @@ public interface UserManager
* This method calls getUserClass, and then creates a new object using the
* default constructor.
*
+ * @param <U> user class
* @return an object implementing User interface.
* @throws DataBackendException
* if the object could not be instantiated.
@@ -272,6 +276,7 @@ public interface UserManager
* This method calls getUserClass, and then creates a new object using the
* default constructor.
*
+ * @param <U> user class
* @param userName
* The name of the user.
*
@@ -284,7 +289,8 @@ public interface UserManager
/**
* Return a Class object representing the system's chosen implementation of
* of ACL interface for the given user
- *
+ *
+ * @param <A> ACL class
* @param user the user
* @return systems's chosen implementation of ACL interface.
* @throws UnknownEntityException
Modified:
turbine/core/trunk/src/java/org/apache/turbine/services/session/SessionTool.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/session/SessionTool.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/services/session/SessionTool.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/services/session/SessionTool.java
Mon Jan 7 18:48:42 2019
@@ -119,7 +119,7 @@ public class SessionTool
/**
* Gets the User object of the the specified HttpSession.
*
- * @param session
+ * @param session the session
* @return the user from the session
*/
public User getUserFromSession(HttpSession session)
Modified:
turbine/core/trunk/src/java/org/apache/turbine/services/template/mapper/DirectTemplateMapper.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/services/template/mapper/DirectTemplateMapper.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/services/template/mapper/DirectTemplateMapper.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/services/template/mapper/DirectTemplateMapper.java
Mon Jan 7 18:48:42 2019
@@ -49,7 +49,7 @@ public class DirectTemplateMapper
/**
* Replace all "," with ".", but keep the extension.
*
- * about,directions,Driving.vm --> about/directions/Driving.vm
+ * about,directions,Driving.vm --> about/directions/Driving.vm
*
* @param template The template name.
* @return A class name for the given template.
Modified: turbine/core/trunk/src/java/org/apache/turbine/util/ObjectUtils.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/ObjectUtils.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/util/ObjectUtils.java
(original)
+++ turbine/core/trunk/src/java/org/apache/turbine/util/ObjectUtils.java Mon
Jan 7 18:48:42 2019
@@ -72,6 +72,7 @@ public abstract class ObjectUtils
/**
* Deserializes a single object from an array of bytes.
*
+ * @param <T> type of the object to return
* @param objectData The serialized object.
*
* @return The deserialized object, or <code>null</code> on failure.
Modified: turbine/core/trunk/src/java/org/apache/turbine/util/RunData.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/RunData.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/util/RunData.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/util/RunData.java Mon Jan 7
18:48:42 2019
@@ -117,6 +117,7 @@ public interface RunData extends Pipelin
/**
* Sets the access control list.
*
+ * @param <A> ACL type
* @param acl an access control list.
*/
<A extends AccessControlList> void setACL(A acl);
Modified: turbine/core/trunk/src/java/org/apache/turbine/util/TurbineConfig.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/TurbineConfig.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/util/TurbineConfig.java
(original)
+++ turbine/core/trunk/src/java/org/apache/turbine/util/TurbineConfig.java Mon
Jan 7 18:48:42 2019
@@ -61,10 +61,12 @@ import org.apache.turbine.annotation.Tur
* <p>
* If you need to use Turbine outside of a servlet container, you can
* use this class for initialization of the Turbine servlet.
- * <p>
+ * </p>
+ *
* <pre>
* TurbineConfig config = new TurbineConfig(".",
"conf/TurbineResources.properties");
* </pre>
+ *
* <p>
* All paths referenced in TurbineResources.properties and the path to
* the properties file itself (the second argument) will be resolved
@@ -72,11 +74,14 @@ import org.apache.turbine.annotation.Tur
* here - the directory where application was started. Don't worry about
* discarding the references to objects created above. They are not needed,
* once everything is initialized.
+ * </p>
+ *
* <p>
* In order to initialize the Services Framework outside of the Turbine
Servlet,
* you need to call the <code>init()</code> method. By default, this will
* initialize the Resource and Logging Services and any other services you
* have defined in your TurbineResources.properties file.
+ * </p>
*
* TODO Make this class enforce the lifecycle contracts
*
@@ -357,7 +362,7 @@ public class TurbineConfig
*
* @param s the path to the resource
* @return a URL pointing to the resource
- * @throws MalformedURLException
+ * @throws MalformedURLException if unable to parse path
*/
@Override
public URL getResource(String s)
Modified:
turbine/core/trunk/src/java/org/apache/turbine/util/TurbineException.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/TurbineException.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/util/TurbineException.java
(original)
+++ turbine/core/trunk/src/java/org/apache/turbine/util/TurbineException.java
Mon Jan 7 18:48:42 2019
@@ -24,6 +24,7 @@ package org.apache.turbine.util;
/**
* The base class of all exceptions thrown by Turbine.
*
+ * <p>
* It is intended to ease the debugging by carrying on the information
* about the exception which was caught and provoked throwing the
* current exception. Catching and rethrowing may occur multiple
@@ -31,10 +32,12 @@ package org.apache.turbine.util;
* are descendands of <code>TurbineException</code>, when the
* exception is finally printed out using any of the <code>
* printStackTrace()</code> methods, the stacktrace will contain
- * the information about all exceptions thrown and caught on
- * the way.
- * <p> Running the following program
- * <p><pre>
+ * the information about all exceptions thrown and caught on the way.
+ * </p>
+ *
+ * <p> Running the following program </p>
+ *
+ * <pre>
* 1 import org.apache.turbine.util.TurbineException;
* 2
* 3 public class Test {
@@ -66,9 +69,11 @@ package org.apache.turbine.util;
* 29 throw new Exception("baz");
* 30 }
* 31 }
- * </pre>
- * <p>Yields the following stacktrace:
- * <p><pre>
+ * </pre>
+ *
+ * <p>Yields the following stacktrace: </p>
+ *
+ * <pre>
* java.lang.Exception: baz: bar: foo
* at Test.c(Test.java:29)
* at Test.b(Test.java:22)
@@ -78,7 +83,7 @@ package org.apache.turbine.util;
* rethrown as TurbineException: foo
* at Test.a(Test.java:16)
* at Test.main(Test.java:6)
- * </pre><br>
+ * </pre>
*
* @author <a href="mailto:[email protected]";>Rafal Krzewski</a>
* @author <a href="mailto:[email protected]";>Daniel Rall</a>
Modified:
turbine/core/trunk/src/java/org/apache/turbine/util/TurbineXmlConfig.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/TurbineXmlConfig.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/util/TurbineXmlConfig.java
(original)
+++ turbine/core/trunk/src/java/org/apache/turbine/util/TurbineXmlConfig.java
Mon Jan 7 18:48:42 2019
@@ -25,13 +25,16 @@ import java.util.Map;
/**
* A class used for initialization of Turbine without a servlet container.
+ *
* <p>
* If you need to use Turbine outside of a servlet container, you can
* use this class for initialization of the Turbine servlet.
- * <p>
+ * </p>
+ *
* <pre>
* TurbineXmlConfig config = new TurbineXmlConfig(".",
"conf/TurbineResources.properties");
* </pre>
+ *
* <p>
* All paths referenced in TurbineResources.properties and the path to
* the properties file itself (the second argument) will be resolved
@@ -39,12 +42,15 @@ import java.util.Map;
* here - the directory where application was started. Don't worry about
* discarding the references to objects created above. They are not needed,
* once everything is initialized.
+ * </p>
+ *
* <p>
* In order to initialize the Services Framework outside of the Turbine
Servlet,
* you need to call the <code>init()</code> method. By default, this will
* initialize the Resource and Logging Services and any other services you
* have defined in your TurbineResources.properties file.
- *
+ * </p>
+ *
* TODO Make this class enforce the lifecycle contracts
*
* @author <a href="mailto:[email protected]";>Eric Pugh</a>
Modified:
turbine/core/trunk/src/java/org/apache/turbine/util/template/HtmlPageAttributes.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/template/HtmlPageAttributes.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/util/template/HtmlPageAttributes.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/util/template/HtmlPageAttributes.java
Mon Jan 7 18:48:42 2019
@@ -40,9 +40,13 @@ import org.apache.turbine.services.pull.
* The set/add methods are can be used from a screen template, action, screen
* class, layour template, or anywhere else. The get methods should be used in
* your layout template(s) to construct the appropriate HTML tags.
+ * </p>
+ *
*<p>
* Example usage of this tool to build the HEAD and BODY tags in your layout
* templates:
+ * </p>
+ *
* <p>
* <code>
* ## Set defaults for all pages using this layout. Anything set here can<br>
@@ -83,11 +87,14 @@ import org.apache.turbine.services.pull.
* #end<br>
* >
* </code>
+ * </p>
+ *
* <p>
* Example usages of this tool in your screen templates:<br>
* <code>$page.addScript($content.getURI("myJavascript.js")<br>
* $page.setTitle("My page title")<br>
* $page.setHttpEquiv("refresh","5;
URL=http://localhost/nextpage.html";)</code>
+ * </p>
*
* @author <a href="mailto:[email protected]";>Quinton McCombs</a>
* @author <a href="mailto:[email protected]";>Scott Eade</a>
@@ -221,7 +228,7 @@ public class HtmlPageAttributes
/**
* Adds a script reference
*
- * @param scriptURL
+ * @param scriptURL the url
* @return a <code>HtmlPageAttributes</code> (self).
*/
public HtmlPageAttributes addScript(String scriptURL)
@@ -570,7 +577,7 @@ public class HtmlPageAttributes
/**
* Sets the title of the stylesheet
*
- * @param title
+ * @param title of the stylesheet
*/
public void setTitle(String title)
{
Modified:
turbine/core/trunk/src/java/org/apache/turbine/util/template/TemplateSecurityCheck.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/template/TemplateSecurityCheck.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/util/template/TemplateSecurityCheck.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/util/template/TemplateSecurityCheck.java
Mon Jan 7 18:48:42 2019
@@ -35,7 +35,7 @@ import org.apache.turbine.util.RunData;
* Utility class to help check for proper authorization when using
* template screens. Sample usages:
*
- * <p><pre>
+ * <pre>
* TemplateSecurityCheck secCheck = new TemplateSecurityCheck( data );
* secCheck.setMessage( "Sorry, you do not have permission to " +
* "access this area." );
Modified: turbine/core/trunk/src/java/org/apache/turbine/util/uri/BaseURI.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/uri/BaseURI.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/util/uri/BaseURI.java
(original)
+++ turbine/core/trunk/src/java/org/apache/turbine/util/uri/BaseURI.java Mon
Jan 7 18:48:42 2019
@@ -384,7 +384,8 @@ public abstract class BaseURI
/**
* Set a Response Object to use when creating the
* response string.
- *
+ *
+ * @param response the servlet response
*/
protected void setResponse(HttpServletResponse response)
{
@@ -410,6 +411,7 @@ public abstract class BaseURI
* This is a convenience method to be
* used in the Link output routines of derived classes to
* easily append the correct path.
+ * </p>
*
* @param sb The StringBuilder to store context path and script name.
*/
@@ -446,7 +448,8 @@ public abstract class BaseURI
* <p>
* This is a convenience method to be
* used in the Link output routines of derived classes to
- * easily append the correct server scheme.
+ * easily append the correct server scheme.
+ * </p>
*
* @param sb The StringBuilder to store the scheme and port information.
*/
Modified: turbine/core/trunk/src/java/org/apache/turbine/util/uri/DataURI.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/uri/DataURI.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/util/uri/DataURI.java
(original)
+++ turbine/core/trunk/src/java/org/apache/turbine/util/uri/DataURI.java Mon
Jan 7 18:48:42 2019
@@ -107,7 +107,6 @@ public class DataURI
* encoded using HttpServletResponse.encodeUrl(). The resulting
* URL is absolute; it starts with http/https...
*
- * <p>
* <pre>
* TurbineURI tui = new TurbineURI (data, "UserScreen");
* tui.addPathInfo("user","jon");
@@ -118,6 +117,7 @@ public class DataURI
*
* <p>
* http://www.server.com/servlets/Turbine/screen/UserScreen/user/jon
+ * </p>
*
* @return A String with the built URL.
*/
@@ -145,7 +145,6 @@ public class DataURI
* encoded using HttpServletResponse.encodeUrl(). The resulting
* URL is relative to the webserver root.
*
- * <p>
* <pre>
* TurbineURI tui = new TurbineURI (data, "UserScreen");
* tui.addPathInfo("user","jon");
@@ -156,6 +155,7 @@ public class DataURI
*
* <p>
* /servlets/Turbine/screen/UserScreen/user/jon
+ * </p>
*
* @return A String with the built URL.
*/
Modified:
turbine/core/trunk/src/java/org/apache/turbine/util/uri/TurbineURI.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/util/uri/TurbineURI.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/util/uri/TurbineURI.java
(original)
+++ turbine/core/trunk/src/java/org/apache/turbine/util/uri/TurbineURI.java Mon
Jan 7 18:48:42 2019
@@ -587,7 +587,6 @@ public class TurbineURI
* encoded using HttpServletResponse.encodeUrl(). The resulting
* URL is absolute; it starts with http/https...
*
- * <p>
* <pre>
* TurbineURI tui = new TurbineURI (data, "UserScreen");
* tui.addPathInfo("user","jon");
@@ -598,6 +597,7 @@ public class TurbineURI
*
* <p>
* http://www.server.com/servlets/Turbine/screen/UserScreen/user/jon
+ * </p>
*
* @return A String with the built URL.
*/
@@ -620,7 +620,6 @@ public class TurbineURI
* encoded using HttpServletResponse.encodeUrl(). The resulting
* URL is relative to the webserver root.
*
- * <p>
* <pre>
* TurbineURI tui = new TurbineURI (data, "UserScreen");
* tui.addPathInfo("user","jon");
@@ -631,6 +630,7 @@ public class TurbineURI
*
* <p>
* /servlets/Turbine/screen/UserScreen/user/jon
+ * </p>
*
* @return A String with the built URL.
*/
Modified:
turbine/core/trunk/src/test/org/apache/turbine/pipeline/DefaultLoginValveTest.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/test/org/apache/turbine/pipeline/DefaultLoginValveTest.java?rev=1850675&r1=1850674&r2=1850675&view=diff
==============================================================================
---
turbine/core/trunk/src/test/org/apache/turbine/pipeline/DefaultLoginValveTest.java
(original)
+++
turbine/core/trunk/src/test/org/apache/turbine/pipeline/DefaultLoginValveTest.java
Mon Jan 7 18:48:42 2019
@@ -94,7 +94,8 @@ public class DefaultLoginValveTest exten
/**
* Tests the Valve.
*/
- @Test public void testDefaults() throws Exception
+ @Test
+ public void testDefaults() throws Exception
{
Vector<String> v = new Vector<String>();
v.add(LoginUser.CGI_USERNAME);
@@ -124,7 +125,8 @@ public class DefaultLoginValveTest exten
/**
* Tests the LogoutAction.
*/
- @Test public void testLogout() throws Exception
+ @Test
+ public void testLogout() throws Exception
{
User user = securityService.getUser("username");
user.setHasLoggedIn(Boolean.TRUE);
