This is an automated email from the ASF dual-hosted git repository. remm pushed a commit to branch 9.0.x in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/9.0.x by this push: new 4d23ff3142 Remove redundant override javadoc 4d23ff3142 is described below commit 4d23ff314207f5d99c4bc8d74c1e5040f176308f Author: remm <r...@apache.org> AuthorDate: Fri Apr 26 15:09:15 2024 +0200 Remove redundant override javadoc --- java/org/apache/catalina/core/ContainerBase.java | 142 ----- java/org/apache/catalina/core/StandardContext.java | 572 ++------------------- java/org/apache/catalina/core/StandardEngine.java | 48 +- java/org/apache/catalina/core/StandardHost.java | 97 +--- .../org/apache/catalina/core/StandardPipeline.java | 64 --- java/org/apache/catalina/core/StandardServer.java | 93 +--- java/org/apache/catalina/core/StandardService.java | 65 +-- java/org/apache/catalina/core/StandardWrapper.java | 174 +------ .../apache/catalina/util/LifecycleMBeanBase.java | 26 - 9 files changed, 60 insertions(+), 1221 deletions(-) diff --git a/java/org/apache/catalina/core/ContainerBase.java b/java/org/apache/catalina/core/ContainerBase.java index 43201c19ed..7f26093591 100644 --- a/java/org/apache/catalina/core/ContainerBase.java +++ b/java/org/apache/catalina/core/ContainerBase.java @@ -280,32 +280,18 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Get the delay between the invocation of the backgroundProcess method on this container and its children. Child - * containers will not be invoked if their delay value is not negative (which would mean they are using their own - * thread). Setting this to a positive value will cause a thread to be spawn. After waiting the specified amount of - * time, the thread will invoke the executePeriodic method on this container and all its children. - */ @Override public int getBackgroundProcessorDelay() { return backgroundProcessorDelay; } - /** - * Set the delay between the invocation of the execute method on this container and its children. - * - * @param delay The delay in seconds between the invocation of backgroundProcess methods - */ @Override public void setBackgroundProcessorDelay(int delay) { backgroundProcessorDelay = delay; } - /** - * Return the Logger for this Container. - */ @Override public Log getLogger() { if (logger != null) { @@ -316,9 +302,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * @return the abbreviated name of this container for logging messages - */ @Override public String getLogName() { @@ -343,10 +326,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Return the Cluster with which this Container is associated. If there is no associated Cluster, return the Cluster - * associated with our parent Container (if any); otherwise return <code>null</code>. - */ @Override public Cluster getCluster() { Lock readLock = clusterLock.readLock(); @@ -381,11 +360,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Set the Cluster with which this Container is associated. - * - * @param cluster The newly associated Cluster - */ @Override public void setCluster(Cluster cluster) { @@ -429,25 +403,12 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Return a name string (suitable for use by humans) that describes this Container. Within the set of child - * containers belonging to a particular parent, Container names must be unique. - */ @Override public String getName() { return name; } - /** - * Set a name string (suitable for use by humans) that describes this Container. Within the set of child containers - * belonging to a particular parent, Container names must be unique. - * - * @param name New name of this container - * - * @exception IllegalStateException if this Container has already been added to the children of a parent Container - * (after which the name may not be changed) - */ @Override public void setName(String name) { if (name == null) { @@ -482,24 +443,12 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Return the Container for which this Container is a child, if there is one. If there is no defined parent, return - * <code>null</code>. - */ @Override public Container getParent() { return parent; } - /** - * Set the parent Container to which this Container is being added as a child. This Container may refuse to become - * attached to the specified Container by throwing an exception. - * - * @param container Container to which this Container is being added as a child - * - * @exception IllegalArgumentException if this Container refuses to become attached to the specified Container - */ @Override public void setParent(Container container) { @@ -510,10 +459,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Return the parent class loader (if any) for this web application. This call is meaningful only - * <strong>after</strong> a Loader has been configured. - */ @Override public ClassLoader getParentClassLoader() { if (parentClassLoader != null) { @@ -526,13 +471,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Set the parent class loader (if any) for this web application. This call is meaningful only - * <strong>before</strong> a Loader has been configured, and the specified value (if non-null) should be passed as - * an argument to the class loader constructor. - * - * @param parent The new parent class loader - */ @Override public void setParentClassLoader(ClassLoader parent) { ClassLoader oldParentClassLoader = this.parentClassLoader; @@ -542,19 +480,12 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Return the Pipeline object that manages the Valves associated with this Container. - */ @Override public Pipeline getPipeline() { return this.pipeline; } - /** - * Return the Realm with which this Container is associated. If there is no associated Realm, return the Realm - * associated with our parent Container (if any); otherwise return <code>null</code>. - */ @Override public Realm getRealm() { @@ -584,11 +515,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } } - /** - * Set the Realm with which this Container is associated. - * - * @param realm The newly associated Realm - */ @Override public void setRealm(Realm realm) { @@ -636,20 +562,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai // ------------------------------------------------------ Container Methods - /** - * Add a new child Container to those associated with this Container, if supported. Prior to adding this Container - * to the set of children, the child's <code>setParent()</code> method must be called, with this Container as an - * argument. This method may thrown an <code>IllegalArgumentException</code> if this Container chooses not to be - * attached to the specified Container, in which case it is not added - * - * @param child New child Container to be added - * - * @exception IllegalArgumentException if this exception is thrown by the <code>setParent()</code> method of the - * child Container - * @exception IllegalArgumentException if the new child does not have a name unique from that of existing children - * of this Container - * @exception IllegalStateException if this Container does not support child Containers - */ @Override public void addChild(Container child) { if (Globals.IS_SECURITY_ENABLED) { @@ -692,34 +604,18 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Add a container event listener to this component. - * - * @param listener The listener to add - */ @Override public void addContainerListener(ContainerListener listener) { listeners.add(listener); } - /** - * Add a property change listener to this component. - * - * @param listener The listener to add - */ @Override public void addPropertyChangeListener(PropertyChangeListener listener) { support.addPropertyChangeListener(listener); } - /** - * Return the child Container, associated with this Container, with the specified name (if any); otherwise, return - * <code>null</code> - * - * @param name Name of the child Container to be retrieved - */ @Override public Container findChild(String name) { if (name == null) { @@ -734,10 +630,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Return the set of children Containers associated with this Container. If this Container has no children, a - * zero-length array is returned. - */ @Override public Container[] findChildren() { childrenLock.readLock().lock(); @@ -749,21 +641,12 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Return the set of container listeners associated with this Container. If this Container has no registered - * container listeners, a zero-length array is returned. - */ @Override public ContainerListener[] findContainerListeners() { return listeners.toArray(new ContainerListener[0]); } - /** - * Remove an existing child Container from association with this parent Container. - * - * @param child Existing child Container to be removed - */ @Override public void removeChild(Container child) { @@ -806,22 +689,12 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Remove a container event listener from this component. - * - * @param listener The listener to remove - */ @Override public void removeContainerListener(ContainerListener listener) { listeners.remove(listener); } - /** - * Remove a property change listener from this component. - * - * @param listener The listener to remove - */ @Override public void removePropertyChangeListener(PropertyChangeListener listener) { @@ -1002,10 +875,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Check this container for an access log and if none is found, look to the parent. If there is no parent and still - * none is found, use the NoOp access log. - */ @Override public void logAccess(Request request, Response response, long time, boolean useDefault) { @@ -1069,10 +938,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai } - /** - * Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of - * this container. Unexpected throwables will be caught and logged. - */ @Override public synchronized void backgroundProcess() { @@ -1133,13 +998,6 @@ public abstract class ContainerBase extends LifecycleMBeanBase implements Contai // ------------------------------------------------------ Protected Methods - /** - * Notify all container event listeners that a particular event has occurred for this Container. The default - * implementation performs this notification synchronously using the calling thread. - * - * @param type Event type - * @param data Event data - */ @Override public void fireContainerEvent(String type, Object data) { diff --git a/java/org/apache/catalina/core/StandardContext.java b/java/org/apache/catalina/core/StandardContext.java index 6390c8ec48..46523229fd 100644 --- a/java/org/apache/catalina/core/StandardContext.java +++ b/java/org/apache/catalina/core/StandardContext.java @@ -1167,56 +1167,36 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set to <code>true</code> to allow requests mapped to servlets that do not explicitly declare @MultipartConfig or - * have <multipart-config> specified in web.xml to parse multipart/form-data requests. - * - * @param allowCasualMultipartParsing <code>true</code> to allow such casual parsing, <code>false</code> otherwise. - */ @Override public void setAllowCasualMultipartParsing(boolean allowCasualMultipartParsing) { this.allowCasualMultipartParsing = allowCasualMultipartParsing; } /** - * Returns <code>true</code> if requests mapped to servlets without "multipart config" to parse multipart/form-data - * requests anyway. - * - * @return <code>true</code> if requests mapped to servlets without "multipart config" to parse multipart/form-data - * requests, <code>false</code> otherwise. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. */ @Override public boolean getAllowCasualMultipartParsing() { return this.allowCasualMultipartParsing; } - /** - * Set to <code>false</code> to disable request data swallowing after an upload was aborted due to size constraints. - * - * @param swallowAbortedUploads <code>false</code> to disable swallowing, <code>true</code> otherwise (default). - */ @Override public void setSwallowAbortedUploads(boolean swallowAbortedUploads) { this.swallowAbortedUploads = swallowAbortedUploads; } /** - * Returns <code>true</code> if remaining request data will be read (swallowed) even the request violates a data - * size constraint. - * - * @return <code>true</code> if data will be swallowed (default), <code>false</code> otherwise. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. */ @Override public boolean getSwallowAbortedUploads() { return this.swallowAbortedUploads; } - /** - * Add a ServletContainerInitializer instance to this web application. - * - * @param sci The instance to add - * @param classes The classes in which the initializer expressed an interest - */ @Override public void addServletContainerInitializer(ServletContainerInitializer sci, Set<Class<?>> classes) { initializers.put(sci, classes); @@ -1300,12 +1280,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Store the set of initialized application lifecycle listener objects, in the order they were specified in the web - * application deployment descriptor, for this application. - * - * @param listeners The set of instantiated listener objects. - */ @Override public void setApplicationLifecycleListeners(Object listeners[]) { applicationLifecycleListenersObjects = listeners; @@ -1443,12 +1417,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the "correctly configured" flag for this Context. This can be set to false by startup listeners that detect a - * fatal configuration error to avoid the application from being made available. - * - * @param configured The new correctly configured flag - */ @Override public void setConfigured(boolean configured) { @@ -1465,11 +1433,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the "use cookies for session ids" flag. - * - * @param cookies The new flag - */ @Override public void setCookies(boolean cookies) { @@ -1480,22 +1443,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Gets the name to use for session cookies. Overrides any setting that may be specified by the application. - * - * @return The value of the default session cookie name or null if not specified - */ @Override public String getSessionCookieName() { return sessionCookieName; } - /** - * Sets the name to use for session cookies. Overrides any setting that may be specified by the application. - * - * @param sessionCookieName The name to use - */ @Override public void setSessionCookieName(String sessionCookieName) { String oldSessionCookieName = this.sessionCookieName; @@ -1505,9 +1458,9 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * Gets the value of the use HttpOnly cookies for session cookies flag. - * - * @return <code>true</code> if the HttpOnly flag should be set on session cookies + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code true}. */ @Override public boolean getUseHttpOnly() { @@ -1515,11 +1468,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Sets the use HttpOnly cookies for session cookies flag. - * - * @param useHttpOnly Set to <code>true</code> to use HttpOnly cookies for session cookies - */ @Override public void setUseHttpOnly(boolean useHttpOnly) { boolean oldUseHttpOnly = this.useHttpOnly; @@ -1528,22 +1476,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Gets the domain to use for session cookies. Overrides any setting that may be specified by the application. - * - * @return The value of the default session cookie domain or null if not specified - */ @Override public String getSessionCookieDomain() { return sessionCookieDomain; } - /** - * Sets the domain to use for session cookies. Overrides any setting that may be specified by the application. - * - * @param sessionCookieDomain The domain to use - */ @Override public void setSessionCookieDomain(String sessionCookieDomain) { String oldSessionCookieDomain = this.sessionCookieDomain; @@ -1552,22 +1490,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Gets the path to use for session cookies. Overrides any setting that may be specified by the application. - * - * @return The value of the default session cookie path or null if not specified - */ @Override public String getSessionCookiePath() { return sessionCookiePath; } - /** - * Sets the path to use for session cookies. Overrides any setting that may be specified by the application. - * - * @param sessionCookiePath The path to use - */ @Override public void setSessionCookiePath(String sessionCookiePath) { String oldSessionCookiePath = this.sessionCookiePath; @@ -1588,17 +1516,17 @@ public class StandardContext extends ContainerBase implements Context, Notificat } + /** + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. + */ @Override public boolean getCrossContext() { return this.crossContext; } - /** - * Set the "allow crossing servlet contexts" flag. - * - * @param crossContext The new cross contexts flag - */ @Override public void setCrossContext(boolean crossContext) { @@ -1670,29 +1598,18 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the display name of this web application. - */ @Override public String getDisplayName() { return this.displayName; } - /** - * @return the alternate Deployment Descriptor name. - */ @Override public String getAltDDName() { return altDDName; } - /** - * Set an alternate Deployment Descriptor name. - * - * @param altDDName The new name - */ @Override public void setAltDDName(String altDDName) { this.altDDName = altDDName; @@ -1702,11 +1619,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the display name of this web application. - * - * @param displayName The new display name - */ @Override public void setDisplayName(String displayName) { @@ -1717,18 +1629,15 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * @return the distributable flag for this web application. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. */ @Override public boolean getDistributable() { return this.distributable; } - /** - * Set the distributable flag for this web application. - * - * @param distributable The new distributable flag - */ @Override public void setDistributable(boolean distributable) { boolean oldDistributable = this.distributable; @@ -1877,7 +1786,9 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * @return the boolean on the annotations parsing. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. */ @Override public boolean getIgnoreAnnotations() { @@ -1885,11 +1796,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the boolean on the annotations parsing for this web application. - * - * @param ignoreAnnotations The boolean on the annotations parsing - */ @Override public void setIgnoreAnnotations(boolean ignoreAnnotations) { boolean oldIgnoreAnnotations = this.ignoreAnnotations; @@ -1898,20 +1804,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the login configuration descriptor for this web application. - */ @Override public LoginConfig getLoginConfig() { return this.loginConfig; } - /** - * Set the login configuration descriptor for this web application. - * - * @param config The new login configuration - */ @Override public void setLoginConfig(LoginConfig config) { @@ -1950,9 +1848,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the naming resources associated with this web application. - */ @Override public NamingResourcesImpl getNamingResources() { if (namingResources == null) { @@ -1962,11 +1857,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the naming resources for this web application. - * - * @param namingResources The new naming resources - */ @Override public void setNamingResources(NamingResourcesImpl namingResources) { @@ -2012,20 +1902,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the context path for this Context. - */ @Override public String getPath() { return path; } - /** - * Set the context path for this Context. - * - * @param path The new context path - */ @Override public void setPath(String path) { boolean invalid = false; @@ -2052,20 +1934,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the public identifier of the deployment descriptor DTD that is currently being parsed. - */ @Override public String getPublicId() { return this.publicId; } - /** - * Set the public identifier of the deployment descriptor DTD that is currently being parsed. - * - * @param publicId The public identifier - */ @Override public void setPublicId(String publicId) { @@ -2081,7 +1955,9 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * @return the reloadable flag for this web application. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. */ @Override public boolean getReloadable() { @@ -2090,7 +1966,9 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * @return the default context override flag for this web application. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. */ @Override public boolean getOverride() { @@ -2117,10 +1995,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the parent class loader (if any) for this web application. This call is meaningful only - * <strong>after</strong> a Loader has been configured. - */ @Override public ClassLoader getParentClassLoader() { if (parentClassLoader != null) { @@ -2136,7 +2010,9 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * @return the privileged flag for this web application. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. */ @Override public boolean getPrivileged() { @@ -2144,11 +2020,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the privileged flag for this web application. - * - * @param privileged The new privileged flag - */ @Override public void setPrivileged(boolean privileged) { @@ -2159,11 +2030,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the reloadable flag for this web application. - * - * @param reloadable The new reloadable flag - */ @Override public void setReloadable(boolean reloadable) { @@ -2174,11 +2040,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the default context override flag for this web application. - * - * @param override The new override flag - */ @Override public void setOverride(boolean override) { @@ -2203,9 +2064,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the servlet context for which this Context is a facade. - */ @Override public ServletContext getServletContext() { /* @@ -2223,7 +2081,9 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * @return the default session timeout (in minutes) for this web application. + * {@inheritDoc} + * <p> + * The default value for this implementation is 30 minutes. */ @Override public int getSessionTimeout() { @@ -2231,11 +2091,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the default session timeout (in minutes) for this web application. - * - * @param timeout The new default session timeout - */ @Override public void setSessionTimeout(int timeout) { @@ -2251,7 +2106,9 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * @return the value of the swallowOutput flag. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code false}. */ @Override public boolean getSwallowOutput() { @@ -2259,12 +2116,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Set the value of the swallowOutput flag. If set to true, the system.out and system.err will be redirected to the - * logger during a servlet execution. - * - * @param swallowOutput The new value - */ @Override public void setSwallowOutput(boolean swallowOutput) { @@ -2339,23 +2190,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the Java class name of the Wrapper implementation used for servlets registered in this Context. - */ @Override public String getWrapperClass() { return this.wrapperClassName; } - /** - * Set the Java class name of the Wrapper implementation used for servlets registered in this Context. - * - * @param wrapperClassName The new wrapper class name - * - * @throws IllegalArgumentException if the specified wrapper class cannot be found or is not a subclass of - * StandardWrapper - */ @Override public void setWrapperClass(String wrapperClassName) { @@ -2674,11 +2514,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat // -------------------------------------------------------- Context Methods - /** - * Add a new Listener class name to the set of Listeners configured for this application. - * - * @param listener Java class name of a listener class - */ @Override public void addApplicationListener(String listener) { if (applicationListeners.addIfAbsent(listener)) { @@ -2689,11 +2524,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a new application parameter for this application. - * - * @param parameter The new application parameter - */ @Override public void addApplicationParameter(ApplicationParameter parameter) { @@ -2713,13 +2543,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a child Container, only if the proposed child is an implementation of Wrapper. - * - * @param child Child container to be added - * - * @exception IllegalArgumentException if the proposed container is not an implementation of Wrapper - */ @Override public void addChild(Container child) { @@ -2755,11 +2578,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a security constraint to the set for this web application. - * - * @param constraint the new security constraint - */ @Override public void addConstraint(SecurityConstraint constraint) { @@ -2789,11 +2607,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add an error page for the specified error or Java exception. - * - * @param errorPage The error page definition to be added - */ @Override public void addErrorPage(ErrorPage errorPage) { // Validate the input parameters @@ -2817,11 +2630,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a filter definition to this Context. - * - * @param filterDef The filter definition to be added - */ @Override public void addFilterDef(FilterDef filterDef) { @@ -2833,14 +2641,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a filter mapping to this Context at the end of the current set of filter mappings. - * - * @param filterMap The filter mapping to be added - * - * @exception IllegalArgumentException if the specified filter name does not match an existing filter definition, or - * the filter mapping is malformed - */ @Override public void addFilterMap(FilterMap filterMap) { validateFilterMap(filterMap); @@ -2850,15 +2650,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a filter mapping to this Context before the mappings defined in the deployment descriptor but after any other - * mappings added via this method. - * - * @param filterMap The filter mapping to be added - * - * @exception IllegalArgumentException if the specified filter name does not match an existing filter definition, or - * the filter mapping is malformed - */ @Override public void addFilterMapBefore(FilterMap filterMap) { validateFilterMap(filterMap); @@ -2894,12 +2685,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4) - * - * @param locale locale to map an encoding for - * @param encoding encoding to be used for a give locale - */ @Override public void addLocaleEncodingMappingParameter(String locale, String encoding) { getCharsetMapper().addCharsetMappingFromDeploymentDescriptor(locale, encoding); @@ -2934,12 +2719,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a new MIME mapping, replacing any existing mapping for the specified extension. - * - * @param extension Filename extension being mapped - * @param mimeType Corresponding MIME type - */ @Override public void addMimeMapping(String extension, String mimeType) { @@ -2951,15 +2730,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a new context initialization parameter. - * - * @param name Name of the new parameter - * @param value Value of the new parameter - * - * @exception IllegalArgumentException if the name or value is missing, or if this context initialization parameter - * has already been registered - */ @Override public void addParameter(String name, String value) { // Validate the proposed context initialization parameter @@ -2978,12 +2748,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a security role reference for this web application. - * - * @param role Security role used in the application - * @param link Actual security role to check for - */ @Override public void addRoleMapping(String role, String link) { @@ -2995,11 +2759,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a new security role for this web application. - * - * @param role New security role - */ @Override public void addSecurityRole(String role) { @@ -3013,15 +2772,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a new servlet mapping, replacing any existing mapping for the specified pattern. - * - * @param pattern URL pattern to be mapped - * @param name Name of the corresponding servlet to execute - * @param jspWildCard true if name identifies the JspServlet and pattern contains a wildcard; false otherwise - * - * @exception IllegalArgumentException if the specified servlet name is not known to this Context - */ @Override public void addServletMappingDecoded(String pattern, String name, boolean jspWildCard) { // Validate the proposed mapping @@ -3050,11 +2800,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a new watched resource to the set recognized by this Context. - * - * @param name New watched resource file name - */ @Override public void addWatchedResource(String name) { @@ -3067,11 +2812,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a new welcome file to the set recognized by this Context. - * - * @param name New welcome file name - */ @Override public void addWelcomeFile(String name) { @@ -3093,11 +2833,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context. - * - * @param listener Java class name of a LifecycleListener class - */ @Override public void addWrapperLifecycle(String listener) { @@ -3111,11 +2846,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add the classname of a ContainerListener to be added to each Wrapper appended to this Context. - * - * @param listener Java class name of a ContainerListener class - */ @Override public void addWrapperListener(String listener) { @@ -3129,11 +2859,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Factory method to create and return a new Wrapper instance, of 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. - */ @Override public Wrapper createWrapper() { @@ -3182,18 +2907,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Return the set of application listener class names configured for this application. - */ @Override public String[] findApplicationListeners() { return applicationListeners.toArray(new String[0]); } - /** - * Return the set of application parameters for this application. - */ @Override public ApplicationParameter[] findApplicationParameters() { @@ -3204,20 +2923,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Return the security constraints for this web application. If there are none, a zero-length array is returned. - */ @Override public SecurityConstraint[] findConstraints() { return constraints; } - /** - * 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 - */ @Override public ErrorPage findErrorPage(int errorCode) { return errorPageSupport.find(errorCode); @@ -3237,20 +2948,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Return the set of defined error pages for all specified error codes and exception types. - */ @Override public ErrorPage[] findErrorPages() { return errorPageSupport.findAll(); } - /** - * Return the filter definition for the specified filter name, if any; otherwise return <code>null</code>. - * - * @param filterName Filter name to look up - */ @Override public FilterDef findFilterDef(String filterName) { synchronized (filterDefs) { @@ -3259,9 +2962,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the set of defined filters for this Context. - */ @Override public FilterDef[] findFilterDefs() { synchronized (filterDefs) { @@ -3270,9 +2970,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the set of filter mappings for this Context. - */ @Override public FilterMap[] findFilterMaps() { return filterMaps.asArray(); @@ -3327,20 +3024,12 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @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 - */ @Override public String findMimeMapping(String extension) { return mimeMappings.get(extension.toLowerCase(Locale.ENGLISH)); } - /** - * @return the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned. - */ @Override public String[] findMimeMappings() { synchronized (mimeMappings) { @@ -3349,36 +3038,18 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @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 - */ @Override public String findParameter(String name) { return parameters.get(name); } - /** - * @return the names of all defined context initialization parameters for this Context. If no parameters are - * defined, a zero-length array is returned. - */ @Override public String[] findParameters() { return parameters.keySet().toArray(new String[0]); } - /** - * For the given security role (as used by an application), return the corresponding role name (as defined by the - * underlying Realm) if there is one. Otherwise, return the specified role unchanged. - * - * @param role Security role to map - * - * @return the role name - */ @Override public String findRoleMapping(String role) { String realRole = null; @@ -3393,12 +3064,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @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 - */ @Override public boolean findSecurityRole(String role) { @@ -3414,10 +3079,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the security roles defined for this application. If none have been defined, a zero-length array is - * returned. - */ @Override public String[] findSecurityRoles() { synchronized (securityRolesLock) { @@ -3426,11 +3087,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @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 - */ @Override public String findServletMapping(String pattern) { synchronized (servletMappingsLock) { @@ -3439,10 +3095,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length - * array is returned. - */ @Override public String[] findServletMappings() { synchronized (servletMappingsLock) { @@ -3481,12 +3133,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @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 - */ @Override public boolean findWelcomeFile(String name) { @@ -3502,9 +3148,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the set of watched resources for this Context. If none are defined, a zero length array will be returned. - */ @Override public String[] findWatchedResources() { synchronized (watchedResourcesLock) { @@ -3513,9 +3156,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the set of welcome files defined for this Context. If none are defined, a zero-length array is returned. - */ @Override public String[] findWelcomeFiles() { synchronized (welcomeFilesLock) { @@ -3524,9 +3164,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the set of LifecycleListener classes that will be added to newly created Wrappers automatically. - */ @Override public String[] findWrapperLifecycles() { synchronized (wrapperLifecyclesLock) { @@ -3535,9 +3172,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the set of ContainerListener classes that will be added to newly created Wrappers automatically. - */ @Override public String[] findWrapperListeners() { synchronized (wrapperListenersLock) { @@ -3547,15 +3181,13 @@ public class StandardContext extends ContainerBase implements Context, Notificat /** - * Reload this web application, if reloading is supported. + * {@inheritDoc} * <p> * <b>IMPLEMENTATION NOTE</b>: This method is designed to deal with reloads required by changes to classes in the * underlying repositories of our class loader and changes to the web.xml file. It does not handle changes to any * context.xml file. If the context.xml has changed, you should stop this Context and create (and start) a new * Context instance instead. Note that there is additional code in <code>CoyoteAdapter#postParseRequest()</code> to * handle mapping requests to paused Contexts. - * - * @exception IllegalStateException if the <code>reloadable</code> property is set to <code>false</code>. */ @Override public synchronized void reload() { @@ -3593,11 +3225,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the specified application listener class from the set of listeners for this application. - * - * @param listener Java class name of the listener to be removed - */ @Override public void removeApplicationListener(String listener) { if (applicationListeners.remove(listener)) { @@ -3607,11 +3234,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the application parameter with the specified name from the set for this application. - * - * @param name Name of the application parameter to remove - */ @Override public void removeApplicationParameter(String name) { @@ -3647,13 +3269,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a child Container, only if the proposed child is an implementation of Wrapper. - * - * @param child Child container to be added - * - * @exception IllegalArgumentException if the proposed container is not an implementation of Wrapper - */ @Override public void removeChild(Container child) { @@ -3666,11 +3281,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the specified security constraint from this web application. - * - * @param constraint Constraint to be removed - */ @Override public void removeConstraint(SecurityConstraint constraint) { @@ -3706,12 +3316,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action - * is taken. - * - * @param errorPage The error page definition to be removed - */ @Override public void removeErrorPage(ErrorPage errorPage) { errorPageSupport.remove(errorPage); @@ -3719,11 +3323,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken. - * - * @param filterDef Filter definition to be removed - */ @Override public void removeFilterDef(FilterDef filterDef) { @@ -3735,11 +3334,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove a filter mapping from this Context. - * - * @param filterMap The filter mapping to be removed - */ @Override public void removeFilterMap(FilterMap filterMap) { filterMaps.remove(filterMap); @@ -3776,11 +3370,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken. - * - * @param extension Extension to remove the mapping for - */ @Override public void removeMimeMapping(String extension) { @@ -3792,11 +3381,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken. - * - * @param name Name of the parameter to remove - */ @Override public void removeParameter(String name) { parameters.remove(name); @@ -3804,11 +3388,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove any security role reference for the specified name - * - * @param role Security role (as used in the application) to remove - */ @Override public void removeRoleMapping(String role) { @@ -3820,11 +3399,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove any security role with the specified name. - * - * @param role Security role to remove - */ @Override public void removeSecurityRole(String role) { @@ -3860,11 +3434,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken. - * - * @param pattern URL pattern of the mapping to remove - */ @Override public void removeServletMapping(String pattern) { @@ -3880,11 +3449,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the specified watched resource name from the list associated with this Context. - * - * @param name Name of the watched resource to be removed - */ @Override public void removeWatchedResource(String name) { @@ -3919,11 +3483,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove the specified welcome file name from the list recognized by this Context. - * - * @param name Name of the welcome file to be removed - */ @Override public void removeWelcomeFile(String name) { @@ -3961,11 +3520,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers. - * - * @param listener Class name of a LifecycleListener class to be removed - */ @Override public void removeWrapperLifecycle(String listener) { @@ -4002,11 +3556,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers. - * - * @param listener Class name of a ContainerListener class to be removed - */ @Override public void removeWrapperListener(String listener) { @@ -4147,11 +3696,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Return the real path for a given virtual path, if possible; otherwise return <code>null</code>. - * - * @param path The path to the desired resource - */ @Override public String getRealPath(String path) { // The WebResources API expects all paths to start with /. This is a @@ -4655,13 +4199,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Start this component and implement the requirements of - * {@link org.apache.catalina.util.LifecycleBase#startInternal()}. - * - * @exception LifecycleException if this component detects a fatal error that prevents this component from being - * used - */ @Override protected void startInternal() throws LifecycleException { @@ -5083,13 +4620,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Stop this component and implement the requirements of - * {@link org.apache.catalina.util.LifecycleBase#stopInternal()}. - * - * @exception LifecycleException if this component detects a fatal error that prevents this component from being - * used - */ @Override protected void stopInternal() throws LifecycleException { @@ -5367,11 +4897,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Are we processing a version 2.2 deployment descriptor? - * - * @return <code>true</code> if running a legacy Servlet 2.2 application - */ @Override public boolean isServlet22() { return XmlIdentifiers.WEB_22_PUBLIC.equals(publicId); @@ -5604,9 +5129,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * @return the request processing paused flag for this Context. - */ @Override public boolean getPaused() { return this.paused; @@ -5934,12 +5456,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove a JMX notificationListener - * - * @see javax.management.NotificationEmitter#removeNotificationListener(javax.management.NotificationListener, - * javax.management.NotificationFilter, java.lang.Object) - */ @Override public void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws ListenerNotFoundException { @@ -5948,11 +5464,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat private MBeanNotificationInfo[] notificationInfo; - /** - * Get JMX Broadcaster Info - * - * @see javax.management.NotificationBroadcaster#getNotificationInfo() - */ @Override public MBeanNotificationInfo[] getNotificationInfo() { if (notificationInfo == null) { @@ -5977,12 +5488,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Add a JMX NotificationListener - * - * @see javax.management.NotificationBroadcaster#addNotificationListener(javax.management.NotificationListener, - * javax.management.NotificationFilter, java.lang.Object) - */ @Override public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws IllegalArgumentException { @@ -5990,11 +5495,6 @@ public class StandardContext extends ContainerBase implements Context, Notificat } - /** - * Remove a JMX-NotificationListener - * - * @see javax.management.NotificationBroadcaster#removeNotificationListener(javax.management.NotificationListener) - */ @Override public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException { broadcaster.removeNotificationListener(listener); diff --git a/java/org/apache/catalina/core/StandardEngine.java b/java/org/apache/catalina/core/StandardEngine.java index 020bfa0a20..2089c4e507 100644 --- a/java/org/apache/catalina/core/StandardEngine.java +++ b/java/org/apache/catalina/core/StandardEngine.java @@ -98,11 +98,6 @@ public class StandardEngine extends ContainerBase implements Engine { // ------------------------------------------------------------- Properties - /** - * Obtain the configured Realm and provide a default Realm implementation when no explicit configuration is set. - * - * @return configured realm, or a {@link NullRealm} by default - */ @Override public Realm getRealm() { Realm configured = super.getRealm(); @@ -116,20 +111,12 @@ public class StandardEngine extends ContainerBase implements Engine { } - /** - * Return the default host. - */ @Override public String getDefaultHost() { return defaultHost; } - /** - * Set the default host. - * - * @param host The new default host - */ @Override public void setDefaultHost(String host) { @@ -147,41 +134,24 @@ public class StandardEngine extends ContainerBase implements Engine { } - /** - * Set the cluster-wide unique identifier for this Engine. This value is only useful in a load-balancing scenario. - * <p> - * This property should not be changed once it is set. - */ @Override public void setJvmRoute(String routeId) { jvmRouteId = routeId; } - /** - * Retrieve the cluster-wide unique identifier for this Engine. This value is only useful in a load-balancing - * scenario. - */ @Override public String getJvmRoute() { return jvmRouteId; } - /** - * Return the <code>Service</code> with which we are associated (if any). - */ @Override public Service getService() { return this.service; } - /** - * Set the <code>Service</code> with which we are associated (if any). - * - * @param service The service that owns this Engine - */ @Override public void setService(Service service) { this.service = service; @@ -191,9 +161,9 @@ public class StandardEngine extends ContainerBase implements Engine { /** - * Add a child Container, only if the proposed child is an implementation of Host. - * - * @param child Child container to be added + * {@inheritDoc} + * <p> + * The child must be an implementation of <code>Host</code>. */ @Override public void addChild(Container child) { @@ -229,13 +199,6 @@ public class StandardEngine extends ContainerBase implements Engine { } - /** - * Start this component and implement the requirements of - * {@link org.apache.catalina.util.LifecycleBase#startInternal()}. - * - * @exception LifecycleException if this component detects a fatal error that prevents this component from being - * used - */ @Override protected void startInternal() throws LifecycleException { @@ -250,6 +213,8 @@ public class StandardEngine extends ContainerBase implements Engine { /** + * {@inheritDoc} + * <p> * Override the default implementation. If no access log is defined for the Engine, look for one in the Engine's * default host and then the default host's ROOT context. If still none is found, return the default NoOp access * log. @@ -308,9 +273,6 @@ public class StandardEngine extends ContainerBase implements Engine { } - /** - * Return the parent class loader for this component. - */ @Override public ClassLoader getParentClassLoader() { if (parentClassLoader != null) { diff --git a/java/org/apache/catalina/core/StandardHost.java b/java/org/apache/catalina/core/StandardHost.java index 19a05778b1..8a56d61dd0 100644 --- a/java/org/apache/catalina/core/StandardHost.java +++ b/java/org/apache/catalina/core/StandardHost.java @@ -241,18 +241,12 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * ({@inheritDoc} - */ @Override public String getXmlBase() { return this.xmlBase; } - /** - * ({@inheritDoc} - */ @Override public void setXmlBase(String xmlBase) { String oldXmlBase = this.xmlBase; @@ -261,9 +255,6 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * ({@inheritDoc} - */ @Override public File getConfigBaseFile() { if (hostConfigBase != null) { @@ -297,27 +288,24 @@ public class StandardHost extends ContainerBase implements Host { /** - * @return <code>true</code> if the Host will attempt to create directories for appBase and xmlBase unless they - * already exist. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code true}. */ @Override public boolean getCreateDirs() { return createDirs; } - /** - * Set to <code>true</code> if the Host should attempt to create directories for xmlBase and appBase upon startup - * - * @param createDirs the new flag value - */ @Override public void setCreateDirs(boolean createDirs) { this.createDirs = createDirs; } /** - * @return the value of the auto deploy flag. If true, it indicates that this host's child webapps will be - * dynamically deployed. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code true}. */ @Override public boolean getAutoDeploy() { @@ -325,11 +313,6 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * Set the auto deploy flag value for this host. - * - * @param autoDeploy The new auto deploy flag - */ @Override public void setAutoDeploy(boolean autoDeploy) { @@ -340,20 +323,12 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * @return the Java class name of the context configuration class for new web applications. - */ @Override public String getConfigClass() { return this.configClass; } - /** - * Set the Java class name of the context configuration class for new web applications. - * - * @param configClass The new context configuration class - */ @Override public void setConfigClass(String configClass) { @@ -387,8 +362,9 @@ public class StandardHost extends ContainerBase implements Host { /** - * @return the value of the deploy on startup flag. If <code>true</code>, it indicates that this host's child - * webapps should be discovered and automatically deployed at startup time. + * {@inheritDoc} + * <p> + * The default value for this implementation is {@code true}. */ @Override public boolean getDeployOnStartup() { @@ -396,11 +372,6 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * Set the deploy on startup flag value for this host. - * - * @param deployOnStartup The new deploy on startup flag - */ @Override public void setDeployOnStartup(boolean deployOnStartup) { @@ -469,22 +440,12 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * @return the canonical, fully qualified, name of the virtual host this Container represents. - */ @Override public String getName() { return name; } - /** - * Set the canonical, fully qualified, name of the virtual host this Container represents. - * - * @param name Virtual host name - * - * @exception IllegalArgumentException if name is null - */ @Override public void setName(String name) { @@ -537,10 +498,6 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * @return the regular expression that defines the files and directories in the host's {@link #getAppBase} that will - * be ignored by the automatic deployment process. - */ @Override public String getDeployIgnore() { if (deployIgnore == null) { @@ -550,22 +507,12 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * @return the compiled regular expression that defines the files and directories in the host's {@link #getAppBase} - * that will be ignored by the automatic deployment process. - */ @Override public Pattern getDeployIgnorePattern() { return this.deployIgnore; } - /** - * Set the regular expression that defines the files and directories in the host's {@link #getAppBase} that will be - * ignored by the automatic deployment process. - * - * @param deployIgnore the regexp - */ @Override public void setDeployIgnore(String deployIgnore) { String oldDeployIgnore; @@ -608,11 +555,6 @@ public class StandardHost extends ContainerBase implements Host { // --------------------------------------------------------- Public Methods - /** - * Add an alias name that should be mapped to this same Host. - * - * @param alias The alias to be added - */ @Override public void addAlias(String alias) { @@ -637,9 +579,9 @@ public class StandardHost extends ContainerBase implements Host { /** - * Add a child Container, only if the proposed child is an implementation of Context. - * - * @param child Child container to be added + * {@inheritDoc} + * <p> + * The child must be an implementation of <code>Context</code>. */ @Override public void addChild(Container child) { @@ -706,9 +648,6 @@ public class StandardHost extends ContainerBase implements Host { return result.toArray(new String[0]); } - /** - * @return the set of alias names for this Host. If none are defined, a zero length array is returned. - */ @Override public String[] findAliases() { synchronized (aliasesLock) { @@ -717,11 +656,6 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * Remove the specified alias name from the aliases for this Host. - * - * @param alias Alias name to be removed - */ @Override public void removeAlias(String alias) { @@ -759,13 +693,6 @@ public class StandardHost extends ContainerBase implements Host { } - /** - * Start this component and implement the requirements of - * {@link org.apache.catalina.util.LifecycleBase#startInternal()}. - * - * @exception LifecycleException if this component detects a fatal error that prevents this component from being - * used - */ @Override protected void startInternal() throws LifecycleException { diff --git a/java/org/apache/catalina/core/StandardPipeline.java b/java/org/apache/catalina/core/StandardPipeline.java index 2158a198f1..fc1d0adfcd 100644 --- a/java/org/apache/catalina/core/StandardPipeline.java +++ b/java/org/apache/catalina/core/StandardPipeline.java @@ -126,20 +126,12 @@ public class StandardPipeline extends LifecycleBase implements Pipeline { // ------------------------------------------------------ Contained Methods - /** - * Return the Container with which this Pipeline is associated. - */ @Override public Container getContainer() { return this.container; } - /** - * Set the Container with which this Pipeline is associated. - * - * @param container The new associated container - */ @Override public void setContainer(Container container) { this.container = container; @@ -152,12 +144,6 @@ public class StandardPipeline extends LifecycleBase implements Pipeline { } - /** - * Start {@link Valve}s) in this pipeline and implement the requirements of {@link LifecycleBase#startInternal()}. - * - * @exception LifecycleException if this component detects a fatal error that prevents this component from being - * used - */ @Override protected void startInternal() throws LifecycleException { @@ -177,12 +163,6 @@ public class StandardPipeline extends LifecycleBase implements Pipeline { } - /** - * Stop {@link Valve}s) in this pipeline and implement the requirements of {@link LifecycleBase#stopInternal()}. - * - * @exception LifecycleException if this component detects a fatal error that prevents this component from being - * used - */ @Override protected void stopInternal() throws LifecycleException { @@ -211,9 +191,6 @@ public class StandardPipeline extends LifecycleBase implements Pipeline { } - /** - * Return a String representation of this component. - */ @Override public String toString() { return ToStringUtil.toString(this); @@ -223,27 +200,12 @@ public class StandardPipeline extends LifecycleBase implements Pipeline { // ------------------------------------------------------- Pipeline Methods - /** - * <p> - * Return the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). - */ @Override public Valve getBasic() { return this.basic; } - /** - * <p> - * Set the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). Prior to - * setting the basic Valve, the Valve's <code>setContainer()</code> will be called, if it implements - * <code>Contained</code>, with the owning Container as an argument. The method may throw an - * <code>IllegalArgumentException</code> if this Valve chooses not to be associated with this Container, or - * <code>IllegalStateException</code> if it is already associated with a different Container. - * </p> - * - * @param valve Valve to be distinguished as the basic Valve - */ @Override public void setBasic(Valve valve) { @@ -302,21 +264,6 @@ public class StandardPipeline extends LifecycleBase implements Pipeline { } - /** - * <p> - * Add a new Valve to the end of the pipeline associated with this Container. Prior to adding the Valve, the Valve's - * <code>setContainer()</code> method will be called, if it implements <code>Contained</code>, with the owning - * Container as an argument. The method may throw an <code>IllegalArgumentException</code> if this Valve chooses not - * to be associated with this Container, or <code>IllegalStateException</code> if it is already associated with a - * different Container. - * </p> - * - * @param valve Valve to be added - * - * @exception IllegalArgumentException if this Container refused to accept the specified Valve - * @exception IllegalArgumentException if the specified Valve refuses to be associated with this Container - * @exception IllegalStateException if the specified Valve is already associated with a different Container - */ @Override public void addValve(Valve valve) { @@ -356,10 +303,6 @@ public class StandardPipeline extends LifecycleBase implements Pipeline { } - /** - * Return the set of Valves in the pipeline associated with this Container, including the basic Valve (if any). If - * there are no such Valves, a zero-length array is returned. - */ @Override public Valve[] getValves() { @@ -395,13 +338,6 @@ public class StandardPipeline extends LifecycleBase implements Pipeline { } - /** - * Remove the specified Valve from the pipeline associated with this Container, if it is found; otherwise, do - * nothing. If the Valve is found and removed, the Valve's <code>setContainer(null)</code> method will be called if - * it implements <code>Contained</code>. - * - * @param valve Valve to be removed - */ @Override public void removeValve(Valve valve) { diff --git a/java/org/apache/catalina/core/StandardServer.java b/java/org/apache/catalina/core/StandardServer.java index 1849e9c51e..629a683d4c 100644 --- a/java/org/apache/catalina/core/StandardServer.java +++ b/java/org/apache/catalina/core/StandardServer.java @@ -227,9 +227,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * Return the global naming resources context. - */ @Override public javax.naming.Context getGlobalNamingContext() { return this.globalNamingContext; @@ -246,20 +243,12 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * Return the global naming resources. - */ @Override public NamingResourcesImpl getGlobalNamingResources() { return this.globalNamingResources; } - /** - * Set the global naming resources. - * - * @param globalNamingResources The new global naming resources - */ @Override public void setGlobalNamingResources(NamingResourcesImpl globalNamingResources) { @@ -301,20 +290,12 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * Return the port number we listen to for shutdown commands. - */ @Override public int getPort() { return this.port; } - /** - * Set the port number we listen to for shutdown commands. - * - * @param port The new port number - */ @Override public void setPort(int port) { this.port = port; @@ -350,57 +331,35 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * Return the address on which we listen to for shutdown commands. - */ @Override public String getAddress() { return this.address; } - /** - * Set the address on which we listen to for shutdown commands. - * - * @param address The new address - */ @Override public void setAddress(String address) { this.address = address; } - /** - * Return the shutdown command string we are waiting for. - */ @Override public String getShutdown() { return this.shutdown; } - /** - * Set the shutdown command we are waiting for. - * - * @param shutdown The new shutdown command - */ @Override public void setShutdown(String shutdown) { this.shutdown = shutdown; } - /** - * Return the outer Catalina startup/shutdown component if present. - */ @Override public Catalina getCatalina() { return catalina; } - /** - * Set the outer Catalina startup/shutdown component if present. - */ @Override public void setCatalina(Catalina catalina) { this.catalina = catalina; @@ -504,11 +463,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { // --------------------------------------------------------- Server Methods - /** - * Add a new Service to the set of defined Services. - * - * @param service The Service to be added - */ @Override public void addService(Service service) { @@ -558,10 +512,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } } - /** - * Wait until a proper shutdown command is received, then return. This keeps the main thread alive - the thread pool - * listening for http connections is daemon threads. - */ @Override public void await() { // Negative values - don't wait on port - tomcat is embedded or we just don't like ports @@ -693,11 +643,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * @return the specified Service (if it exists); otherwise return <code>null</code>. - * - * @param name Name of the Service to be returned - */ @Override public Service findService(String name) { if (name == null) { @@ -719,9 +664,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * @return The array of Services defined within this Server. - */ @Override public Service[] findServices() { servicesReadLock.lock(); @@ -751,11 +693,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * Remove the specified Service from the set associated from this Server. - * - * @param service The Service to be removed - */ @Override public void removeService(Service service) { @@ -850,9 +787,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * Return a String representation of this component. - */ @Override public String toString() { return "StandardServer[" + getPort() + ']'; @@ -925,13 +859,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * Start nested components ({@link Service}s) and implement the requirements of - * {@link org.apache.catalina.util.LifecycleBase#startInternal()}. - * - * @exception LifecycleException if this component detects a fatal error that prevents this component from being - * used - */ @Override protected void startInternal() throws LifecycleException { @@ -975,12 +902,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } - /** - * Stop nested components ({@link Service}s) and implement the requirements of - * {@link org.apache.catalina.util.LifecycleBase#stopInternal()}. - * - * @exception LifecycleException if this component detects a fatal error that needs to be reported - */ @Override protected void stopInternal() throws LifecycleException { @@ -1016,7 +937,9 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { } /** - * Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix + * {@inheritDoc} + * <p> + * This is used to allow connectors to bind to restricted ports under Unix * operating environments. */ @Override @@ -1085,9 +1008,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { super.destroyInternal(); } - /** - * Return the parent class loader for this component. - */ @Override public ClassLoader getParentClassLoader() { if (parentClassLoader != null) { @@ -1099,11 +1019,6 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { return ClassLoader.getSystemClassLoader(); } - /** - * Set the parent class loader for this server. - * - * @param parent The new parent class loader - */ @Override public void setParentClassLoader(ClassLoader parent) { ClassLoader oldParentClassLoader = this.parentClassLoader; @@ -1116,7 +1031,7 @@ public final class StandardServer extends LifecycleMBeanBase implements Server { private ObjectName onameMBeanFactory; /** - * Obtain the MBean domain for this server. The domain is obtained using the following search order: + * @return the MBean domain for this server. The domain is obtained using the following search order: * <ol> * <li>Name of first {@link org.apache.catalina.Engine}.</li> * <li>Name of first {@link Service}.</li> diff --git a/java/org/apache/catalina/core/StandardService.java b/java/org/apache/catalina/core/StandardService.java index 461d8aa62b..724dde9668 100644 --- a/java/org/apache/catalina/core/StandardService.java +++ b/java/org/apache/catalina/core/StandardService.java @@ -173,40 +173,24 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Return the name of this Service. - */ @Override public String getName() { return name; } - /** - * Set the name of this Service. - * - * @param name The new service name - */ @Override public void setName(String name) { this.name = name; } - /** - * Return the <code>Server</code> with which we are associated (if any). - */ @Override public Server getServer() { return this.server; } - /** - * Set the <code>Server</code> with which we are associated (if any). - * - * @param server The server that owns this Service - */ @Override public void setServer(Server server) { this.server = server; @@ -215,11 +199,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { // --------------------------------------------------------- Public Methods - /** - * Add a new Connector to the set of defined Connectors, and associate it with this Service's Container. - * - * @param connector The Connector to be added - */ @Override public void addConnector(Connector connector) { @@ -273,9 +252,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Find and return the set of Connectors associated with this Service. - */ @Override public Connector[] findConnectors() { Lock readLock = connectorsLock.readLock(); @@ -289,12 +265,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Remove the specified Connector from the set associated from this Service. The removed Connector will also be - * disassociated from our Container. - * - * @param connector The Connector to be removed - */ @Override public void removeConnector(Connector connector) { @@ -348,9 +318,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Return a String representation of this component. - */ @Override public String toString() { StringBuilder sb = new StringBuilder("StandardService["); @@ -360,11 +327,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Adds a named executor to the service - * - * @param ex Executor - */ @Override public void addExecutor(Executor ex) { boolean added = false; @@ -387,11 +349,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Retrieves all executors - * - * @return Executor[] - */ @Override public Executor[] findExecutors() { executorsLock.readLock().lock(); @@ -403,13 +360,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Retrieves executor by name, null if not found - * - * @param executorName String - * - * @return Executor - */ @Override public Executor getExecutor(String executorName) { executorsLock.readLock().lock(); @@ -426,11 +376,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Removes an executor from the service - * - * @param ex Executor - */ @Override public void removeExecutor(Executor ex) { boolean removed = false; @@ -552,6 +497,8 @@ public class StandardService extends LifecycleMBeanBase implements Service { /** * Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix * operating environments. + * + * @exception LifecycleException if this component detects a fatal error that needs to be reported */ @Override protected void initInternal() throws LifecycleException { @@ -602,9 +549,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Return the parent class loader for this component. - */ @Override public ClassLoader getParentClassLoader() { if (parentClassLoader != null) { @@ -617,11 +561,6 @@ public class StandardService extends LifecycleMBeanBase implements Service { } - /** - * Set the parent class loader for this server. - * - * @param parent The new parent class loader - */ @Override public void setParentClassLoader(ClassLoader parent) { ClassLoader oldParentClassLoader = this.parentClassLoader; diff --git a/java/org/apache/catalina/core/StandardWrapper.java b/java/org/apache/catalina/core/StandardWrapper.java index ddb8036fa5..33084b2405 100644 --- a/java/org/apache/catalina/core/StandardWrapper.java +++ b/java/org/apache/catalina/core/StandardWrapper.java @@ -284,26 +284,12 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra this.overridable = overridable; } - /** - * Return the available date/time for this servlet, in milliseconds since the epoch. If this date/time is - * Long.MAX_VALUE, it is considered to mean that unavailability is permanent and any request for this servlet will - * return an SC_NOT_FOUND error. 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. - */ @Override public long getAvailable() { return this.available; } - /** - * Set the available date/time for this servlet, in milliseconds since the epoch. If this date/time is - * Long.MAX_VALUE, it is considered to mean that unavailability is permanent and any request for this servlet will - * return an SC_NOT_FOUND error. If this date/time is in the future, any request for this servlet will return an - * SC_SERVICE_UNAVAILABLE error. - * - * @param available The new available date/time - */ @Override public void setAvailable(long available) { long oldAvailable = this.available; @@ -325,9 +311,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * @return the load-on-startup order value (negative value means load on first call). - */ @Override public int getLoadOnStartup() { @@ -343,11 +326,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Set the load-on-startup order value (negative value means load on first call). - * - * @param value New load-on-startup value - */ @Override public void setLoadOnStartup(int value) { @@ -431,20 +409,12 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * @return the run-as identity for this servlet. - */ @Override public String getRunAs() { return this.runAs; } - /** - * Set the run-as identity for this servlet. - * - * @param runAs New run-as identity value - */ @Override public void setRunAs(String runAs) { @@ -455,20 +425,12 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * @return the fully qualified servlet class name for this servlet. - */ @Override public String getServletClass() { return this.servletClass; } - /** - * Set the fully qualified servlet class name for this servlet. - * - * @param servletClass Servlet class name - */ @Override public void setServletClass(String servletClass) { @@ -494,16 +456,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Does the servlet class represented by this component implement the <code>SingleThreadModel</code> interface? This - * can only be determined once the class is loaded. Calling this method will not trigger loading the class since - * that may cause the application to behave unexpectedly. - * - * @return {@code null} if the class has not been loaded, otherwise {@code - * true} if the servlet does implement {@code SingleThreadModel} and {@code false} if it does not. - * - * @deprecated This will be removed in Tomcat 10.1 onwards. - */ @Deprecated public Boolean isSingleThreadModel() { // If the servlet has been loaded either singleThreadModel will be true @@ -515,9 +467,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * @return <code>true</code> if the Servlet has been marked unavailable. - */ @Override public boolean isUnavailable() { @@ -576,18 +525,12 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * @return the associated servlet instance. - */ @Override public Servlet getServlet() { return instance; } - /** - * Set the associated servlet instance. - */ @Override public void setServlet(Servlet servlet) { instance = servlet; @@ -596,10 +539,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra // --------------------------------------------------------- Public Methods - /** - * Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of - * this container. Unexpected throwables will be caught and logged. - */ @Override public synchronized void backgroundProcess() { super.backgroundProcess(); @@ -650,12 +589,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Add a new servlet initialization parameter for this servlet. - * - * @param name Name of this initialization parameter to add - * @param value Value of this initialization parameter to add - */ @Override public void addInitParameter(String name, String value) { @@ -670,11 +603,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Add a mapping associated with the Wrapper. - * - * @param mapping The new wrapper mapping - */ @Override public void addMapping(String mapping) { @@ -691,12 +619,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Add a new security role reference record to the set of records for this servlet. - * - * @param name Role name used within this servlet - * @param link Role name used within the web application - */ @Override public void addSecurityReference(String name, String link) { @@ -711,16 +633,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Allocate an initialized instance of this Servlet that is ready to have 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 <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 an exception - * @exception ServletException if a loading error occurs - */ @Override public Servlet allocate() throws ServletException { @@ -817,14 +729,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Return this previously allocated servlet to the pool of available instances. If this servlet class does not - * implement SingleThreadModel, no action is actually required. - * - * @param servlet The servlet to be returned - * - * @exception ServletException if a deallocation error occurs - */ @Override public void deallocate(Servlet servlet) throws ServletException { @@ -844,11 +748,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Return the value for the specified initialization parameter name, if any; otherwise return <code>null</code>. - * - * @param name Name of the requested initialization parameter - */ @Override public String findInitParameter(String name) { @@ -862,9 +761,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Return the names of all defined initialization parameters for this servlet. - */ @Override public String[] findInitParameters() { @@ -878,9 +774,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Return the mappings associated with this wrapper. - */ @Override public String[] findMappings() { @@ -894,12 +787,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * 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 - */ @Override public String findSecurityReference(String name) { String reference = null; @@ -925,10 +812,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Return the set of security role reference names associated with this servlet, if any; otherwise return a - * zero-length array. - */ @Override public String[] findSecurityReferences() { @@ -943,17 +826,12 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra /** - * 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 at server - * startup time. + * {@inheritDoc} * <p> * <b>IMPLEMENTATION NOTE</b>: Servlets whose classnames begin with <code>org.apache.catalina.</code> (so-called * "container" servlets) are loaded by the same classloader that loaded this class, rather than the classloader for * the current web application. This gives such classes access to Catalina internals, which are prevented for * classes loaded for web applications. - * - * @exception ServletException if the servlet init() method threw an exception - * @exception ServletException if some other loading problem occurs */ @Override public synchronized void load() throws ServletException { @@ -1123,11 +1001,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } } - /** - * Remove the specified initialization parameter from this servlet. - * - * @param name Name of the initialization parameter to remove - */ @Override public void removeInitParameter(String name) { @@ -1142,11 +1015,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Remove a mapping associated with the wrapper. - * - * @param mapping The pattern to remove - */ @Override public void removeMapping(String mapping) { @@ -1163,11 +1031,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Remove any security role reference for the specified role name. - * - * @param name Security role used within this servlet to be removed - */ @Override public void removeSecurityReference(String name) { @@ -1182,12 +1045,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * 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 - */ @Override public void unavailable(UnavailableException unavailable) { getServletContext().log(sm.getString("standardWrapper.unavailable", getName())); @@ -1206,13 +1063,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Unload all initialized instances of this servlet, after calling the <code>destroy()</code> method for each - * instance. This can be used, for example, prior to shutting down the entire servlet engine, or prior to reloading - * all of the classes from the Loader associated with our Loader's repository. - * - * @exception ServletException if an exception is thrown by the destroy() method - */ @Override public synchronized void unload() throws ServletException { @@ -1612,12 +1462,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Remove a JMX notificationListener - * - * @see javax.management.NotificationEmitter#removeNotificationListener(javax.management.NotificationListener, - * javax.management.NotificationFilter, java.lang.Object) - */ @Override public void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws ListenerNotFoundException { @@ -1626,11 +1470,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra protected MBeanNotificationInfo[] notificationInfo; - /** - * Get JMX Broadcaster Info - * - * @see javax.management.NotificationBroadcaster#getNotificationInfo() - */ @Override public MBeanNotificationInfo[] getNotificationInfo() { if (notificationInfo == null) { @@ -1652,12 +1491,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Add a JMX-NotificationListener - * - * @see javax.management.NotificationBroadcaster#addNotificationListener(javax.management.NotificationListener, - * javax.management.NotificationFilter, java.lang.Object) - */ @Override public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws IllegalArgumentException { @@ -1665,11 +1498,6 @@ public class StandardWrapper extends ContainerBase implements ServletConfig, Wra } - /** - * Remove a JMX-NotificationListener - * - * @see javax.management.NotificationBroadcaster#removeNotificationListener(javax.management.NotificationListener) - */ @Override public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException { broadcaster.removeNotificationListener(listener); diff --git a/java/org/apache/catalina/util/LifecycleMBeanBase.java b/java/org/apache/catalina/util/LifecycleMBeanBase.java index 0a1bcc78d6..d8a2abd45d 100644 --- a/java/org/apache/catalina/util/LifecycleMBeanBase.java +++ b/java/org/apache/catalina/util/LifecycleMBeanBase.java @@ -42,11 +42,6 @@ public abstract class LifecycleMBeanBase extends LifecycleBase @Deprecated protected MBeanServer mserver = null; - /** - * Sub-classes wishing to perform additional initialization should override - * this method, ensuring that super.initInternal() is the first call in the - * overriding method. - */ @Override protected void initInternal() throws LifecycleException { // If oname is not null then registration has already happened via @@ -59,32 +54,18 @@ public abstract class LifecycleMBeanBase extends LifecycleBase } - /** - * Sub-classes wishing to perform additional clean-up should override this - * method, ensuring that super.destroyInternal() is the last call in the - * overriding method. - */ @Override protected void destroyInternal() throws LifecycleException { unregister(oname); } - /** - * Specify the domain under which this component should be registered. Used - * with components that cannot (easily) navigate the component hierarchy to - * determine the correct domain to use. - */ @Override public final void setDomain(String domain) { this.domain = domain; } - /** - * Obtain the domain under which this component will be / has been - * registered. - */ @Override public final String getDomain() { if (domain == null) { @@ -108,9 +89,6 @@ public abstract class LifecycleMBeanBase extends LifecycleBase protected abstract String getDomainInternal(); - /** - * Obtain the name under which this component has been registered with JMX. - */ @Override public final ObjectName getObjectName() { return oname; @@ -223,10 +201,6 @@ public abstract class LifecycleMBeanBase extends LifecycleBase } - /** - * Allows the object to be registered with an alternative - * {@link MBeanServer} and/or {@link ObjectName}. - */ @Override public final ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception { --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org