diff --git a/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java b/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java index 1a5edc296b8..a6b3c4ba546 100644 --- a/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java +++ b/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java @@ -521,7 +521,7 @@ public class HttpClient extends HttpBuffers implements Attributes * if a keystore location has been provided then client will attempt to use it as the keystore, * otherwise we simply ignore certificates and run with a loose ssl context. * - * @return + * @return the SSL context * @throws IOException */ protected SSLContext getSSLContext() throws IOException diff --git a/jetty-client/src/main/java/org/eclipse/jetty/client/security/SecurityListener.java b/jetty-client/src/main/java/org/eclipse/jetty/client/security/SecurityListener.java index 87d37b9a7a9..20902d4312b 100644 --- a/jetty-client/src/main/java/org/eclipse/jetty/client/security/SecurityListener.java +++ b/jetty-client/src/main/java/org/eclipse/jetty/client/security/SecurityListener.java @@ -58,7 +58,7 @@ public class SecurityListener extends HttpEventListenerWrapper * scrapes an authentication type from the authString * * @param authString - * @return + * @return the authentication type */ protected String scrapeAuthenticationType( String authString ) { @@ -80,7 +80,7 @@ public class SecurityListener extends HttpEventListenerWrapper * scrapes a set of authentication details from the authString * * @param authString - * @return + * @return the authentication details */ protected Map scrapeAuthenticationDetails( String authString ) { diff --git a/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationSupport.java b/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationSupport.java index 55dc0999dc2..b9743d4daa5 100644 --- a/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationSupport.java +++ b/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationSupport.java @@ -96,8 +96,8 @@ public class ContinuationSupport * vary depending on the container in which the application is * deployed. It may be an implementation native to the container (eg * org.eclipse.jetty.server.AsyncContinuation) or one of the utility - * implementations provided such as {@link FauxContinuation} or - * {@link Servlet3Continuation}. + * implementations provided such as an internal FauxContinuation + * or a real implementation like {@link Servlet3Continuation}. * @param request The request * @return a Continuation instance */ diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/App.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/App.java index d145e11f885..6b37f79bdfb 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/App.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/App.java @@ -17,6 +17,7 @@ package org.eclipse.jetty.deploy; import org.eclipse.jetty.server.handler.ContextHandler; import org.eclipse.jetty.util.AttributesMap; +import org.omg.CORBA.portable.ApplicationException; /** * The information about an App that is managed by the {@link DeploymentManager} @@ -86,8 +87,8 @@ public class App * Create it if needed. * * @return the {@link ContextHandler} to use for the App when fully started. - * (Portions of which might be ignored when App is in the - * {@link AppState#STAGED} state} + * (Portions of which might be ignored when App is not yet + * {@link AppLifeCycle#DEPLOYED} or {@link AppLifeCycle#STARTED}) * @throws Exception */ public ContextHandler getContextHandler() throws Exception diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java index ddc195bc1f3..2ae8f7af634 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java @@ -29,7 +29,7 @@ import org.eclipse.jetty.util.log.Log; /** * The lifecycle of an App in the {@link DeploymentManager}. * - * Setups a the default {@link Graph}, and manages the bindings to the life cycle via the {@link DeployLifeCycleBinding} + * Setups a the default {@link Graph}, and manages the bindings to the life cycle via the {@link AppLifeCycle.Binding} * annotation. *

* diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/ContextDeployer.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/ContextDeployer.java index 8e5bf4afac2..74b905c8c48 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/ContextDeployer.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/ContextDeployer.java @@ -48,7 +48,7 @@ import org.eclipse.jetty.xml.XmlConfiguration; * *

* The xml should configure the context and the instance is deployed to the {@link ContextHandlerCollection} specified - * by {@link #setContexts(Server)}. + * by {@link Server#setHandler(org.eclipse.jetty.server.Handler)}. * *

* Similarly, when one of these existing files is removed, the corresponding context is undeployed; when one of these @@ -88,7 +88,7 @@ public class ContextDeployer extends AbstractLifeCycle /** * Handle a new deployment * - * @see org.eclipse.jetty.util.Scanner.FileAddedListener#fileAdded(java.lang.String) + * @see org.eclipse.jetty.util.Scanner.DiscreteListener#fileAdded(java.lang.String) */ public void fileAdded(String filename) throws Exception { @@ -98,7 +98,7 @@ public class ContextDeployer extends AbstractLifeCycle /** * Handle a change to an existing deployment. Undeploy then redeploy. * - * @see org.eclipse.jetty.util.Scanner.FileChangedListener#fileChanged(java.lang.String) + * @see org.eclipse.jetty.util.Scanner.DiscreteListener#fileChanged(java.lang.String) */ public void fileChanged(String filename) throws Exception { @@ -108,7 +108,7 @@ public class ContextDeployer extends AbstractLifeCycle /** * Handle an undeploy. * - * @see org.eclipse.jetty.util.Scanner.FileRemovedListener#fileRemoved(java.lang.String) + * @see org.eclipse.jetty.util.Scanner.DiscreteListener#fileRemoved(java.lang.String) */ public void fileRemoved(String filename) throws Exception { @@ -123,8 +123,6 @@ public class ContextDeployer extends AbstractLifeCycle /** * Constructor - * - * @throws Exception */ public ContextDeployer() { @@ -245,7 +243,7 @@ public class ContextDeployer extends AbstractLifeCycle /* ------------------------------------------------------------ */ /** - * @return + * @return the directory * @deprecated use {@link #setContextsDir(String)} */ @Deprecated @@ -256,7 +254,7 @@ public class ContextDeployer extends AbstractLifeCycle /* ------------------------------------------------------------ */ /** - * @return + * @return the configuration directory * @deprecated use {@link #setContextsDir(String)} */ @Deprecated @@ -276,7 +274,7 @@ public class ContextDeployer extends AbstractLifeCycle /* ------------------------------------------------------------ */ /** - * @return + * @return the configuration manager */ public ConfigurationManager getConfigurationManager() { @@ -319,7 +317,7 @@ public class ContextDeployer extends AbstractLifeCycle /** * Get a contextAttribute that will be set for every Context deployed by this deployer. * @param name - * @return + * @return the attribute value */ public Object getAttribute (String name) { diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentManager.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentManager.java index 854938c5db7..e1389696639 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentManager.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/DeploymentManager.java @@ -304,9 +304,9 @@ public class DeploymentManager extends AbstractLifeCycle /** * Get Set of {@link App}s by {@link Node} * - * @param state - * the state to look for. - * @return + * @param node + * the node to look for. + * @return the collection of apps for the node */ public Collection getApps(Node node) { @@ -357,7 +357,7 @@ public class DeploymentManager extends AbstractLifeCycle * Get a contextAttribute that will be set for every Context deployed by this provider. * * @param name - * @return + * @return the context attribute value */ public Object getContextAttribute(String name) { diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/WebAppDeployer.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/WebAppDeployer.java index 91937498380..b78c1d46417 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/WebAppDeployer.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/WebAppDeployer.java @@ -41,7 +41,7 @@ import org.eclipse.jetty.webapp.WebAppContext; * by {@link #getContexts()}. {@link ContextHandlerCollection#getContextClass()} * *

- * This deployer does not do hot deployment or undeployment. Nor does it support per webapplication configuration. For + * This deployer does not do hot deployment or undeployment. Nor does it support per web application configuration. For * these features see {@link ContextDeployer}. * * @see DeploymentManager @@ -150,7 +150,7 @@ public class WebAppDeployer extends AbstractLifeCycle /** * Get a contextAttribute that will be set for every Context deployed by this deployer. * @param name - * @return + * @return the attribute value */ public Object getAttribute (String name) { diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/graph/Graph.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/graph/Graph.java index 547bdb35197..02860e7b84a 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/graph/Graph.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/graph/Graph.java @@ -138,7 +138,7 @@ public class Graph /** * Find all edges that are connected {@link Edge#getFrom()} the specific node. * - * @param node + * @param from * the node with potential edges from it * @return the set of edges from the node */ diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ContextProvider.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ContextProvider.java index 8a92c458933..92940acee7a 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ContextProvider.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/ContextProvider.java @@ -16,7 +16,7 @@ import org.eclipse.jetty.xml.XmlConfiguration; /* ------------------------------------------------------------ */ /** Context directory App Provider. - *

This specialisation of {@link MonitoredDirAppProvider} is the + *

This specialization of {@link MonitoredDirAppProvider} is the * replacement for {@link ContextDeployer} and it will scan a directory * only for context.xml files. * @see ContextDeployer diff --git a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/MonitoredDirAppProvider.java b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/MonitoredDirAppProvider.java index f55fea64968..36ea012de71 100644 --- a/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/MonitoredDirAppProvider.java +++ b/jetty-deploy/src/main/java/org/eclipse/jetty/deploy/providers/MonitoredDirAppProvider.java @@ -39,10 +39,8 @@ import org.eclipse.jetty.xml.XmlConfiguration; * AppProvider for Monitoring directories for contexts. * * A Context may either be a WAR, a directory or an XML descriptor. - * - * @deprecated - Use {@link ContextProvider} or {@link WebAppProvider} */ -public class MonitoredDirAppProvider extends AbstractLifeCycle implements AppProvider +public abstract class MonitoredDirAppProvider extends AbstractLifeCycle implements AppProvider { class MonitoredFilenameFilter implements FilenameFilter { diff --git a/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/AppLifeCycleTest.java b/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/AppLifeCycleTest.java index 26acce7045b..5caa04b68ad 100644 --- a/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/AppLifeCycleTest.java +++ b/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/AppLifeCycleTest.java @@ -159,7 +159,7 @@ public class AppLifeCycleTest /** * Request multiple lifecycle paths with a single lifecycle instance. Just to ensure that there is no state - * maintained between {@link AppLifeCycle#findPath(Node, Node)} requests. + * maintained between {@link AppLifeCycle#getPath(Node, Node)} requests. * * @throws IOException */ diff --git a/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/test/MavenTestingUtils.java b/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/test/MavenTestingUtils.java index e6f9e265a0a..367d584aa27 100644 --- a/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/test/MavenTestingUtils.java +++ b/jetty-deploy/src/test/java/org/eclipse/jetty/deploy/test/MavenTestingUtils.java @@ -93,7 +93,8 @@ public class MavenTestingUtils * * @param test * the junit 3.x testcase to base this new directory on. - * @return + * @return the File path to the testcase specific testing directory underneath the + * ${basedir}/target sub directory */ public static File getTargetTestingDir(TestCase test) { @@ -105,7 +106,8 @@ public class MavenTestingUtils * * @param testname * the testname to create directory against. - * @return + * @return the File path to the testname sepecific testing directory underneath the + * ${basedir}/target sub directory */ public static File getTargetTestingDir(String testname) { diff --git a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/ServletCallbackHandler.java b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/ServletCallbackHandler.java index 15caef790f1..d11a8d9bc84 100644 --- a/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/ServletCallbackHandler.java +++ b/jetty-jaspi/src/main/java/org/eclipse/jetty/security/jaspi/ServletCallbackHandler.java @@ -37,7 +37,6 @@ import org.eclipse.jetty.server.UserIdentity; * * Idiot class required by jaspi stupidity * - * @#*($)#@&^)$@#&*$@ * @version $Rev: 4793 $ $Date: 2009-03-19 00:00:01 +0100 (Thu, 19 Mar 2009) $ */ public class ServletCallbackHandler implements CallbackHandler diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java index 918f08295eb..586862384e7 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java @@ -440,7 +440,7 @@ public class LdapLoginModule extends AbstractLoginModule * password supplied authentication check * * @param webCredential - * @return + * @return true if authenticated * @throws LoginException */ protected boolean credentialLogin(Object webCredential) throws LoginException diff --git a/jetty-plus/src/main/java/org/eclipse/jetty/plus/security/DataSourceLoginService.java b/jetty-plus/src/main/java/org/eclipse/jetty/plus/security/DataSourceLoginService.java index 79728c1d8f2..8d0d6ae3e83 100644 --- a/jetty-plus/src/main/java/org/eclipse/jetty/plus/security/DataSourceLoginService.java +++ b/jetty-plus/src/main/java/org/eclipse/jetty/plus/security/DataSourceLoginService.java @@ -277,7 +277,7 @@ public class DataSourceLoginService extends MappedLoginService /* ------------------------------------------------------------ */ /** Load user's info from database. * - * @param user + * @param userName */ @Override protected UserIdentity loadUser (String userName) diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java b/jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java index 271fa933d8d..ca0659a7ba0 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java @@ -68,7 +68,7 @@ public interface Authenticator * @param response * @param mandatory * @param validatedUser - * @return + * @return true if response is secure * @throws ServerAuthException */ boolean secureResponse(ServletRequest request, ServletResponse response, boolean mandatory, User validatedUser) throws ServerAuthException; diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/DefaultIdentityService.java b/jetty-security/src/main/java/org/eclipse/jetty/security/DefaultIdentityService.java index e5f3335a64d..65ec7fc991a 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/DefaultIdentityService.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/DefaultIdentityService.java @@ -26,7 +26,7 @@ import org.eclipse.jetty.server.UserIdentity; * This service handles only role reference maps passed in an * associated {@link UserIdentity.Scope}. If there are roles * refs present, then associate will wrap the UserIdentity with one - * that uses the role references in the {@link UserIdentity#isUserInRole(String)} + * that uses the role references in the {@link UserIdentity#isUserInRole(String, org.eclipse.jetty.server.UserIdentity.Scope)} * implementation. All other operations are effectively noops. * */ @@ -40,7 +40,7 @@ public class DefaultIdentityService implements IdentityService /* ------------------------------------------------------------ */ /** * If there are roles refs present in the scope, then wrap the UserIdentity - * with one that uses the role references in the {@link UserIdentity#isUserInRole(String)} + * with one that uses the role references in the {@link UserIdentity#isUserInRole(String, org.eclipse.jetty.server.UserIdentity.Scope)} */ public Object associate(UserIdentity user) { diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/HashLoginService.java b/jetty-security/src/main/java/org/eclipse/jetty/security/HashLoginService.java index 31e21af15aa..eb3946bd0d6 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/HashLoginService.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/HashLoginService.java @@ -51,9 +51,6 @@ import org.eclipse.jetty.util.resource.Resource; * * If DIGEST Authentication is used, the password must be in a recoverable * format, either plain text or OBF:. - * - * @see org.eclipse.jetty.security.Password - * */ public class HashLoginService extends MappedLoginService { @@ -105,8 +102,6 @@ public class HashLoginService extends MappedLoginService * names. * * @param config Filename or url of user properties file. - * @exception java.io.IOException if user properties file could not be - * loaded */ public void setConfig(String config) { diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/JDBCLoginService.java b/jetty-security/src/main/java/org/eclipse/jetty/security/JDBCLoginService.java index 06e51c81360..c5d1138cf60 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/JDBCLoginService.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/JDBCLoginService.java @@ -168,7 +168,6 @@ public class JDBCLoginService extends MappedLoginService * Load JDBC connection configuration from properties file. * * @param config Filename or url of user properties file. - * @exception java.io.IOException */ public void setConfig(String config) { diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/BasicAuthenticator.java b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/BasicAuthenticator.java index 44f9ff3bf31..212b4ef104f 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/BasicAuthenticator.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/BasicAuthenticator.java @@ -36,9 +36,6 @@ import org.eclipse.jetty.util.StringUtil; public class BasicAuthenticator extends LoginAuthenticator { /* ------------------------------------------------------------ */ - /** - * @param loginService - */ public BasicAuthenticator() { } diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java index a344b7c0bfa..f40b7e66e88 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/ClientCertAuthenticator.java @@ -46,7 +46,7 @@ public class ClientCertAuthenticator extends LoginAuthenticator } /** - * @return + * @return Authentication for request * @throws ServerAuthException */ public Authentication validateRequest(ServletRequest req, ServletResponse res, boolean mandatory) throws ServerAuthException diff --git a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java index 28ebf728b34..78c9c32c75e 100644 --- a/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java +++ b/jetty-security/src/main/java/org/eclipse/jetty/security/authentication/DeferredAuthentication.java @@ -65,7 +65,7 @@ public class DeferredAuthentication implements Authentication.Deferred /* ------------------------------------------------------------ */ /** - * @see org.eclipse.jetty.server.Authentication.Deferred#authenticate() + * @see org.eclipse.jetty.server.Authentication.Deferred#authenticate(ServletRequest) */ public Authentication authenticate(ServletRequest request) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/Request.java b/jetty-server/src/main/java/org/eclipse/jetty/server/Request.java index d31219d1bac..2f22c0882d1 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/Request.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/Request.java @@ -90,7 +90,7 @@ import org.eclipse.jetty.util.log.Log; * and enables the ability to create new sessions. * *

  • The {@link Request#getServletPath()} method will return null until the request has been - * passed to a {@link org.eclipse.jetty.servlet.ServletHandler} and the pathInfo matched + * passed to a org.eclipse.jetty.servlet.ServletHandler and the pathInfo matched * against the servlet URL patterns and {@link Request#setServletPath(String)} called as a result.
    • * * diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/Server.java b/jetty-server/src/main/java/org/eclipse/jetty/server/Server.java index b14ce8f4144..e8f7dcff4cd 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/Server.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/Server.java @@ -601,7 +601,7 @@ public class Server extends HandlerWrapper implements Attributes /* ------------------------------------------------------------ */ /** - * Set graceful shutdown timeout. If set, the {@link #doStop()} method will not immediately stop the + * Set graceful shutdown timeout. If set, the internal doStop() method will not immediately stop the * server. Instead, all {@link Connector}s will be closed so that new connections will not be accepted * and all handlers that implement {@link Graceful} will be put into the shutdown mode so that no new requests * will be accepted, but existing requests can complete. The server will then wait the configured timeout diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/UserIdentity.java b/jetty-server/src/main/java/org/eclipse/jetty/server/UserIdentity.java index 0c849bd5932..8422e85dc38 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/UserIdentity.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/UserIdentity.java @@ -50,15 +50,12 @@ public interface UserIdentity boolean isUserInRole(String role, Scope scope); - /* ------------------------------------------------------------ */ - /* ------------------------------------------------------------ */ /* ------------------------------------------------------------ */ /** * A UserIdentity Scope. * A scope is the environment in which a User Identity is to * be interpreted. Typically it is set by the target servlet of * a request. - * @see org.eclipse.jetty.servlet.ServletHolder */ interface Scope { @@ -82,15 +79,11 @@ public interface UserIdentity Map getRoleRefMap(); } - /* ------------------------------------------------------------ */ - /* ------------------------------------------------------------ */ /* ------------------------------------------------------------ */ public interface UnauthenticatedUserIdentity extends UserIdentity { } - /* ------------------------------------------------------------ */ - /* ------------------------------------------------------------ */ /* ------------------------------------------------------------ */ public static final UserIdentity UNAUTHENTICATED_IDENTITY = new UnauthenticatedUserIdentity() { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java index b355639596e..198351c00b5 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java @@ -601,7 +601,6 @@ public class ContextHandler extends ScopedHandler implements Attributes, Server. * handling (Eg configuration) before the call to super.doStart by this method * will start contained handlers. * @see org.eclipse.jetty.server.handler.ContextHandler.Context - * @see org.eclipse.jetty.webapp.WebAppContext */ protected void startContext() throws Exception @@ -987,7 +986,6 @@ public class ContextHandler extends ScopedHandler implements Attributes, Server. * Called by {@link #handle(String, Request, HttpServletRequest, HttpServletResponse)} when a * target within a context is determined. If the target is protected, 404 is returned. * The default implementation always returns false. - * @see org.eclipse.jetty.webapp.WebAppContext#isProtectedTarget(String) */ /* ------------------------------------------------------------ */ protected boolean isProtectedTarget(String target) diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java index 3e353578a60..08f3f756076 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java @@ -625,7 +625,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement /** * Create a new session instance * @param request - * @return + * @return the new session */ protected abstract Session newSession(HttpServletRequest request); diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java index 6ee37caebcc..5452362a4df 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java @@ -387,8 +387,6 @@ public class JDBCSessionIdManager extends AbstractSessionIdManager * * Makes necessary database tables and starts a Session * scavenger thread. - * - * @see org.eclipse.jetty.server.session.AbstractSessionIdManager#doStart() */ @Override public void doStart() @@ -410,8 +408,6 @@ public class JDBCSessionIdManager extends AbstractSessionIdManager /** * Stop the scavenger. - * - * @see org.eclipse.jetty.util.component.AbstractLifeCycle#doStop() */ @Override public void doStop () @@ -431,7 +427,7 @@ public class JDBCSessionIdManager extends AbstractSessionIdManager /** * Get a connection from the driver or datasource. * - * @return + * @return the connection for the datasource * @throws SQLException */ protected Connection getConnection () diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java index 5494fe1617d..6be7279f772 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java @@ -50,15 +50,15 @@ import org.eclipse.jetty.util.log.Log; * contextPath (of the context owning the session) * sessionId (unique in a context) * lastNode (name of node last handled session) - * accessTime (time in ms session was accessed) - * lastAccessTime (previous time in ms session was accessed) - * createTime (time in ms session created) - * cookieTime (time in ms session cookie created) - * lastSavedTime (last time in ms session access times were saved) - * expiryTime (time in ms that the session is due to expire) + * accessTime (time in milliseconds session was accessed) + * lastAccessTime (previous time in milliseconds session was accessed) + * createTime (time in milliseconds session created) + * cookieTime (time in milliseconds session cookie created) + * lastSavedTime (last time in milliseconds session access times were saved) + * expiryTime (time in milliseconds that the session is due to expire) * map (attribute map) * - * As an optimisation, to prevent thrashing the database, we do not persist + * As an optimization, to prevent thrashing the database, we do not persist * the accessTime and lastAccessTime every time the session is accessed. Rather, * we write it out every so often. The frequency is controlled by the saveIntervalSec * field. @@ -272,7 +272,7 @@ public class JDBCSessionManager extends AbstractSessionManager /** * Session restored in database. - * @param row + * @param data */ protected Session (SessionData data) { @@ -538,8 +538,6 @@ public class JDBCSessionManager extends AbstractSessionManager /** * Get all the sessions as a map of id to Session. - * - * @see org.eclipse.jetty.server.session.AbstractSessionManager#getSessionMap() */ @Override public Map getSessionMap() @@ -815,7 +813,7 @@ public class JDBCSessionManager extends AbstractSessionManager /** * Load a session from the database * @param id - * @return + * @return the session data that was loaded * @throws Exception */ protected SessionData loadSession (String id, String canonicalContextPath, String vhost) diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/session/SessionHandler.java b/jetty-server/src/main/java/org/eclipse/jetty/server/session/SessionHandler.java index 10d0e40b9a8..752a327b933 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/session/SessionHandler.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/session/SessionHandler.java @@ -229,8 +229,8 @@ public class SessionHandler extends ScopedHandler /* ------------------------------------------------------------ */ /** Look for a requested session ID in cookies and URI parameters + * @param baseRequest * @param request - * @param dispatch */ protected void setRequestedId(Request baseRequest, HttpServletRequest request) { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java b/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java index ab90485b602..8fac62c8cf9 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java @@ -363,13 +363,13 @@ public class SslSocketConnector extends SocketConnector implements SslConnector /* ------------------------------------------------------------ */ /** - * @param addr The {@link SocketAddress address} that this server should listen on + * @param host The host name that this server should listen on + * @param port the port that this server should listen on * @param backlog See {@link ServerSocket#bind(java.net.SocketAddress, int)} * @return A new {@link ServerSocket socket object} bound to the supplied address with all other * settings as per the current configuration of this connector. - * @see #setWantClientAuth - * @see #setNeedClientAuth - * @see #setCipherSuites + * @see #setWantClientAuth(boolean) + * @see #setNeedClientAuth(boolean) * @exception IOException */ @@ -576,10 +576,10 @@ public class SslSocketConnector extends SocketConnector implements SslConnector /* ------------------------------------------------------------ */ /** - * Set the value of the _wantClientAuth property. This property is used when - * {@link #newServerSocket(String, int, int) opening server sockets}. + * Set the value of the _wantClientAuth property. This property is used + * internally when opening server sockets. * - * @param wantClientAuth true iff we want client certificate authentication. + * @param wantClientAuth true if we want client certificate authentication. * @see SSLServerSocket#setWantClientAuth */ public void setWantClientAuth(boolean wantClientAuth) diff --git a/jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java b/jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java index 79bf1a3f774..73aa69f43d1 100644 --- a/jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java +++ b/jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java @@ -24,7 +24,7 @@ import junit.framework.TestCase; import org.eclipse.jetty.server.handler.AbstractHandler; /** - * Test {@link AbstractConnector#checkForwardedHeaders(org.eclipse.jetty.io.EndPoint, Request)}. + * Test AbstractConnector#checkForwardedHeaders(EndPoint, Request) */ public class CheckReverseProxyHeadersTest extends TestCase { diff --git a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ErrorPageErrorHandler.java b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ErrorPageErrorHandler.java index 989b8b01b0a..c9d560bcb60 100644 --- a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ErrorPageErrorHandler.java +++ b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ErrorPageErrorHandler.java @@ -49,15 +49,12 @@ public class ErrorPageErrorHandler extends ErrorHandler protected List _errorPageList; // list of ErrorCode by range /* ------------------------------------------------------------ */ - /** - * @param context - */ public ErrorPageErrorHandler() {} /* ------------------------------------------------------------ */ - /* - * @see org.eclipse.jetty.server.handler.ErrorHandler#handle(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int) + /** + * @see org.eclipse.jetty.server.handler.ErrorHandler#handle(String, Request, HttpServletRequest, HttpServletResponse) */ public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException { @@ -170,7 +167,7 @@ public class ErrorPageErrorHandler extends ErrorHandler /** Add Error Page mapping for an exception class * This method is called as a result of an exception-type element in a web.xml file * or may be called directly - * @param code The class (or superclass) of the matching exceptions + * @param exception The exception * @param uri The URI of the error page. */ public void addErrorPage(Class exception,String uri) diff --git a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/FilterMapping.java b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/FilterMapping.java index 46c13638c98..b0bb2fedc9a 100644 --- a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/FilterMapping.java +++ b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/FilterMapping.java @@ -193,11 +193,11 @@ public class FilterMapping /* ------------------------------------------------------------ */ /** * @param dispatches The dispatches to set. - * @see Handler#DEFAULT - * @see Handler#REQUEST - * @see Handler#ERROR - * @see Handler#FORWARD - * @see Handler#INCLUDE + * @see #DEFAULT + * @see #REQUEST + * @see #ERROR + * @see #FORWARD + * @see #INCLUDE */ public void setDispatches(int dispatches) { diff --git a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/Holder.java b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/Holder.java index a5a9a8aac5e..cc46e5a9537 100644 --- a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/Holder.java +++ b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/Holder.java @@ -173,7 +173,7 @@ public class Holder extends AbstractLifeCycle /* ------------------------------------------------------------ */ /** - * @param className The className to set. + * @param held The class to hold */ public void setHeldClass(Class held) { diff --git a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletContextHandler.java b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletContextHandler.java index 03ba5b22d43..401523c3abb 100644 --- a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletContextHandler.java +++ b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletContextHandler.java @@ -288,7 +288,7 @@ public class ServletContextHandler extends ContextHandler /* ------------------------------------------------------------ */ /** - * @param securityHandler The {@link org.eclipse.jetty.server.handler.SecurityHandler} to set on this context. + * @param securityHandler The {@link SecurityHandler} to set on this context. */ public void setSecurityHandler(SecurityHandler securityHandler) { diff --git a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHandler.java b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHandler.java index 0c9cccca132..ba2494f42b3 100644 --- a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHandler.java +++ b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHandler.java @@ -66,9 +66,6 @@ import org.eclipse.jetty.util.log.Log; * * Unless run as part of a {@link ServletContextHandler} or derivative, the {@link #initialize()} * method must be called manually after start(). - * - * @see org.eclipse.jetty.webapp.WebAppContext - * */ public class ServletHandler extends ScopedHandler { @@ -789,8 +786,8 @@ public class ServletHandler extends ScopedHandler /** Convenience method to add a servlet with a servlet mapping. * @param className * @param pathSpec - * @return - * @deprecated + * @return the ServletHolder + * @deprecated use {@link #addServletWithMapping(Class, String)} instead */ public ServletHolder addServlet (String className, String pathSpec) { @@ -824,7 +821,7 @@ public class ServletHandler extends ScopedHandler /* ------------------------------------------------------------ */ /** - * @see {@link #newFilterHolder(Class)} + * @see #newFilterHolder(Class) */ public FilterHolder newFilterHolder() { @@ -838,7 +835,7 @@ public class ServletHandler extends ScopedHandler } /* ------------------------------------------------------------ */ - /** conveniance method to add a filter. + /** Convenience method to add a filter. * @param filter class of filter to create * @param pathSpec filter mappings for filter * @param dispatches see {@link FilterMapping#setDispatches(int)} @@ -853,7 +850,7 @@ public class ServletHandler extends ScopedHandler } /* ------------------------------------------------------------ */ - /** conveniance method to add a filter. + /** Convenience method to add a filter. * @param className of filter * @param pathSpec filter mappings for filter * @param dispatches see {@link FilterMapping#setDispatches(int)} @@ -870,7 +867,7 @@ public class ServletHandler extends ScopedHandler } /* ------------------------------------------------------------ */ - /** conveniance method to add a filter. + /** Convenience method to add a filter. * @param holder filter holder to add * @param pathSpec filter mappings for filter * @param dispatches see {@link FilterMapping#setDispatches(int)} @@ -909,8 +906,8 @@ public class ServletHandler extends ScopedHandler * @param className * @param pathSpec * @param dispatches - * @return - * @deprecated + * @return the filter holder created + * @deprecated use {@link #addFilterWithMapping(Class, String, int)} instead */ public FilterHolder addFilter (String className,String pathSpec,int dispatches) { @@ -1336,7 +1333,7 @@ public class ServletHandler extends ScopedHandler * this method. * * @param servlet - * @return + * @return the potentially customized servlet * @throws Exception */ public Servlet customizeServlet (Servlet servlet) @@ -1361,7 +1358,7 @@ public class ServletHandler extends ScopedHandler * this method. * * @param filter - * @return + * @return the potentially customized filter * @throws Exception */ public Filter customizeFilter (Filter filter) diff --git a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHolder.java b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHolder.java index c6546643fac..f90d5799785 100644 --- a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHolder.java +++ b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletHolder.java @@ -469,9 +469,6 @@ public class ServletHolder extends Holder implements UserIdentity.Scope, Compara } /* ------------------------------------------------------------ */ - /** - * @see org.eclipse.jetty.server.UserIdentity.Scope#getRunAsRole() - */ public String getRunAsRole() { return _runAsRole; diff --git a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletMapping.java b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletMapping.java index 80e8d802c1a..b0c908e7373 100644 --- a/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletMapping.java +++ b/jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletMapping.java @@ -28,7 +28,7 @@ public class ServletMapping /* ------------------------------------------------------------ */ /** - * @return Returns the pathSpec. + * @return Returns the pathSpecs. */ public String[] getPathSpecs() { @@ -46,7 +46,7 @@ public class ServletMapping /* ------------------------------------------------------------ */ /** - * @param pathSpec The pathSpec to set. + * @param pathSpecs The pathSpecs to set. */ public void setPathSpecs(String[] pathSpecs) { diff --git a/jetty-servlets/src/main/java/org/eclipse/jetty/servlets/QoSFilter.java b/jetty-servlets/src/main/java/org/eclipse/jetty/servlets/QoSFilter.java index a726412b30b..21b6843c2ce 100644 --- a/jetty-servlets/src/main/java/org/eclipse/jetty/servlets/QoSFilter.java +++ b/jetty-servlets/src/main/java/org/eclipse/jetty/servlets/QoSFilter.java @@ -220,7 +220,7 @@ public class QoSFilter implements Filter * This method may be specialised to provide application specific priorities. * * @param request - * @return + * @return the request priority */ protected int getPriority(ServletRequest request) { diff --git a/jetty-util/src/main/java/org/eclipse/jetty/util/ajax/JSON.java b/jetty-util/src/main/java/org/eclipse/jetty/util/ajax/JSON.java index f0249d1a993..f04650fb9e6 100644 --- a/jetty-util/src/main/java/org/eclipse/jetty/util/ajax/JSON.java +++ b/jetty-util/src/main/java/org/eclipse/jetty/util/ajax/JSON.java @@ -60,11 +60,11 @@ import org.eclipse.jetty.util.log.Log; *

    * The interface {@link JSON.Generator} may be implemented by classes that know how to render themselves as JSON and * the {@link #toString(Object)} method will use {@link JSON.Generator#addJSON(StringBuffer)} to generate the JSON. - * The class {@link JSON.Literal} may be used to hold pre-gnerated JSON object. + * The class {@link JSON.Literal} may be used to hold pre-generated JSON object. *

    - * The interface {@link Convertor} may be implemented to provide static convertors for objects that may be registered - * with {@link #registerConvertor(Class, org.eclipse.jetty.util.ajax.JSON.Convertor)}. These convertors are looked up by class, interface and - * super class by {@link #getConvertor(Class)}. + * The interface {@link JSON.Convertor} may be implemented to provide static convertors for objects that may be registered + * with {@link #registerConvertor(Class, org.eclipse.jetty.util.ajax.JSON.Convertor)}. + * These convertors are looked up by class, interface and super class by {@link #getConvertor(Class)}. *

    * * @@ -569,7 +569,7 @@ public class JSON * If no match is found for the class, then the interfaces for the class are tried. If still no * match is found, then the super class and it's interfaces are tried recursively. * @param forClass The class - * @return a {@link Convertor} or null if none were found. + * @return a {@link JSON.Convertor} or null if none were found. */ protected Convertor getConvertor(Class forClass) { @@ -595,7 +595,7 @@ public class JSON /* ------------------------------------------------------------ */ /** - * Register a {@link Convertor} for a named class or interface. + * Register a {@link JSON.Convertor} for a named class or interface. * @param name name of a class or an interface that the convertor applies to * @param convertor the convertor */ @@ -609,7 +609,7 @@ public class JSON * Lookup a convertor for a named class. * * @param name name of the class - * @return a {@link Convertor} or null if none were found. + * @return a {@link JSON.Convertor} or null if none were found. */ public Convertor getConvertorFor(String name) { diff --git a/jetty-util/src/main/java/org/eclipse/jetty/util/thread/ExecutorThreadPool.java b/jetty-util/src/main/java/org/eclipse/jetty/util/thread/ExecutorThreadPool.java index bcc3114dc27..c00a3cb1fe2 100644 --- a/jetty-util/src/main/java/org/eclipse/jetty/util/thread/ExecutorThreadPool.java +++ b/jetty-util/src/main/java/org/eclipse/jetty/util/thread/ExecutorThreadPool.java @@ -30,7 +30,7 @@ import org.eclipse.jetty.util.log.Log; /** * Jetty ThreadPool using java 5 ThreadPoolExecutor * This class wraps a {@link ExecutorService} as a {@link ThreadPool} and - * {@link LifeCycle} interfaces so that it may be used by the Jetty {@link org.eclipse.jetty.server.Server} + * {@link LifeCycle} interfaces so that it may be used by the Jetty org.eclipse.jetty.server.Server */ public class ExecutorThreadPool extends AbstractLifeCycle implements ThreadPool, LifeCycle { diff --git a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/JarScanner.java b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/JarScanner.java index c51c50a87f9..02fde5d6144 100644 --- a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/JarScanner.java +++ b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/JarScanner.java @@ -65,7 +65,7 @@ public abstract class JarScanner extends org.eclipse.jetty.util.PatternMatcher * all those starting with "aaa-" first, then "bbb-". * * @param pattern - * @param loader + * @param uris * @param isNullInclusive if true, an empty pattern means all names match, if false, none match * @throws Exception */ diff --git a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebAppClassLoader.java b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebAppClassLoader.java index 59bebfdc0bc..e775e5f3247 100644 --- a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebAppClassLoader.java +++ b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebAppClassLoader.java @@ -38,11 +38,11 @@ import org.eclipse.jetty.util.resource.Resource; * Specializes URLClassLoader with some utility and file mapping * methods. * - * This loader defaults to the 2.3 servlet spec behaviour where non + * This loader defaults to the 2.3 servlet spec behavior where non * system classes are loaded from the classpath in preference to the * parent loader. Java2 compliant loading, where the parent loader * always has priority, can be selected with the - * {@link org.eclipse.jetty.server.server.webapp.WebAppContext#setParentLoaderPriority(boolean)} + * {@link org.eclipse.jetty.webapp.WebAppContext#setParentLoaderPriority(boolean)} * method and influenced with {@link WebAppContext#isServerClass(String)} and * {@link WebAppContext#isSystemClass(String)}. * @@ -180,9 +180,6 @@ public class WebAppClassLoader extends URLClassLoader /** Add elements to the class path for the context from the jar and zip files found * in the specified resource. * @param lib the resource that contains the jar and/or zip files. - * @param append true if the classpath entries are to be appended to any - * existing classpath, or false if they replace the existing classpath. - * @see #setClassPath(String) */ public void addJars(Resource lib) { diff --git a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebAppContext.java b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebAppContext.java index 40acf2ce12e..096b91b7464 100644 --- a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebAppContext.java +++ b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebAppContext.java @@ -50,8 +50,8 @@ import org.eclipse.jetty.util.resource.Resource; * {@link org.eclipse.jetty.security.ConstraintSecurityHandler}, {@link org.eclipse.jetty.server.session.SessionHandler} * and {@link org.eclipse.jetty.servlet.ServletHandler}. * The handlers are configured by pluggable configuration classes, with - * the default being {@link org.eclipse.jetty.server.server.webapp.WebXmlConfiguration} and - * {@link org.eclipse.jetty.server.server.webapp.JettyWebXmlConfiguration}. + * the default being {@link org.eclipse.jetty.webapp.WebXmlConfiguration} and + * {@link org.eclipse.jetty.webapp.JettyWebXmlConfiguration}. * * @org.apache.xbean.XBean description="Creates a servlet web application at a given context from a resource base" * @@ -301,7 +301,7 @@ public class WebAppContext extends ServletContextHandler *
  • Web Fragments
    • *
  • META-INF/resource directories
    • * - * @param servlet3autoConfig the servlet3autoConfig to set + * @param discovered true if configuration discovery is enabled for automatic configuration from the context */ public void setConfigurationDiscovered(boolean discovered) { diff --git a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebInfConfiguration.java b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebInfConfiguration.java index a7aaff85a01..eff43b51644 100644 --- a/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebInfConfiguration.java +++ b/jetty-webapp/src/main/java/org/eclipse/jetty/webapp/WebInfConfiguration.java @@ -216,8 +216,6 @@ public class WebInfConfiguration implements Configuration * contents if dir already exists. * * - * - * @return */ public void resolveTempDirectory (WebAppContext context) { @@ -527,7 +525,7 @@ public class WebInfConfiguration implements Configuration /** * Check if the tmpDir itself is called "work", or if the tmpDir * is in a directory called "work". - * @return + * @return true if File is a temporary or work directory */ public boolean isTempWorkDirectory (File tmpDir) { @@ -543,13 +541,13 @@ public class WebInfConfiguration implements Configuration /** - * Create a canonical name for a webapp tmp directory. + * Create a canonical name for a webapp temp directory. * The form of the name is: - * "Jetty_"+host+"_"+port+"__"+resourceBase+"_"+context+"_"+virtualhost+base36 hashcode of whole string + * "Jetty_"+host+"_"+port+"__"+resourceBase+"_"+context+"_"+virtualhost+base36_hashcode_of_whole_string * * host and port uniquely identify the server * context and virtual host uniquely identify the webapp - * @return + * @return the canonical name for the webapp temp directory */ public String getCanonicalNameForWebAppTmpDir (WebAppContext context) { @@ -640,7 +638,7 @@ public class WebInfConfiguration implements Configuration /** * Look for jars in WEB-INF/lib * @param context - * @return + * @return the list of jar resources found within context * @throws Exception */ protected List findJars (WebAppContext context)