This is an automated email from the ASF dual-hosted git repository. markt pushed a commit to branch 7.0.x in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit f87313772d1220116d2c1b832925fbb6a3db88f9 Author: Mark Thomas <ma...@apache.org> AuthorDate: Tue Nov 12 12:12:14 2019 +0000 Javadoc fixes for building with Java 13 --- java/org/apache/catalina/CatalinaFactory.java | 2 + java/org/apache/catalina/Container.java | 10 +- java/org/apache/catalina/ContainerEvent.java | 37 ++--- java/org/apache/catalina/ContainerServlet.java | 13 +- java/org/apache/catalina/Context.java | 213 ++++++++++++++++--------- java/org/apache/catalina/Engine.java | 14 +- java/org/apache/catalina/Group.java | 20 +-- java/org/apache/catalina/LifecycleEvent.java | 39 +---- java/org/apache/catalina/LifecycleState.java | 7 +- java/org/apache/catalina/Loader.java | 28 ++-- java/org/apache/catalina/Store.java | 13 +- java/org/apache/catalina/User.java | 14 +- java/org/apache/catalina/UserDatabase.java | 45 +++--- java/org/apache/catalina/Wrapper.java | 72 +++++---- 14 files changed, 275 insertions(+), 252 deletions(-) diff --git a/java/org/apache/catalina/CatalinaFactory.java b/java/org/apache/catalina/CatalinaFactory.java index cf41033..3cf27bc 100644 --- a/java/org/apache/catalina/CatalinaFactory.java +++ b/java/org/apache/catalina/CatalinaFactory.java @@ -43,6 +43,8 @@ public class CatalinaFactory { } /** + * @return Name of default Pipeline implementation class + * * @deprecated Unused. Will be removed in Tomcat 8.0.x. */ @Deprecated diff --git a/java/org/apache/catalina/Container.java b/java/org/apache/catalina/Container.java index 1ca34cc..970e1d0 100644 --- a/java/org/apache/catalina/Container.java +++ b/java/org/apache/catalina/Container.java @@ -133,7 +133,7 @@ public interface Container extends Lifecycle { // ------------------------------------------------------------- Properties /** - * Return descriptive information about this Container implementation and + * @return descriptive information about this Container implementation and * the corresponding version number, in the format * <code><description>/<version></code>. */ @@ -141,7 +141,7 @@ public interface Container extends Lifecycle { /** - * Return the Loader with which this Container is associated. If there is + * @return the Loader with which this Container is associated. If there is * no associated Loader, return the Loader associated with our parent * Container (if any); otherwise, return <code>null</code>. */ @@ -167,7 +167,7 @@ public interface Container extends Lifecycle { /** - * Return the Manager with which this Container is associated. If there is + * @return the Manager with which this Container is associated. If there is * no associated Manager, return the Manager associated with our parent * Container (if any); otherwise return <code>null</code>. */ @@ -183,7 +183,7 @@ public interface Container extends Lifecycle { /** - * Return an object which may be utilized for mapping to this component. + * @return an object which may be utilized for mapping to this component. */ @Deprecated public Object getMappingObject(); @@ -338,7 +338,7 @@ public interface Container extends Lifecycle { /** - * Return the Resources with which this Container is associated. If there + * @return Resources with which this Container is associated. If there * is no associated Resources object, return the Resources associated with * our parent Container (if any); otherwise return <code>null</code>. */ diff --git a/java/org/apache/catalina/ContainerEvent.java b/java/org/apache/catalina/ContainerEvent.java index f7cfaef..b651356 100644 --- a/java/org/apache/catalina/ContainerEvent.java +++ b/java/org/apache/catalina/ContainerEvent.java @@ -14,20 +14,15 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.catalina; - import java.util.EventObject; - /** * General event for notifying listeners of significant changes on a Container. * * @author Craig R. McClanahan */ - public final class ContainerEvent extends EventObject { private static final long serialVersionUID = 1L; @@ -35,13 +30,13 @@ public final class ContainerEvent extends EventObject { /** * The event data associated with this event. */ - private Object data = null; + private final Object data; /** * The event type this instance represents. */ - private String type = null; + private final String type; /** @@ -52,41 +47,41 @@ public final class ContainerEvent extends EventObject { * @param data Event data */ public ContainerEvent(Container container, String type, Object data) { - super(container); this.type = type; this.data = data; - } /** * Return the event data of this event. + * + * @return The data, if any, associated with this event. */ public Object getData() { - - return (this.data); - + return this.data; } /** * Return the Container on which this event occurred. + * + * @return The Container on which this event occurred. */ public Container getContainer() { - return (Container) getSource(); - } /** * Return the event type of this event. + * + * @return The event type of this event. Although this is a String, it is + * safe to rely on the value returned by this method remaining + * consistent between point releases. */ public String getType() { - - return (this.type); - + return this.type; } @@ -95,11 +90,7 @@ public final class ContainerEvent extends EventObject { */ @Override public String toString() { - - return ("ContainerEvent['" + getContainer() + "','" + - getType() + "','" + getData() + "']"); - + return "ContainerEvent['" + getContainer() + "','" + + getType() + "','" + getData() + "']"; } - - } diff --git a/java/org/apache/catalina/ContainerServlet.java b/java/org/apache/catalina/ContainerServlet.java index 68d778d..be999b1 100644 --- a/java/org/apache/catalina/ContainerServlet.java +++ b/java/org/apache/catalina/ContainerServlet.java @@ -14,11 +14,8 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.catalina; - /** * A <b>ContainerServlet</b> is a servlet that has access to Catalina * internal functionality, and is loaded from the Catalina class loader @@ -30,12 +27,10 @@ package org.apache.catalina; */ public interface ContainerServlet { - - // ------------------------------------------------------------- Properties - - /** - * Return the Wrapper with which this Servlet is associated. + * Obtain the Wrapper with which this Servlet is associated. + * + * @return The Wrapper with which this Servlet is associated. */ public Wrapper getWrapper(); @@ -46,6 +41,4 @@ public interface ContainerServlet { * @param wrapper The new associated Wrapper */ public void setWrapper(Wrapper wrapper); - - } diff --git a/java/org/apache/catalina/Context.java b/java/org/apache/catalina/Context.java index c4409d0..14562f0 100644 --- a/java/org/apache/catalina/Context.java +++ b/java/org/apache/catalina/Context.java @@ -14,11 +14,8 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.catalina; - import java.net.URL; import java.util.Locale; import java.util.Map; @@ -63,7 +60,6 @@ import org.apache.tomcat.util.http.mapper.Mapper; * * @author Craig R. McClanahan */ - public interface Context extends Container { @@ -97,6 +93,7 @@ public interface Context extends Container { */ public static final String CHANGE_SESSION_ID_EVENT = "changeSessionId"; + // ------------------------------------------------------------- Properties /** @@ -123,12 +120,11 @@ public interface Context extends Container { /** - * Return the set of initialized application event listener objects, - * in the order they were specified in the web application deployment - * descriptor, for this application. + * Obtain the registered application event listeners. * - * @exception IllegalStateException if this method is called before - * this application has started, or after it has been stopped + * @return An array containing the application event listener instances for + * this web application in the order they were specified in the web + * application deployment descriptor */ public Object[] getApplicationEventListeners(); @@ -144,12 +140,11 @@ public interface Context extends Container { /** - * Return the set of initialized application lifecycle listener objects, - * in the order they were specified in the web application deployment - * descriptor, for this application. + * Obtain the registered application lifecycle listeners. * - * @exception IllegalStateException if this method is called before - * this application has started, or after it has been stopped + * @return An array containing the application lifecycle listener instances + * for this web application in the order they were specified in the + * web application deployment descriptor */ public Object[] getApplicationLifecycleListeners(); @@ -165,7 +160,7 @@ public interface Context extends Container { /** - * Return the application available flag for this Context. + * @return the application available flag for this Context. * * @deprecated This will be removed in Tomcat 8.0.x onwards. Use * {@link #getState()}.{@link LifecycleState#isAvailable() @@ -176,7 +171,7 @@ public interface Context extends Container { /** - * Return the Locale to character set mapper for this Context. + * @return the Locale to character set mapper for this Context. * @deprecated Use {@link #getCharset(Locale)} */ @Deprecated @@ -198,12 +193,19 @@ public interface Context extends Container { * Obtain the character set name to use with the given Locale. Note that * different Contexts may have different mappings of Locale to character * set. + * + * @param locale The locale for which the mapped character set should be + * returned + * + * @return The name of the character set to use with the given Locale */ public String getCharset(Locale locale); /** * Return the URL of the XML descriptor for this context. + * + * @return The URL of the XML descriptor for this context */ public URL getConfigFile(); @@ -218,6 +220,9 @@ public interface Context extends Container { /** * Return the "correctly configured" flag for this Context. + * + * @return <code>true</code> if the Context has been correctly configured, + * otherwise <code>false</code> */ public boolean getConfigured(); @@ -234,6 +239,10 @@ public interface Context extends Container { /** * Return the "use cookies for session ids" flag. + * + * @return <code>true</code> if it is permitted to use cookies to track + * session IDs for this web application, otherwise + * <code>false</code> */ public boolean getCookies(); @@ -347,18 +356,25 @@ public interface Context extends Container { /** * Return the "allow crossing servlet contexts" flag. + * + * @return <code>true</code> if cross-contest requests are allowed from this + * web applications, otherwise <code>false</code> */ public boolean getCrossContext(); /** * Return the alternate Deployment Descriptor name. + * + * @return the name */ public String getAltDDName(); /** * Set an alternate Deployment Descriptor name. + * + * @param altDDName The new name */ public void setAltDDName(String altDDName) ; @@ -373,6 +389,8 @@ public interface Context extends Container { /** * Return the display name of this web application. + * + * @return The display name */ public String getDisplayName(); @@ -386,7 +404,9 @@ public interface Context extends Container { /** - * Return the distributable flag for this web application. + * Get the distributable flag for this web application. + * + * @return The value of the distributable flag for this web application. */ public boolean getDistributable(); @@ -419,13 +439,18 @@ public interface Context extends Container { /** - * Return the URL encoded context path, using UTF-8. + * Return the URL encoded context path + * + * @return The URL encoded (with UTF-8) context path */ public String getEncodedPath(); /** - * Return the boolean on the annotations parsing. + * Determine if annotations parsing is currently disabled + * + * @return {@code true} if annotation parsing is disabled for this web + * application */ public boolean getIgnoreAnnotations(); @@ -440,7 +465,7 @@ public interface Context extends Container { /** - * Return the login configuration descriptor for this web application. + * @return the login configuration descriptor for this web application. */ public LoginConfig getLoginConfig(); @@ -454,13 +479,13 @@ public interface Context extends Container { /** - * Get the request dispatcher mapper. + * @return the request dispatcher mapper. */ public Mapper getMapper(); /** - * Return the naming resources associated with this web application. + * @return the naming resources associated with this web application. */ public NamingResources getNamingResources(); @@ -474,7 +499,7 @@ public interface Context extends Container { /** - * Return the context path for this web application. + * @return the context path for this web application. */ public String getPath(); @@ -488,7 +513,7 @@ public interface Context extends Container { /** - * Return the public identifier of the deployment descriptor DTD that is + * @return the public identifier of the deployment descriptor DTD that is * currently being parsed. */ public String getPublicId(); @@ -504,7 +529,7 @@ public interface Context extends Container { /** - * Return the reloadable flag for this web application. + * @return the reloadable flag for this web application. */ public boolean getReloadable(); @@ -518,7 +543,7 @@ public interface Context extends Container { /** - * Return the override flag for this web application. + * @return the override flag for this web application. */ public boolean getOverride(); @@ -532,7 +557,7 @@ public interface Context extends Container { /** - * Return the privileged flag for this web application. + * @return the privileged flag for this web application. */ public boolean getPrivileged(); @@ -546,13 +571,13 @@ public interface Context extends Container { /** - * Return the servlet context for which this Context is a facade. + * @return the Servlet context for which this Context is a facade. */ public ServletContext getServletContext(); /** - * Return the default session timeout (in minutes) for this + * @return the default session timeout (in minutes) for this * web application. */ public int getSessionTimeout(); @@ -587,7 +612,7 @@ public interface Context extends Container { public void setSwallowAbortedUploads(boolean swallowAbortedUploads); /** - * Return the value of the swallowOutput flag. + * @return the value of the swallowOutput flag. */ public boolean getSwallowOutput(); @@ -603,7 +628,7 @@ public interface Context extends Container { /** - * Return the Java class name of the Wrapper implementation used + * @return the Java class name of the Wrapper implementation used * for servlets registered in this Context. */ public String getWrapperClass(); @@ -728,29 +753,37 @@ public interface Context extends Container { public void setJarScanner(JarScanner jarScanner); /** - * Obtain the {@link Authenticator} that is used by this context or - * <code>null</code> if none is used. + * @return the {@link Authenticator} that is used by this context. This is + * always non-{@code null} for a started Context */ public Authenticator getAuthenticator(); /** * Set whether or not the effective web.xml for this context should be * logged on context start. + * + * @param logEffectiveWebXml set to <code>true</code> to log the complete + * web.xml that will be used for the webapp */ public void setLogEffectiveWebXml(boolean logEffectiveWebXml); /** * Should the effective web.xml for this context be logged on context start? + * + * @return true if the reconstructed web.xml that will be used for the + * webapp should be logged */ public boolean getLogEffectiveWebXml(); /** - * Get the instance manager associated with this context. + * @return the instance manager associated with this context. */ public InstanceManager getInstanceManager(); /** * Set the instance manager associated with this context. + * + * @param instanceManager the new instance manager instance */ public void setInstanceManager(InstanceManager instanceManager); @@ -828,6 +861,8 @@ public interface Context extends Container { /** * Add a security constraint to the set for this web application. + * + * @param constraint The security constraint that should be added */ public void addConstraint(SecurityConstraint constraint); @@ -985,32 +1020,34 @@ public interface Context extends Container { * the Java implementation class appropriate for this Context * implementation. The constructor of the instantiated Wrapper * will have been called, but no properties will have been set. + * + * @return a newly created wrapper instance that is used to wrap a Servlet */ public Wrapper createWrapper(); /** - * Return the set of application listener class names configured + * @return the set of application listener class names configured * for this application. */ public String[] findApplicationListeners(); /** - * Return the set of application parameters for this application. + * @return the set of application parameters for this application. */ public ApplicationParameter[] findApplicationParameters(); /** - * Return the set of security constraints for this web application. + * @return the set of security constraints for this web application. * If there are none, a zero-length array is returned. */ public SecurityConstraint[] findConstraints(); /** - * Return the error page entry for the specified HTTP error code, + * @return the error page entry for the specified HTTP error code, * if any; otherwise return <code>null</code>. * * @param errorCode Error code to look up @@ -1019,24 +1056,24 @@ public interface Context extends Container { /** - * Return the error page entry for the specified Java exception type, - * if any; otherwise return <code>null</code>. - * * @param exceptionType Exception type to look up + * + * @return the error page entry for the specified Java exception type, + * if any; otherwise return {@code null}. */ public ErrorPage findErrorPage(String exceptionType); /** - * Return the set of defined error pages for all specified error codes + * @return the set of defined error pages for all specified error codes * and exception types. */ public ErrorPage[] findErrorPages(); /** - * Return the filter definition for the specified filter name, if any; + * @return the filter definition for the specified filter name, if any; * otherwise return <code>null</code>. * * @param filterName Filter name to look up @@ -1045,26 +1082,26 @@ public interface Context extends Container { /** - * Return the set of defined filters for this Context. + * @return the set of defined filters for this Context. */ public FilterDef[] findFilterDefs(); /** - * Return the set of filter mappings for this Context. + * @return the set of filter mappings for this Context. */ public FilterMap[] findFilterMaps(); /** - * Return the set of InstanceListener classes that will be added to + * @return the set of InstanceListener classes that will be added to * newly created Wrappers automatically. */ public String[] findInstanceListeners(); /** - * Return the MIME type to which the specified extension is mapped, + * @return the MIME type to which the specified extension is mapped, * if any; otherwise return <code>null</code>. * * @param extension Extension to map to a MIME type @@ -1073,14 +1110,14 @@ public interface Context extends Container { /** - * Return the extensions for which MIME mappings are defined. If there + * @return the extensions for which MIME mappings are defined. If there * are none, a zero-length array is returned. */ public String[] findMimeMappings(); /** - * Return the value for the specified context initialization + * @return the value for the specified context initialization * parameter name, if any; otherwise return <code>null</code>. * * @param name Name of the parameter to return @@ -1089,7 +1126,7 @@ public interface Context extends Container { /** - * Return the names of all defined context initialization parameters + * @return the names of all defined context initialization parameters * for this Context. If no parameters are defined, a zero-length * array is returned. */ @@ -1102,12 +1139,13 @@ public interface Context extends Container { * is one. Otherwise, return the specified role unchanged. * * @param role Security role to map + * @return The role name that was mapped to the specified role */ public String findRoleMapping(String role); /** - * Return <code>true</code> if the specified security role is defined + * @return <code>true</code> if the specified security role is defined * for this application; otherwise return <code>false</code>. * * @param role Security role to verify @@ -1116,14 +1154,14 @@ public interface Context extends Container { /** - * Return the security roles defined for this application. If none + * @return the security roles defined for this application. If none * have been defined, a zero-length array is returned. */ public String[] findSecurityRoles(); /** - * Return the servlet name mapped by the specified pattern (if any); + * @return the servlet name mapped by the specified pattern (if any); * otherwise return <code>null</code>. * * @param pattern Pattern for which a mapping is requested @@ -1132,14 +1170,14 @@ public interface Context extends Container { /** - * Return the patterns of all defined servlet mappings for this + * @return the patterns of all defined servlet mappings for this * Context. If no mappings are defined, a zero-length array is returned. */ public String[] findServletMappings(); /** - * Return the context-relative URI of the error page for the specified + * @return the context-relative URI of the error page for the specified * HTTP status code, if any; otherwise return <code>null</code>. * * @param status HTTP status code to look up @@ -1148,7 +1186,7 @@ public interface Context extends Container { /** - * Return the set of HTTP status codes for which error pages have + * @return the set of HTTP status codes for which error pages have * been specified. If none are specified, a zero-length array * is returned. */ @@ -1156,14 +1194,14 @@ public interface Context extends Container { /** - * Return the set of watched resources for this Context. If none are + * @return the set of watched resources for this Context. If none are * defined, a zero length array will be returned. */ public String[] findWatchedResources(); /** - * Return <code>true</code> if the specified welcome file is defined + * @return <code>true</code> if the specified welcome file is defined * for this Context; otherwise return <code>false</code>. * * @param name Welcome file to verify @@ -1172,21 +1210,21 @@ public interface Context extends Container { /** - * Return the set of welcome files defined for this Context. If none are + * @return the set of welcome files defined for this Context. If none are * defined, a zero-length array is returned. */ public String[] findWelcomeFiles(); /** - * Return the set of LifecycleListener classes that will be added to + * @return the set of LifecycleListener classes that will be added to * newly created Wrappers automatically. */ public String[] findWrapperLifecycles(); /** - * Return the set of ContainerListener classes that will be added to + * @return the set of ContainerListener classes that will be added to * newly created Wrappers automatically. */ public String[] findWrapperListeners(); @@ -1195,6 +1233,8 @@ public interface Context extends Container { /** * Notify all {@link javax.servlet.ServletRequestListener}s that a request * has started. + * + * @param request The request object that will be passed to the listener * @return <code>true</code> if the listeners fire successfully, else * <code>false</code> */ @@ -1203,6 +1243,8 @@ public interface Context extends Container { /** * Notify all {@link javax.servlet.ServletRequestListener}s that a request * has ended. + * + * @param request The request object that will be passed to the listener * @return <code>true</code> if the listeners fire successfully, else * <code>false</code> */ @@ -1358,7 +1400,7 @@ public interface Context extends Container { /** - * Return the real path for a given virtual path, if possible; otherwise + * @return the real path for a given virtual path, if possible; otherwise * return <code>null</code>. * * @param path The path to the desired resource @@ -1367,7 +1409,7 @@ public interface Context extends Container { /** - * Return the effective major version of the Servlet spec used by this + * @return the effective major version of the Servlet spec used by this * context. */ public int getEffectiveMajorVersion(); @@ -1376,12 +1418,14 @@ public interface Context extends Container { /** * Set the effective major version of the Servlet spec used by this * context. + * + * @param major Set the version number */ public void setEffectiveMajorVersion(int major); /** - * Return the effective minor version of the Servlet spec used by this + * @return the effective minor version of the Servlet spec used by this * context. */ public int getEffectiveMinorVersion(); @@ -1390,12 +1434,15 @@ public interface Context extends Container { /** * Set the effective minor version of the Servlet spec used by this * context. + * + * @param minor Set the version number */ public void setEffectiveMinorVersion(int minor); /** - * Obtain the JSP configuration for this context. + * @return the JSP configuration for this context. + * Will be null if there is no JSP configuration. */ public JspConfigDescriptor getJspConfigDescriptor(); @@ -1404,6 +1451,8 @@ public interface Context extends Container { * Add a URL for a JAR that contains static resources in a * META-INF/resources directory that should be included in the static * resources for this context. + * + * @param url URL of resource JAR */ public void addResourceJarUrl(URL url); @@ -1418,22 +1467,28 @@ public interface Context extends Container { public void addServletContainerInitializer( ServletContainerInitializer sci, Set<Class<?>> classes); + /** * Is this Context paused whilst it is reloaded? + * + * @return <code>true</code> if the context has been paused */ public boolean getPaused(); /** * Is this context using version 2.2 of the Servlet spec? + * + * @return <code>true</code> for a legacy Servlet 2.2 webapp */ boolean isServlet22(); + /** - * Notification that servlet security has been dynamically set in a + * Notification that Servlet security has been dynamically set in a * {@link javax.servlet.ServletRegistration.Dynamic} - * @param registration servlet security was modified for - * @param servletSecurityElement new security constraints for this servlet + * @param registration Servlet security was modified for + * @param servletSecurityElement new security constraints for this Servlet * @return urls currently mapped to this registration that are already * present in web.xml */ @@ -1444,6 +1499,8 @@ public interface Context extends Container { * Sets the (comma separated) list of Servlets that expect a resource to be * present. Used to ensure that welcome files associated with Servlets that * expect a resource to be present are not mapped when there is no resource. + * + * @param resourceOnlyServlets The Servlet names comma separated list */ public void setResourceOnlyServlets(String resourceOnlyServlets); @@ -1464,7 +1521,7 @@ public interface Context extends Container { public boolean isResourceOnlyServlet(String servletName); /** - * Return the base name to use for WARs, directories or context.xml files + * @return the base name to use for WARs, directories or context.xml files * for this context. */ public String getBaseName(); @@ -1473,11 +1530,14 @@ public interface Context extends Container { * Set the version of this web application - used to differentiate * different versions of the same web application when using parallel * deployment. + * + * @param webappVersion The webapp version associated with the context, + * which should be unique */ public void setWebappVersion(String webappVersion); /** - * Set the version of this web application - used to differentiate + * @return The version of this web application, used to differentiate * different versions of the same web application when using parallel * deployment. If not specified, defaults to the empty string. */ @@ -1486,11 +1546,13 @@ public interface Context extends Container { /** * Configure whether or not requests listeners will be fired on forwards for * this Context. + * + * @param enable <code>true</code> to fire request listeners when forwarding */ public void setFireRequestListenersOnForwards(boolean enable); /** - * Determine whether or not requests listeners will be fired on forwards for + * @return whether or not requests listeners will be fired on forwards for * this Context. */ public boolean getFireRequestListenersOnForwards(); @@ -1499,11 +1561,14 @@ public interface Context extends Container { * Configures if a user presents authentication credentials, whether the * context will process them when the request is for a non-protected * resource. + * + * @param enable <code>true</code> to perform authentication even outside + * security constraints */ public void setPreemptiveAuthentication(boolean enable); /** - * Determines if a user presents authentication credentials, will the + * @return if a user presents authentication credentials, will the * context will process them when the request is for a non-protected * resource. */ @@ -1512,11 +1577,13 @@ public interface Context extends Container { /** * Configures if a response body is included when a redirect response is * sent to the client. + * + * @param enable <code>true</code> to send a response body for redirects */ public void setSendRedirectBody(boolean enable); /** - * Determines if the context is configured to include a response body as + * @return if the context is configured to include a response body as * part of a redirect response. */ public boolean getSendRedirectBody(); diff --git a/java/org/apache/catalina/Engine.java b/java/org/apache/catalina/Engine.java index 9fe4096..66b4411 100644 --- a/java/org/apache/catalina/Engine.java +++ b/java/org/apache/catalina/Engine.java @@ -14,8 +14,6 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.catalina; /** @@ -44,12 +42,8 @@ package org.apache.catalina; */ public interface Engine extends Container { - - // ------------------------------------------------------------- Properties - - /** - * Return the default hostname for this Engine. + * @return the default host name for this Engine. */ public String getDefaultHost(); @@ -63,7 +57,7 @@ public interface Engine extends Container { /** - * Retrieve the JvmRouteId for this engine. + * @return the JvmRouteId for this engine. */ public String getJvmRoute(); @@ -78,7 +72,7 @@ public interface Engine extends Container { /** - * Return the <code>Service</code> with which we are associated (if any). + * @return the <code>Service</code> with which we are associated (if any). */ public Service getService(); @@ -89,6 +83,4 @@ public interface Engine extends Container { * @param service The service that owns this Engine */ public void setService(Service service); - - } diff --git a/java/org/apache/catalina/Group.java b/java/org/apache/catalina/Group.java index d5a935a..05ece8b 100644 --- a/java/org/apache/catalina/Group.java +++ b/java/org/apache/catalina/Group.java @@ -14,15 +14,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.catalina; - import java.security.Principal; import java.util.Iterator; - /** * <p>Abstract representation of a group of {@link User}s in a * {@link UserDatabase}. Each user that is a member of this group @@ -33,12 +29,10 @@ import java.util.Iterator; */ public interface Group extends Principal { - // ------------------------------------------------------------- Properties - /** - * Return the description of this group. + * @return the description of this group. */ public String getDescription(); @@ -52,7 +46,7 @@ public interface Group extends Principal { /** - * Return the group name of this group, which must be unique + * @return the group name of this group, which must be unique * within the scope of a {@link UserDatabase}. */ public String getGroupname(); @@ -68,26 +62,25 @@ public interface Group extends Principal { /** - * Return the set of {@link Role}s assigned specifically to this group. + * @return the set of {@link Role}s assigned specifically to this group. */ public Iterator<Role> getRoles(); /** - * Return the {@link UserDatabase} within which this Group is defined. + * @return the {@link UserDatabase} within which this Group is defined. */ public UserDatabase getUserDatabase(); /** - * Return the set of {@link User}s that are members of this group. + * @return the set of {@link User}s that are members of this group. */ public Iterator<User> getUsers(); // --------------------------------------------------------- Public Methods - /** * Add a new {@link Role} to those assigned specifically to this group. * @@ -100,6 +93,9 @@ public interface Group extends Principal { * Is this group specifically assigned the specified {@link Role}? * * @param role The role to check + * + * @return <code>true</code> if the group is assigned to the specified role + * otherwise <code>false</code> */ public boolean isInRole(Role role); diff --git a/java/org/apache/catalina/LifecycleEvent.java b/java/org/apache/catalina/LifecycleEvent.java index 7f434d0..c681586 100644 --- a/java/org/apache/catalina/LifecycleEvent.java +++ b/java/org/apache/catalina/LifecycleEvent.java @@ -14,19 +14,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.catalina; - import java.util.EventObject; - /** * General event for notifying listeners of significant changes on a component - * that implements the Lifecycle interface. In particular, this will be useful - * on Containers, where these events replace the ContextInterceptor concept in - * Tomcat 3.x. + * that implements the Lifecycle interface. * * @author Craig R. McClanahan */ @@ -35,8 +29,6 @@ public final class LifecycleEvent extends EventObject { private static final long serialVersionUID = 1L; - // ----------------------------------------------------------- Constructors - /** * Construct a new LifecycleEvent with the specified parameters. * @@ -45,59 +37,44 @@ public final class LifecycleEvent extends EventObject { * @param data Event data (if any) */ public LifecycleEvent(Lifecycle lifecycle, String type, Object data) { - super(lifecycle); this.type = type; this.data = data; } - // ----------------------------------------------------- Instance Variables - - /** * The event data associated with this event. */ - private Object data = null; + private final Object data; /** * The event type this instance represents. */ - private String type = null; - - - // ------------------------------------------------------------- Properties + private final String type; /** - * Return the event data of this event. + * @return the event data of this event. */ public Object getData() { - - return (this.data); - + return data; } /** - * Return the Lifecycle on which this event occurred. + * @return the Lifecycle on which this event occurred. */ public Lifecycle getLifecycle() { - return (Lifecycle) getSource(); - } /** - * Return the event type of this event. + * @return the event type of this event. */ public String getType() { - - return (this.type); - + return this.type; } - - } diff --git a/java/org/apache/catalina/LifecycleState.java b/java/org/apache/catalina/LifecycleState.java index 5c9ab4d..04309eb 100644 --- a/java/org/apache/catalina/LifecycleState.java +++ b/java/org/apache/catalina/LifecycleState.java @@ -14,7 +14,6 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - package org.apache.catalina; /** @@ -71,14 +70,14 @@ public enum LifecycleState { * <li>{@link #STOPPING_PREP}</li> * <li>{@link #MUST_STOP}</li> * </ul> + * + * @return <code>true</code> if the component is available for use, + * otherwise <code>false</code> */ public boolean isAvailable() { return available; } - /** - * - */ public String getLifecycleEvent() { return lifecycleEvent; } diff --git a/java/org/apache/catalina/Loader.java b/java/org/apache/catalina/Loader.java index e315c65..3089834 100644 --- a/java/org/apache/catalina/Loader.java +++ b/java/org/apache/catalina/Loader.java @@ -14,14 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.catalina; - import java.beans.PropertyChangeListener; - /** * A <b>Loader</b> represents a Java ClassLoader implementation that can * be used by a Container to load class files (within a repository associated @@ -51,13 +47,9 @@ import java.beans.PropertyChangeListener; * * @author Craig R. McClanahan */ - public interface Loader { - // ------------------------------------------------------------- Properties - - /** * Execute a periodic task, such as reloading, etc. This method will be * invoked inside the classloading context of this container. Unexpected @@ -67,13 +59,13 @@ public interface Loader { /** - * Return the Java class loader to be used by this Container. + * @return the Java class loader to be used by this Container. */ public ClassLoader getClassLoader(); /** - * Return the Container with which this Loader has been associated. + * @return the Container with which this Loader has been associated. */ public Container getContainer(); @@ -87,7 +79,7 @@ public interface Loader { /** - * Return the "follow standard delegation model" flag used to configure + * @return the "follow standard delegation model" flag used to configure * our ClassLoader. */ public boolean getDelegate(); @@ -103,7 +95,7 @@ public interface Loader { /** - * Return descriptive information about this Loader implementation and + * @return descriptive information about this Loader implementation and * the corresponding version number, in the format * <code><description>/<version></code>. */ @@ -111,7 +103,7 @@ public interface Loader { /** - * Return the reloadable flag for this Loader. + * @return the reloadable flag for this Loader. */ public boolean getReloadable(); @@ -124,9 +116,6 @@ public interface Loader { public void setReloadable(boolean reloadable); - // --------------------------------------------------------- Public Methods - - /** * Add a property change listener to this component. * @@ -144,7 +133,7 @@ public interface Loader { /** - * Return the set of repositories defined for this class loader. + * @return the set of repositories defined for this class loader. * If none are defined, a zero-length array is returned. */ public String[] findRepositories(); @@ -153,6 +142,9 @@ public interface Loader { /** * Has the internal repository associated with this Loader been modified, * such that the loaded classes should be reloaded? + * + * @return <code>true</code> when the repository has been modified, + * <code>false</code> otherwise */ public boolean modified(); @@ -163,6 +155,4 @@ public interface Loader { * @param listener The listener to remove */ public void removePropertyChangeListener(PropertyChangeListener listener); - - } diff --git a/java/org/apache/catalina/Store.java b/java/org/apache/catalina/Store.java index 47fbfe2..f81e214 100644 --- a/java/org/apache/catalina/Store.java +++ b/java/org/apache/catalina/Store.java @@ -34,12 +34,10 @@ import java.io.IOException; */ public interface Store { - // ------------------------------------------------------------- Properties - /** - * Return descriptive information about this Store implementation and + * @return descriptive information about this Store implementation and * the corresponding version number, in the format * <code><description>/<version></code>. */ @@ -47,7 +45,7 @@ public interface Store { /** - * Return the Manager instance associated with this Store. + * @return the Manager instance associated with this Store. */ public Manager getManager(); @@ -61,7 +59,7 @@ public interface Store { /** - * Return the number of Sessions present in this Store. + * @return the number of Sessions present in this Store. * * @exception IOException if an input/output error occurs */ @@ -80,7 +78,7 @@ public interface Store { /** - * Return an array containing the session identifiers of all Sessions + * @return an array containing the session identifiers of all Sessions * currently saved in this Store. If there are no such Sessions, a * zero-length array is returned. * @@ -98,6 +96,7 @@ public interface Store { * * @exception ClassNotFoundException if a deserialization error occurs * @exception IOException if an input/output error occurs + * @return the loaded Session instance */ public Session load(String id) throws ClassNotFoundException, IOException; @@ -117,6 +116,8 @@ public interface Store { /** * Remove all Sessions from this Store. + * + * @exception IOException if an input/output error occurs */ public void clear() throws IOException; diff --git a/java/org/apache/catalina/User.java b/java/org/apache/catalina/User.java index 67868e8..e50fd8f 100644 --- a/java/org/apache/catalina/User.java +++ b/java/org/apache/catalina/User.java @@ -39,7 +39,7 @@ public interface User extends Principal { /** - * Return the full name of this user. + * @return the full name of this user. */ public String getFullName(); @@ -53,13 +53,13 @@ public interface User extends Principal { /** - * Return the set of {@link Group}s to which this user belongs. + * @return the set of {@link Group}s to which this user belongs. */ public Iterator<Group> getGroups(); /** - * Return the logon password of this user, optionally prefixed with the + * @return the logon password of this user, optionally prefixed with the * identifier of an encoding scheme surrounded by curly braces, such as * <code>{md5}xxxxx</code>. */ @@ -77,19 +77,19 @@ public interface User extends Principal { /** - * Return the set of {@link Role}s assigned specifically to this user. + * @return the set of {@link Role}s assigned specifically to this user. */ public Iterator<Role> getRoles(); /** - * Return the {@link UserDatabase} within which this User is defined. + * @return the {@link UserDatabase} within which this User is defined. */ public UserDatabase getUserDatabase(); /** - * Return the logon username of this user, which must be unique + * @return the logon username of this user, which must be unique * within the scope of a {@link UserDatabase}. */ public String getUsername(); @@ -127,6 +127,7 @@ public interface User extends Principal { * Is this user in the specified {@link Group}? * * @param group The group to check + * @return <code>true</code> if the user is in the specified group */ public boolean isInGroup(Group group); @@ -137,6 +138,7 @@ public interface User extends Principal { * {@link Group} membership. * * @param role The role to check + * @return <code>true</code> if the user has the specified role */ public boolean isInRole(Role role); diff --git a/java/org/apache/catalina/UserDatabase.java b/java/org/apache/catalina/UserDatabase.java index 33f1b77..a76cfeb 100644 --- a/java/org/apache/catalina/UserDatabase.java +++ b/java/org/apache/catalina/UserDatabase.java @@ -14,56 +14,49 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - - package org.apache.catalina; - import java.util.Iterator; - /** - * <p>Abstract representation of a database of {@link User}s and - * {@link Group}s that can be maintained by an application, - * along with definitions of corresponding {@link Role}s, and - * referenced by a {@link Realm} for authentication and access control.</p> + * Abstract representation of a database of {@link User}s and {@link Group}s + * that can be maintained by an application, along with definitions of + * corresponding {@link Role}s, and referenced by a {@link Realm} for + * authentication and access control. * * @author Craig R. McClanahan * @since 4.1 */ public interface UserDatabase { - // ------------------------------------------------------------- Properties - /** - * Return the set of {@link Group}s defined in this user database. + * @return the set of {@link Group}s defined in this user database. */ public Iterator<Group> getGroups(); /** - * Return the unique global identifier of this user database. + * @return the unique global identifier of this user database. */ public String getId(); /** - * Return the set of {@link Role}s defined in this user database. + * @return the set of {@link Role}s defined in this user database. */ public Iterator<Role> getRoles(); /** - * Return the set of {@link User}s defined in this user database. + * @return the set of {@link User}s defined in this user database. */ public Iterator<User> getUsers(); // --------------------------------------------------------- Public Methods - /** * Finalize access to this user database. * @@ -77,6 +70,7 @@ public interface UserDatabase { * * @param groupname The group name of the new group (must be unique) * @param description The description of this group + * @return The new group */ public Group createGroup(String groupname, String description); @@ -86,6 +80,7 @@ public interface UserDatabase { * * @param rolename The role name of the new role (must be unique) * @param description The description of this role + * @return The new role */ public Role createRole(String rolename, String description); @@ -96,14 +91,14 @@ public interface UserDatabase { * @param username The logon username of the new user (must be unique) * @param password The logon password of the new user * @param fullName The full name of the new user + * @return The new user */ - public User createUser(String username, String password, - String fullName); + public User createUser(String username, String password, String fullName); /** - * Return the {@link Group} with the specified group name, if any; - * otherwise return <code>null</code>. + * @return the {@link Group} with the specified group name, if any; + * otherwise return <code>null</code>. * * @param groupname Name of the group to return */ @@ -111,8 +106,8 @@ public interface UserDatabase { /** - * Return the {@link Role} with the specified role name, if any; - * otherwise return <code>null</code>. + * @return the {@link Role} with the specified role name, if any; otherwise + * return <code>null</code>. * * @param rolename Name of the role to return */ @@ -120,8 +115,8 @@ public interface UserDatabase { /** - * Return the {@link User} with the specified user name, if any; - * otherwise return <code>null</code>. + * @return the {@link User} with the specified user name, if any; otherwise + * return <code>null</code>. * * @param username Name of the user to return */ @@ -161,8 +156,8 @@ public interface UserDatabase { /** - * Save any updated information to the persistent storage location for - * this user database. + * Save any updated information to the persistent storage location for this + * user database. * * @exception Exception if any exception is thrown during saving */ diff --git a/java/org/apache/catalina/Wrapper.java b/java/org/apache/catalina/Wrapper.java index e927776..fa2a946 100644 --- a/java/org/apache/catalina/Wrapper.java +++ b/java/org/apache/catalina/Wrapper.java @@ -62,7 +62,7 @@ public interface Wrapper extends Container { /** - * Return the available date/time for this servlet, in milliseconds since + * @return the available date/time for this servlet, in milliseconds since * the epoch. If this date/time is in the future, any request for this * servlet will return an SC_SERVICE_UNAVAILABLE error. If it is zero, * the servlet is currently available. A value equal to Long.MAX_VALUE @@ -83,7 +83,7 @@ public interface Wrapper extends Container { /** - * Return the load-on-startup order value (negative value means + * @return the load-on-startup order value (negative value means * load on first call). */ public int getLoadOnStartup(); @@ -99,7 +99,7 @@ public interface Wrapper extends Container { /** - * Return the run-as identity for this servlet. + * @return the run-as identity for this servlet. */ public String getRunAs(); @@ -113,7 +113,7 @@ public interface Wrapper extends Container { /** - * Return the fully qualified servlet class name for this servlet. + * @return the fully qualified servlet class name for this servlet. */ public String getServletClass(); @@ -134,25 +134,29 @@ public interface Wrapper extends Container { * servlet. * * @return Array of names of the methods supported by the underlying - * servlet + * servlet + * + * @throws ServletException If the target servlet cannot be loaded */ public String[] getServletMethods() throws ServletException; /** - * Is this servlet currently unavailable? + * @return <code>true</code> if this Servlet is currently unavailable. */ public boolean isUnavailable(); /** - * Return the associated servlet instance. + * @return the associated Servlet instance. */ public Servlet getServlet(); /** - * Set the associated servlet instance + * Set the associated Servlet instance + * + * @param servlet The associated Servlet */ public void setServlet(Servlet servlet); @@ -196,16 +200,17 @@ public interface Wrapper extends Container { /** * Allocate an initialized instance of this Servlet that is ready to have - * its <code>service()</code> method called. If the servlet class does + * its <code>service()</code> method called. If the Servlet class does * not implement <code>SingleThreadModel</code>, the (only) initialized - * instance may be returned immediately. If the servlet class implements + * instance may be returned immediately. If the Servlet class implements * <code>SingleThreadModel</code>, the Wrapper implementation must ensure * that this instance is not allocated again until it is deallocated by a * call to <code>deallocate()</code>. * - * @exception ServletException if the servlet init() method threw + * @exception ServletException if the Servlet init() method threw * an exception * @exception ServletException if a loading error occurs + * @return a new Servlet instance */ public Servlet allocate() throws ServletException; @@ -223,7 +228,7 @@ public interface Wrapper extends Container { /** - * Return the value for the specified initialization parameter name, + * @return the value for the specified initialization parameter name, * if any; otherwise return <code>null</code>. * * @param name Name of the requested initialization parameter @@ -232,20 +237,20 @@ public interface Wrapper extends Container { /** - * Return the names of all defined initialization parameters for this + * @return the names of all defined initialization parameters for this * servlet. */ public String[] findInitParameters(); /** - * Return the mappings associated with this wrapper. + * @return the mappings associated with this wrapper. */ public String[] findMappings(); /** - * Return the security role link for the specified security role + * @return the security role link for the specified security role * reference name, if any; otherwise return <code>null</code>. * * @param name Security role reference used within this servlet @@ -254,7 +259,7 @@ public interface Wrapper extends Container { /** - * Return the set of security role reference names associated with + * @return the set of security role reference names associated with * this servlet, if any; otherwise return a zero-length array. */ public String[] findSecurityReferences(); @@ -267,20 +272,19 @@ public interface Wrapper extends Container { /** - * Load and initialize an instance of this servlet, if there is not already + * Load and initialize an instance of this Servlet, if there is not already * at least one initialized instance. This can be used, for example, to - * load servlets that are marked in the deployment descriptor to be loaded + * load Servlets that are marked in the deployment descriptor to be loaded * at server startup time. * - * @exception ServletException if the servlet init() method threw - * an exception - * @exception ServletException if some other loading problem occurs + * @exception ServletException if the Servlet init() method threw + * an exception or if some other loading problem occurs */ public void load() throws ServletException; /** - * Remove the specified initialization parameter from this servlet. + * Remove the specified initialization parameter from this Servlet. * * @param name Name of the initialization parameter to remove */ @@ -312,11 +316,11 @@ public interface Wrapper extends Container { /** - * Process an UnavailableException, marking this servlet as unavailable + * Process an UnavailableException, marking this Servlet as unavailable * for the specified amount of time. * * @param unavailable The exception that occurred, or <code>null</code> - * to mark this servlet as permanently unavailable + * to mark this Servlet as permanently unavailable */ public void unavailable(UnavailableException unavailable); @@ -334,7 +338,7 @@ public interface Wrapper extends Container { /** - * Get the multi-part configuration for the associated servlet. If no + * @return the multi-part configuration for the associated Servlet. If no * multi-part configuration has been defined, then <code>null</code> will be * returned. */ @@ -342,8 +346,10 @@ public interface Wrapper extends Container { /** - * Set the multi-part configuration for the associated servlet. To clear the + * Set the multi-part configuration for the associated Servlet. To clear the * multi-part configuration specify <code>null</code> as the new value. + * + * @param multipartConfig The configuration associated with the Servlet */ public void setMultipartConfigElement( MultipartConfigElement multipartConfig); @@ -351,21 +357,29 @@ public interface Wrapper extends Container { /** * Does the associated Servlet support async processing? Defaults to * <code>false</code>. + * + * @return <code>true</code> if the Servlet supports async */ public boolean isAsyncSupported(); /** - * Set the async support for the associated servlet. + * Set the async support for the associated Servlet. + * + * @param asyncSupport the new value */ public void setAsyncSupported(boolean asyncSupport); /** * Is the associated Servlet enabled? Defaults to <code>true</code>. + * + * @return <code>true</code> if the Servlet is enabled */ public boolean isEnabled(); /** * Sets the enabled attribute for the associated servlet. + * + * @param enabled the new value */ public void setEnabled(boolean enabled); @@ -391,11 +405,15 @@ public interface Wrapper extends Container { /** * Is the Servlet overridable by a ServletContainerInitializer? + * + * @return <code>true</code> if the Servlet can be overridden in a ServletContainerInitializer */ public boolean isOverridable(); /** * Sets the overridable attribute for this Servlet. + * + * @param overridable the new value */ public void setOverridable(boolean overridable); } --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org