Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

309185 - Fix the over 300 Javadoc warnings 

git-svn-id: svn+ssh://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk@1626 7e9141cc-0065-0410-87d8-b60c137991c4
This commit is contained in:
Joakim Erdfelt 2010-04-29 23:03:04 +00:00
parent 5cc3068e70
commit 6bc437c298
54 changed files with 126 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/FileServerXml.java
View File

@ -10,7 +10,8 @@ import org.eclipse.jetty.xml.XmlConfiguration;
* This server is identical to {@link FileServer}, except that it
* is configured via an {@link XmlConfiguration} config file that
* does the identical work.
* @see http://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk/example-jetty-embedded/src/main/resources/fileserver.xml
* <p>
* See <a href="http://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk/example-jetty-embedded/src/main/resources/fileserver.xml">fileserver.xml</a>
*/
public class FileServerXml
{

2
example-jetty-embedded/src/main/java/org/eclipse/jetty/embedded/ManyHandlers.java
View File

@ -50,7 +50,7 @@ import org.eclipse.jetty.util.ajax.JSON;
* <li>{@link HandlerWrapper} which will nest one handler inside another. In
* this example, the HelloHandler is nested inside a HandlerWrapper that sets
* the greeting as a request attribute.
* <li>{@link ListHandler} which will call a collection of handlers until the
* <li>{@link HandlerList} which will call a collection of handlers until the
* request is marked as handled. In this example, a list is used to combine the
* param handler (which only handles the request if there are parameters) and
* the wrapper handler. Frequently handler lists are terminated with the

1
jetty-annotations/src/main/java/org/eclipse/jetty/annotations/AnnotationParser.java
View File

@ -499,7 +499,6 @@ public class AnnotationParser
* Only class files in jar files will be scanned.
* @param loader
* @param visitParents
* @param jarNamePattern
* @param nullInclusive
* @param resolver
* @throws Exception

4
jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ClassNameResolver.java
View File

@ -21,7 +21,7 @@ public interface ClassNameResolver
* Based on the execution context, should the class represented
* by "name" be excluded from consideration?
* @param name
* @return
* @return true if classname is excluded
*/
public boolean isExcluded (String name);
@ -31,7 +31,7 @@ public interface ClassNameResolver
* represented by "name" is detected, should the existing
* one be overridden or not?
* @param name
* @return
* @return true if name should be overridden
*/
public boolean shouldOverride (String name);
}

1
jetty-annotations/src/main/java/org/eclipse/jetty/annotations/ResourceAnnotationHandler.java
View File

@ -187,7 +187,6 @@ public class ResourceAnnotationHandler implements AnnotationHandler
*
* This will generate a JNDI entry, and an Injection to be
* processed when an instance of the class is created.
* @param injections
*/
public void handleMethod(String className, String methodName, int access, String desc, String signature, String[] exceptions, String annotation,
List<Value> values)

14
jetty-annotations/src/main/java/org/eclipse/jetty/annotations/Util.java
View File

@ -21,8 +21,6 @@ import org.objectweb.asm.Type;
/**
* Util
*
*
*/
public class Util
{
@ -37,8 +35,16 @@ public class Util
/**
* Check if the presented method belongs to a class that is one
* of the classes with which a servlet container should be concerned.
* @param m
* @return
* @param c
* @return true if class is a type of one of the following:
* ({@link javax.servlet.Servlet},
* {@link javax.servlet.Filter},
* {@link javax.servlet.ServletContextListener},
* {@link javax.servlet.ServletContextAttributeListener},
* {@link javax.servlet.ServletRequestListener},
* {@link javax.servlet.ServletRequestAttributeListener},
* {@link javax.servlet.http.HttpSessionListener},
* {@link javax.servlet.http.HttpSessionAttributeListener})
*/
public static boolean isServletType (Class c)
{

13
jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java
View File

@ -75,11 +75,8 @@ import org.eclipse.jetty.util.thread.Timeout;
* be allocated from a destination, so that multiple request sources are not multiplexed
* over the same connection.
*
*
*
*
* @see {@link HttpExchange}
* @see {@link HttpDestination}
* @see HttpExchange
* @see HttpDestination
*/
public class HttpClient extends HttpBuffers implements Attributes
{
@ -212,10 +209,6 @@ public class HttpClient extends HttpBuffers implements Attributes
}
/* ------------------------------------------------------------ */
/**
* @param name
* @return
*/
public void clearAttributes()
{
_attributes.clearAttributes();
@ -287,7 +280,7 @@ public class HttpClient extends HttpBuffers implements Attributes
/**
* returns the SecurityRealmResolver reg_realmResolveristered with the HttpClient or null
*
* @return
* @return the SecurityRealmResolver reg_realmResolveristered with the HttpClient or null
*/
public RealmResolver getRealmResolver()
{

6
jetty-client/src/main/java/org/eclipse/jetty/client/HttpExchange.java
View File

@ -54,8 +54,8 @@ import org.eclipse.jetty.util.log.Log;
* see {@link org.eclipse.jetty.client.ContentExchange} and {@link org.eclipse.jetty.client.CachedExchange}.</p>
*
* <p>Typically the HttpExchange is passed to the {@link HttpClient#send(HttpExchange)} method, which in
* turn selects a {@link HttpDestination} and calls its {@link HttpDestination#send(HttpExchange), which
* then creates or selects a {@link HttpConnection} and calls its {@link HttpConnection#send(HttpExchange).
* turn selects a {@link HttpDestination} and calls its {@link HttpDestination#send(HttpExchange)}, which
* then creates or selects a {@link HttpConnection} and calls its {@link HttpConnection#send(HttpExchange)}.
* A developer may wish to directly call send on the destination or connection if they wish to bypass
* some handling provided (eg Cookie handling in the HttpDestination).</p>
*
@ -130,7 +130,7 @@ public class HttpExchange
* || onExpire
* || onRequestComplete && onResponseComplete
* </pre>
* @return
* @return the done status
* @throws InterruptedException
*/
public int waitForDone () throws InterruptedException

12
jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java
View File

@ -27,10 +27,10 @@ import javax.servlet.ServletResponseWrapper;
* A continuation is a mechanism by which a HTTP Request can be suspended and
* restarted after a timeout or an asynchronous event has occurred.
* <p>
* The continuation mechanism is a portable mechansim that will work
* asychronously without additional configuration of all jetty-7,
* The continuation mechanism is a portable mechanism that will work
* asynchronously without additional configuration of all jetty-7,
* jetty-8 and Servlet 3.0 containers. With the addition of
* the {@link ContinuationFilter}, the mechansism will also work
* the {@link ContinuationFilter}, the mechanism will also work
* asynchronously on jetty-6 and non-asynchronously on any
* servlet 2.5 container.
* <p>
@ -121,7 +121,7 @@ import javax.servlet.ServletResponseWrapper;
* <h1>Continuation Timeout</h1>
* <p>
* If a continuation is suspended, but neither {@link #complete()} or {@link #resume()} is
* called during the period set by {@link #setTimeout()}, then the continuation will
* called during the period set by {@link #setTimeout(long)}, then the continuation will
* expire and {@link #isExpired()} will return true.
* </p>
* <p>
@ -245,7 +245,7 @@ public interface Continuation
* within the filter chain and/or servlet service method), then the resume
* does not take effect until the call to the filter chain and/or servlet
* returns to the container. In this case both {@link #isSuspended()} and
* {@link isResumed()} return true. Multiple calls to resume are ignored.
* {@link #isResumed()} return true. Multiple calls to resume are ignored.
* </p>
* <p>
* Typically resume() is used after a call to {@link #suspend()} with
@ -276,7 +276,7 @@ public interface Continuation
* within the filter chain and/or servlet service method), then the complete
* does not take effect until the call to the filter chain and/or servlet
* returns to the container. In this case both {@link #isSuspended()} and
* {@link isResumed()} return true.
* {@link #isResumed()} return true.
* </p>
*
* <p>

17
jetty-http/src/main/java/org/eclipse/jetty/http/HttpParser.java
View File

@ -26,18 +26,6 @@ import org.eclipse.jetty.io.BufferCache.CachedBuffer;
import org.eclipse.jetty.util.StringUtil;
import org.eclipse.jetty.util.log.Log;
/* ------------------------------------------------------------------------------- */
/**
*
*/
/* ------------------------------------------------------------ */
/**
*/
/* ------------------------------------------------------------ */
/**
*/
public class HttpParser implements Parser
{
// States
@ -110,8 +98,9 @@ public class HttpParser implements Parser
/* ------------------------------------------------------------------------------- */
/**
* Constructor.
* @param headerBufferSize size in bytes of header buffer
* @param contentBufferSize size in bytes of content buffer
* @param buffers the buffers to use
* @param endp the endpoint
* @param handler the even handler
*/
public HttpParser(Buffers buffers, EndPoint endp, EventHandler handler)
{

10
jetty-http/src/main/java/org/eclipse/jetty/http/HttpStatus.java
View File

@ -256,7 +256,7 @@ import org.eclipse.jetty.util.TypeUtil;
* </tr>
*
* <tr>
* <td>{@link #BAD_REQUEST}</td>
* <td>{@link #BAD_REQUEST_400}</td>
* <td>400</td>
* <td>Bad Request</td>
* <td>
@ -266,7 +266,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #UNAUTHORIZED}</td>
* <td>{@link #UNAUTHORIZED_401}</td>
* <td>401</td>
* <td>Unauthorized</td>
* <td>
@ -276,7 +276,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #PAYMENT_REQUIRED}</td>
* <td>{@link #PAYMENT_REQUIRED_402}</td>
* <td>402</td>
* <td>Payment Required</td>
* <td>
@ -286,7 +286,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link #FORBIDDEN}</td>
* <td>{@link #FORBIDDEN_403}</td>
* <td>403</td>
* <td>Forbidden</td>
* <td>
@ -504,7 +504,7 @@ import org.eclipse.jetty.util.TypeUtil;
* <a href="http://tools.ietf.org/html/rfc2518#section-10.3">Sec. 10.3</a></td>
* </tr>
* <tr>
* <td>{@link #LOCKED}</td>
* <td>{@link #LOCKED_423}</td>
* <td>423</td>
* <td>Locked</td>
* <td>&nbsp;</td>

2
jetty-io/src/main/java/org/eclipse/jetty/io/nio/SelectorManager.java
View File

@ -99,7 +99,6 @@ public abstract class SelectorManager extends AbstractLifeCycle
/** Register a channel
* @param channel
* @param att Attached Object
* @throws IOException
*/
public void register(SocketChannel channel, Object att)
{
@ -121,7 +120,6 @@ public abstract class SelectorManager extends AbstractLifeCycle
/* ------------------------------------------------------------ */
/** Register a {@link ServerSocketChannel}
* @param acceptChannel
* @throws IOException
*/
public void register(ServerSocketChannel acceptChannel)
{

2
jetty-jndi/src/main/java/org/eclipse/jetty/jndi/ContextFactory.java
View File

@ -151,7 +151,7 @@ public class ContextFactory implements ObjectFactory
* Keep trying ancestors of the given classloader to find one to which
* the context is bound.
* @param loader
* @return
* @return the context from the parent class loader
*/
public Context getParentClassLoaderContext (ClassLoader loader)
{

4
jetty-jndi/src/main/java/org/eclipse/jetty/jndi/NamingUtil.java
View File

@ -41,11 +41,11 @@ public class NamingUtil
/* ------------------------------------------------------------ */
/**
* Bind an object to a context ensuring all subcontexts
* Bind an object to a context ensuring all sub-contexts
* are created if necessary
*
* @param ctx the context into which to bind
* @param name the name relative to context to bind
* @param nameStr the name relative to context to bind
* @param obj the object to be bound
* @exception NamingException if an error occurs
*/

2
jetty-jndi/src/main/java/org/eclipse/jetty/jndi/factories/MailSessionReference.java
View File

@ -111,7 +111,7 @@ public class MailSessionReference extends Reference implements ObjectFactory
* @param arg1 not used
* @param arg2 not used
* @param arg3 not used
* @return
* @return the object found
* @throws Exception
*/
public Object getObjectInstance(Object ref, Name arg1, Context arg2, Hashtable arg3) throws Exception

5
jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/Injection.java
View File

@ -183,7 +183,6 @@ public class Injection
/**
* Inject a value for a Resource from JNDI into an object
* @param injectable
* @throws Exception
*/
public void inject (Object injectable)
{
@ -214,8 +213,8 @@ public class Injection
/**
* The Resource must already exist in the ENC of this webapp.
* @return
* @throws Exception
* @return the injected valud
* @throws NamingException
*/
public Object lookupInjectedValue ()
throws NamingException

2
jetty-plus/src/main/java/org/eclipse/jetty/plus/annotation/LifeCycleCallback.java
View File

@ -122,7 +122,7 @@ public abstract class LifeCycleCallback
* @param clazz the class under inspection
* @param methodName the method to find
* @param checkInheritance false on first entry, true if a superclass is being introspected
* @return
* @return the method
*/
public Method findMethod (Package pack, Class clazz, String methodName, boolean checkInheritance)
{

6
jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/AbstractLoginModule.java
View File

@ -165,7 +165,7 @@ public abstract class AbstractLoginModule implements LoginModule
/**
* @see javax.security.auth.spi.LoginModule#commit()
* @return
* @return true if committed, false if not (likely not authenticated)
* @throws LoginException
*/
public boolean commit() throws LoginException
@ -201,7 +201,7 @@ public abstract class AbstractLoginModule implements LoginModule
/**
* @see javax.security.auth.spi.LoginModule#login()
* @return
* @return true if is authenticated, false otherwise
* @throws LoginException
*/
public boolean login() throws LoginException
@ -252,7 +252,7 @@ public abstract class AbstractLoginModule implements LoginModule
/**
* @see javax.security.auth.spi.LoginModule#logout()
* @return
* @return true always
* @throws LoginException
*/
public boolean logout() throws LoginException

7
jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/DataSourceLoginModule.java
View File

@ -27,8 +27,7 @@ import javax.sql.DataSource;
* A LoginModule that uses a DataSource to retrieve user authentication
* and authorisation information.
*
* @see org.eclipse.jetty.server.server.plus.jaas.spi.JDBCLoginModule
*
* @see JDBCLoginModule
*/
public class DataSourceLoginModule extends AbstractDatabaseLoginModule
{
@ -68,8 +67,8 @@ public class DataSourceLoginModule extends AbstractDatabaseLoginModule
/**
* Get a connection from the DataSource
* @see org.eclipse.jetty.server.server.plus.jaas.spi.AbstractDatabaseLoginModule#getConnection()
* @return
* @see AbstractDatabaseLoginModule#getConnection()
* @return the connection for the datasource
* @throws Exception
*/
public Connection getConnection ()

12
jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/JDBCLoginModule.java
View File

@ -36,13 +36,9 @@ import org.eclipse.jetty.util.log.Log;
*
* <p><h4>Usage</h4>
* <pre>
*/
/*
* </pre>
*
* @see
* @version 1.0 Tue Apr 15 2003
*
*/
public class JDBCLoginModule extends AbstractDatabaseLoginModule
{
@ -52,14 +48,10 @@ public class JDBCLoginModule extends AbstractDatabaseLoginModule
private String dbPassword;
/**
* Get a connection from the DriverManager
* @see org.eclipse.jetty.server.server.plus.jaas.spi.AbstractDatabaseLoginModule#getConnection()
* @return
* @see AbstractDatabaseLoginModule#getConnection()
* @return the connection for this datasource
* @throws Exception
*/
public Connection getConnection ()

12
jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/LdapLoginModule.java
View File

@ -182,7 +182,7 @@ public class LdapLoginModule extends AbstractLoginModule
* roles are also an optional concept if required
*
* @param username
* @return
* @return the userinfo for the username
* @throws Exception
*/
public UserInfo getUserInfo(String username) throws Exception
@ -367,7 +367,7 @@ public class LdapLoginModule extends AbstractLoginModule
* then we try a binding authentication check, otherwise if we have the users encoded password then
* we can try authentication via that mechanic
*
* @return
* @return true if authenticated, false otherwise
* @throws LoginException
*/
public boolean login() throws LoginException
@ -451,13 +451,13 @@ public class LdapLoginModule extends AbstractLoginModule
/**
* binding authentication check
* This methode of authentication works only if the user branch of the DIT (ldap tree)
* has an ACI (acces control instruction) that allow the access to any user or at least
* This method of authentication works only if the user branch of the DIT (ldap tree)
* has an ACI (access control instruction) that allow the access to any user or at least
* for the user that logs in.
*
* @param username
* @param password
* @return
* @return true always
* @throws LoginException
*/
public boolean bindingLogin(String username, Object password) throws LoginException, NamingException
@ -610,7 +610,7 @@ public class LdapLoginModule extends AbstractLoginModule
/**
* get the context for connection
*
* @return
* @return the environment details for the context
*/
public Hashtable<Object, Object> getEnvironment()
{

1
jetty-plus/src/main/java/org/eclipse/jetty/plus/jaas/spi/PropertyFileLoginModule.java
View File

@ -141,7 +141,6 @@ public class PropertyFileLoginModule extends AbstractLoginModule
/**
* Don't implement this as we want to pre-fetch all of the
* users.
* @see org.eclipse.jetty.plus.jaas.spi.AbstractLoginModule#lazyLoadUser(java.lang.String)
* @param username
* @throws Exception
*/

6
jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntry.java
View File

@ -134,7 +134,7 @@ public abstract class NamingEntry
/**
* Get the unique name of the object
* relative to the scope
* @return
* @return the unique jndi name of the object
*/
public String getJndiName ()
{
@ -143,7 +143,7 @@ public abstract class NamingEntry
/**
* Get the object that is to be bound
* @return
* @return the object that is to be bound
*/
public Object getObjectToBind()
throws NamingException
@ -155,7 +155,7 @@ public abstract class NamingEntry
/**
* Get the name of the object, fully
* qualified with the scope
* @return
* @return the name of the object, fully qualified with the scope
*/
public String getJndiNameInScope ()
{

6
jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/NamingEntryUtil.java
View File

@ -41,9 +41,9 @@ public class NamingEntryUtil
* naming environment, or in the container's naming environment. Webapp's
* environment takes precedence over the server's namespace.
*
* @param scope the scope of the lookup
* @param asName the name to bind as
* @param mappedName the name from the environment to link to asName
* @param namingEntryType
* @throws NamingException
*/
public static boolean bindToENC (Object scope, String asName, String mappedName)
@ -72,7 +72,7 @@ public class NamingEntryUtil
*
* @param scope
* @param jndiName
* @return
* @return the naming entry for the given scope
* @throws NamingException
*/
public static NamingEntry lookupNamingEntry (Object scope, String jndiName)
@ -115,7 +115,7 @@ public class NamingEntryUtil
*
* @param scope
* @param clazz the type of the entry
* @return
* @return all NameEntries of a certain type in the given naming environment scope (server-wide names or context-specific names)
* @throws NamingException
*/
public static List lookupNamingEntries (Object scope, Class clazz)

9
jetty-plus/src/main/java/org/eclipse/jetty/plus/jndi/Transaction.java
View File

@ -27,13 +27,6 @@ import org.eclipse.jetty.util.log.Log;
* Transaction
*
* Class to represent a JTA UserTransaction impl.
*
*
*/
/**
* Transaction
*
*
*/
public class Transaction extends NamingEntry
{
@ -68,7 +61,7 @@ public class Transaction extends NamingEntry
* Allow other bindings of UserTransaction.
*
* These should be in ADDITION to java:comp/UserTransaction
* @see org.eclipse.jetty.server.server.plus.jndi.NamingEntry#bindToENC(java.lang.String)
* @see NamingEntry#bindToENC(java.lang.String)
*/
public void bindToENC (String localName)
throws NamingException

4
jetty-plus/src/main/java/org/eclipse/jetty/plus/servlet/ServletHandler.java
View File

@ -100,7 +100,7 @@ public class ServletHandler extends org.eclipse.jetty.servlet.ServletHandler
/**
* @see org.eclipse.jetty.servlet.servlet.ServletHandler#cusomizeFilterDestroy(javax.servlet.Filter)
* @see org.eclipse.jetty.servlet.ServletHandler#customizeFilterDestroy(Filter)
*/
public Filter customizeFilterDestroy(Filter filter) throws Exception
{
@ -112,7 +112,7 @@ public class ServletHandler extends org.eclipse.jetty.servlet.ServletHandler
/**
* @see org.eclipse.jetty.servlet.servlet.ServletHandler#customizeServletDestroy(javax.servlet.Servlet)
* @see org.eclipse.jetty.servlet.ServletHandler#customizeServletDestroy(Servlet)
*/
public Servlet customizeServletDestroy(Servlet servlet) throws Exception
{

1
jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/AbstractConfiguration.java
View File

@ -345,7 +345,6 @@ public abstract class AbstractConfiguration implements Configuration
* @param node
* @param jndiName
* @param valueClass
* @return the type of the injectable
*/
protected void initInjection (XmlParser.Node node, String jndiName, Class valueClass)
{

6
jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/Configuration.java
View File

@ -41,7 +41,7 @@ public class Configuration extends AbstractConfiguration
/**
* @see org.eclipse.jetty.plus.webapp.AbstractConfiguration#bindEnvEntry(java.lang.String, java.lang.String)
* @see AbstractConfiguration#bindEnvEntry(WebAppContext, String, Object)
* @param name
* @param value
* @throws Exception
@ -82,7 +82,7 @@ public class Configuration extends AbstractConfiguration
* If a resource reference with the same name is in a jetty-env.xml
* file, it will already have been bound.
*
* @see org.eclipse.jetty.plus.webapp.AbstractConfiguration#bindResourceRef(java.lang.String)
* @see AbstractConfiguration#bindResourceRef(WebAppContext, String, Class)
* @param name
* @throws Exception
*/
@ -93,7 +93,7 @@ public class Configuration extends AbstractConfiguration
}
/**
* @see org.eclipse.jetty.plus.webapp.AbstractConfiguration#bindResourceEnvRef(java.lang.String)
* @see AbstractConfiguration#bindResourceEnvRef(WebAppContext, String, Class)
* @param name
* @throws Exception
*/

4
jetty-plus/src/main/java/org/eclipse/jetty/plus/webapp/EnvConfiguration.java
View File

@ -53,7 +53,7 @@ public class EnvConfiguration implements Configuration
/**
* @see org.eclipse.jetty.webapp.Configuration#configureDefaults()
* @see Configuration#configure(WebAppContext)
* @throws Exception
*/
public void preConfigure (WebAppContext context) throws Exception
@ -108,7 +108,7 @@ public class EnvConfiguration implements Configuration
/**
* Remove all jndi setup
* @see org.eclipse.jetty.webapp.Configuration#deconfigureWebApp()
* @see Configuration#deconfigure(WebAppContext)
* @throws Exception
*/
public void deconfigure (WebAppContext context) throws Exception

6
jetty-plus/src/test/java/org/eclipse/jetty/plus/jndi/TestNamingEntries.java
View File

@ -74,7 +74,7 @@ public class TestNamingEntries extends TestCase
* @param arg1
* @param arg2
* @param arg3
* @return
* @return the object instance
* @throws Exception
*/
public Object getObjectInstance(Object arg0, Name arg1, Context arg2, Hashtable arg3) throws Exception
@ -106,7 +106,7 @@ public class TestNamingEntries extends TestCase
/**
* @see javax.naming.Referenceable#getReference()
* @return
* @return the reference
* @throws NamingException
*/
public Reference getReference() throws NamingException
@ -130,7 +130,7 @@ public class TestNamingEntries extends TestCase
* @param arg1
* @param arg2
* @param arg3
* @return
* @return the object instance
* @throws Exception
*/
public Object getObjectInstance(Object arg0, Name arg1, Context arg2, Hashtable arg3) throws Exception

2
jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java
View File

@ -72,7 +72,7 @@ public class HeaderPatternRule extends PatternRule
* the new value overwrites the previous one. Otherwise, it adds the new
* header name and value.
*
*@see org.eclipse.jetty.server.server.rewrite.handler.Rule#matchAndApply(String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*@see org.eclipse.jetty.rewrite.handler.Rule#matchAndApply(String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*/
public String apply(String target, HttpServletRequest request, HttpServletResponse response) throws IOException
{

4
jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java
View File

@ -26,7 +26,7 @@ import org.eclipse.jetty.server.handler.HandlerWrapper;
/* ------------------------------------------------------------ */
/**
*<p> Rewrite handler is responsible for managing the rules. Its capabilities
* is not only limited for url rewrites such as RewritePatternRule or RewriteRegexRule.
* is not only limited for URL rewrites such as RewritePatternRule or RewriteRegexRule.
* There is also handling for cookies, headers, redirection, setting status or error codes
* whenever the rule finds a match.
*
@ -283,7 +283,7 @@ public class RewriteHandler extends HandlerWrapper
/* ------------------------------------------------------------ */
/**
* @param originalPathAttribte If non null, this string will be used
* @param originalPathAttribute If non null, this string will be used
* as the attribute name to store the original request path.
*/
public void setOriginalPathAttribute(String originalPathAttribute)

2
jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/VirtualHostRuleContainer.java
View File

@ -52,7 +52,7 @@ public class VirtualHostRuleContainer extends RuleContainer
/* ------------------------------------------------------------ */
/** Get the virtual hosts that the rules within this container will apply to
* @param virtualHosts Array of virtual hosts that the rules within this container are applied to.
* @return Array of virtual hosts that the rules within this container are applied to.
* A null hostname or null/empty array means any hostname is acceptable.
*/
public String[] getVirtualHosts()

8
jetty-server/src/main/java/org/eclipse/jetty/server/AbstractConnector.java
View File

@ -777,7 +777,7 @@ public abstract class AbstractConnector extends HttpBuffers implements Connector
/* ------------------------------------------------------------ */
/**
* @param forwardedHostHeader
* @param forwardedServerHeader
* The header name for forwarded server (default
* x-forwarded-server)
*/
@ -794,12 +794,12 @@ public abstract class AbstractConnector extends HttpBuffers implements Connector
/* ------------------------------------------------------------ */
/**
* @param forwardedHostHeader
* @param forwardedRemoteAddressHeader
* The header name for forwarded for (default x-forwarded-for)
*/
public void setForwardedForHeader(String forwardedRemoteAddressHeade)
public void setForwardedForHeader(String forwardedRemoteAddressHeader)
{
_forwardedForHeader = forwardedRemoteAddressHeade;
_forwardedForHeader = forwardedRemoteAddressHeader;
}
/* ------------------------------------------------------------ */

2
jetty-server/src/main/java/org/eclipse/jetty/server/HttpOutput.java
View File

@ -28,7 +28,7 @@ import org.eclipse.jetty.util.ByteArrayOutputStream2;
/** Output.
*
* <p>
* Implements {@link javax.servlet.ServletOutputStream} from the {@link javax.servlet} package.
* Implements {@link javax.servlet.ServletOutputStream} from the <code>javax.servlet</code> package.
* </p>
* A {@link ServletOutputStream} implementation that writes content
* to a {@link AbstractGenerator}. The class is designed to be reused

6
jetty-server/src/main/java/org/eclipse/jetty/server/Request.java
View File

@ -72,15 +72,15 @@ import org.eclipse.jetty.util.log.Log;
/* ------------------------------------------------------------ */
/** Jetty Request.
* <p>
* Implements {@link javax.servlet.http.HttpServletRequest} from the {@link javax.servlet.http} package.
* Implements {@link javax.servlet.http.HttpServletRequest} from the <code>javax.servlet.http</code> package.
* </p>
* <p>
* The standard interface of mostly getters,
* is extended with setters so that the request is mutable by the handlers that it is
* passed to. This allows the request object to be as lightweight as possible and not
* actually implement any significant behaviour. For example<ul>
* actually implement any significant behavior. For example<ul>
*
* <li>The {@link Request#getContextPath()} method will return null, until the requeset has been
* <li>The {@link Request#getContextPath()} method will return null, until the request has been
* passed to a {@link ContextHandler} which matches the {@link Request#getPathInfo()} with a context
* path and calls {@link Request#setContextPath(String)} as a result.</li>
*

6
jetty-server/src/main/java/org/eclipse/jetty/server/Response.java
View File

@ -44,14 +44,10 @@ import org.eclipse.jetty.util.StringUtil;
import org.eclipse.jetty.util.URIUtil;
import org.eclipse.jetty.util.log.Log;
/* ------------------------------------------------------------ */
/** Response.
* <p>
* Implements {@link javax.servlet.HttpServletResponse} from the {@link javax.servlet} package.
* Implements {@link javax.servlet.http.HttpServletResponse} from the <code>javax.servlet.http</code> package.
* </p>
*
*
*
*/
public class Response implements HttpServletResponse
{

2
jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java
View File

@ -1434,7 +1434,7 @@ public class ContextHandler extends ScopedHandler implements Attributes, Server.
/** Context.
* <p>
* A partial implementation of {@link javax.servlet.ServletContext}.
* A complete implementation is provided by the derived {@link org.eclipse.jetty.servlet.ServletContextHandler.Context}.
* A complete implementation is provided by the derived {@link ContextHandler}.
* </p>
*
*

2
jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandlerCollection.java
View File

@ -266,8 +266,6 @@ public class ContextHandlerCollection extends HandlerCollection
/** Add a context handler.
* @param contextPath The context path to add
* @return the ContextHandler just added
* @throws IllegalAccessException
* @throws InstantiationException
*/
public ContextHandler addContext(String contextPath,String resourceBase)
{

2
jetty-server/src/main/java/org/eclipse/jetty/server/handler/HandlerList.java
View File

@ -24,7 +24,7 @@ import org.eclipse.jetty.server.Request;
/* ------------------------------------------------------------ */
/** HandlerList.
* This extension of {@link org.eclipse.jetty.server.server.handler.HandlerCollection} will call
* This extension of {@link HandlerCollection} will call
* each contained handler in turn until either an exception is thrown, the response
* is committed or a positive response status is set.
*/

2
jetty-server/src/main/java/org/eclipse/jetty/server/handler/ProxyHandler.java
View File

@ -32,7 +32,7 @@ import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.thread.ThreadPool;
/**
* <p>Implementation of a tunnelling proxy that supports HTTP CONNECT and transparent proxy.</p>
* <p>Implementation of a tunneling proxy that supports HTTP CONNECT and transparent proxy.</p>
* <p>To work as CONNECT proxy, objects of this class must be instantiated using the no-arguments
* constructor, since the remote server information will be present in the CONNECT URI.</p>
* <p>To work as transparent proxy, objects of this class must be instantiated using the string

2
jetty-server/src/main/java/org/eclipse/jetty/server/nio/SelectChannelConnector.java
View File

@ -262,7 +262,7 @@ public class SelectChannelConnector extends AbstractNIOConnector
* than {@link #getLowResourcesConnections()} connections. This allows the server to rapidly close idle connections
* in order to gracefully handle high load situations.
* @param lowResourcesMaxIdleTime the period in ms that a connection is allowed to be idle when resources are low.
* @see #setMaxIdleTime(long)
* @see #setMaxIdleTime(int)
*/
@Override
public void setLowResourcesMaxIdleTime(int lowResourcesMaxIdleTime)

12
jetty-server/src/main/java/org/eclipse/jetty/server/session/AbstractSessionManager.java
View File

@ -263,7 +263,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement
/* ------------------------------------------------------------ */
/**
* @see getSessionsMax()
* @see #getSessionsMax()
*/
@Deprecated
public int getMaxSessions()
@ -301,7 +301,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement
/* ------------------------------------------------------------ */
/**
* @see getSessionsMin()
* @deprecated always returns 0. no replacement available.
*/
@Deprecated
public int getMinSessions()
@ -367,7 +367,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement
/* ------------------------------------------------------------ */
/**
* @deprecated. Need to review if it is needed.
* @deprecated Need to review if it is needed.
*/
public abstract Map getSessionMap();
@ -448,7 +448,7 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement
/* ------------------------------------------------------------ */
/**
* @see statsReset()
* @see #statsReset()
*/
@Deprecated
public void resetStats()
@ -792,13 +792,11 @@ public abstract class AbstractSessionManager extends AbstractLifeCycle implement
public Session getSession();
}
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
/**
*
* <p>
* Implements {@link javax.servlet.HttpSession} from the {@link javax.servlet} package.
* Implements {@link javax.servlet.http.HttpSession} from the <code>javax.servlet</code> package.
* </p>
*
*

19
jetty-server/src/main/java/org/eclipse/jetty/server/session/HashSessionIdManager.java
View File

@ -48,6 +48,7 @@ public class HashSessionIdManager extends AbstractSessionIdManager
/* ------------------------------------------------------------ */
/** Get the session ID with any worker ID.
*
* @param clusterId
* @param request
* @return sessionId plus any worker ID.
*/
@ -66,7 +67,7 @@ public class HashSessionIdManager extends AbstractSessionIdManager
/* ------------------------------------------------------------ */
/** Get the session ID without any worker ID.
*
* @param request
* @param nodeId the node id
* @return sessionId without any worker ID.
*/
public String getClusterId(String nodeId)
@ -94,8 +95,8 @@ public class HashSessionIdManager extends AbstractSessionIdManager
}
/* ------------------------------------------------------------ */
/*
* @see org.eclipse.jetty.server.server.SessionManager.MetaManager#idInUse(java.lang.String)
/**
* @see SessionIdManager#idInUse(String)
*/
public boolean idInUse(String id)
{
@ -103,8 +104,8 @@ public class HashSessionIdManager extends AbstractSessionIdManager
}
/* ------------------------------------------------------------ */
/*
* @see org.eclipse.jetty.server.server.SessionManager.MetaManager#addSession(javax.servlet.http.HttpSession)
/**
* @see SessionIdManager#addSession(HttpSession)
*/
public void addSession(HttpSession session)
{
@ -112,8 +113,8 @@ public class HashSessionIdManager extends AbstractSessionIdManager
}
/* ------------------------------------------------------------ */
/*
* @see org.eclipse.jetty.server.server.SessionManager.MetaManager#addSession(javax.servlet.http.HttpSession)
/**
* @see SessionIdManager#removeSession(HttpSession)
*/
public void removeSession(HttpSession session)
{
@ -121,8 +122,8 @@ public class HashSessionIdManager extends AbstractSessionIdManager
}
/* ------------------------------------------------------------ */
/*
* @see org.eclipse.jetty.server.server.SessionManager.MetaManager#invalidateAll(java.lang.String)
/**
* @see SessionIdManager#invalidateAll(String)
*/
public void invalidateAll(String id)
{

2
jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionIdManager.java
View File

@ -112,7 +112,7 @@ public class JDBCSessionIdManager extends AbstractSessionIdManager
* depending on the way the db stores identifiers.
*
* @param identifier
* @return
* @return the converted identifier
*/
public String convertIdentifier (String identifier)
{

2
jetty-server/src/main/java/org/eclipse/jetty/server/session/JDBCSessionManager.java
View File

@ -440,7 +440,7 @@ public class JDBCSessionManager extends AbstractSessionManager
* This could be used eg with a JMS backplane to notify nodes
* that the session has changed and to delete the session from
* the node's cache, and re-read it from the database.
* @param idInCluster
* @param session
*/
public void cacheInvalidate (Session session)
{

1
jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSelectChannelConnector.java
View File

@ -471,7 +471,6 @@ public class SslSelectChannelConnector extends SelectChannelConnector implements
/* ------------------------------------------------------------ */
/**
* @throws Exception
* @see org.eclipse.jetty.server.ssl.SslConnector#setSslContext(javax.net.ssl.SSLContext)
*/
public SSLContext getSslContext()

9
jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java
View File

@ -557,7 +557,6 @@ public class SslSocketConnector extends SocketConnector implements SslConnector
/* ------------------------------------------------------------ */
/**
* @throws Exception
* @see org.eclipse.jetty.server.ssl.SslConnector#setSslContext(javax.net.ssl.SSLContext)
*/
public SSLContext getSslContext()
@ -578,7 +577,7 @@ public class SslSocketConnector extends SocketConnector implements SslConnector
/* ------------------------------------------------------------ */
/**
* Set the value of the _wantClientAuth property. This property is used when
* {@link #newServerSocket(SocketAddress, int) opening server sockets}.
* {@link #newServerSocket(String, int, int) opening server sockets}.
*
* @param wantClientAuth true iff we want client certificate authentication.
* @see SSLServerSocket#setWantClientAuth
@ -667,7 +666,8 @@ public class SslSocketConnector extends SocketConnector implements SslConnector
/* ------------------------------------------------------------ */
/**
* Unsupported.
* @see org.eclipse.jetty.server.ssl.SslConnector#getAlgorithm()
*
* @todo we should remove this as it is no longer an overridden method from SslConnector (like it was in the past)
*/
public String getAlgorithm()
{
@ -677,7 +677,8 @@ public class SslSocketConnector extends SocketConnector implements SslConnector
/* ------------------------------------------------------------ */
/**
* Unsupported.
* @see org.eclipse.jetty.server.ssl.SslConnector#setAlgorithm(java.lang.String)
*
* @todo we should remove this as it is no longer an overridden method from SslConnector (like it was in the past)
*/
public void setAlgorithm(String algorithm)
{

2
jetty-server/src/test/java/org/eclipse/jetty/server/CheckReverseProxyHeadersTest.java
View File

@ -24,7 +24,7 @@ import junit.framework.TestCase;
import org.eclipse.jetty.server.handler.AbstractHandler;
/**
* Test {@link AbstractConnector#checkForwardedHeaders(org.eclipse.io.EndPoint, Request)}.
* Test {@link AbstractConnector#checkForwardedHeaders(org.eclipse.jetty.io.EndPoint, Request)}.
*/
public class CheckReverseProxyHeadersTest extends TestCase
{

2
jetty-util/src/main/java/org/eclipse/jetty/util/Scanner.java
View File

@ -120,7 +120,7 @@ public class Scanner
/**
* Get the location of the directory to scan
* @return the first directory (of {@link #getScanDirs(List)} being scanned)
* @return the first directory (of {@link #getScanDirs()} being scanned)
* @deprecated use getScanDirs() instead
*/
@Deprecated

8
jetty-util/src/main/java/org/eclipse/jetty/util/UrlEncoded.java
View File

@ -241,7 +241,7 @@ public class UrlEncoded extends MultiMap
* @param raw the byte[] containing the encoded parameters
* @param offset the offset within raw to decode from
* @param length the length of the section to decode
* @param map the {@link MultiMap} to use for decoding
* @param map the {@link MultiMap} to populate
*/
public static void decodeUtf8To(byte[] raw,int offset, int length, MultiMap map)
{
@ -250,7 +250,11 @@ public class UrlEncoded extends MultiMap
/* -------------------------------------------------------------- */
/** Decoded parameters to Map.
* @param data the byte[] containing the encoded parameters
* @param raw the byte[] containing the encoded parameters
* @param offset the offset within raw to decode from
* @param length the length of the section to decode
* @param map the {@link MultiMap} to populate
* @param buffer the buffer to decode into
*/
public static void decodeUtf8To(byte[] raw,int offset, int length, MultiMap map,Utf8StringBuilder buffer)
{

3
jetty-util/src/main/java/org/eclipse/jetty/util/log/Logger.java
View File

@ -26,7 +26,6 @@ public interface Logger
/**
* Formats and logs at warn level.
* @param msg the formatting string
* @param arg the first argument
* @param args the optional arguments
*/
public void warn(String msg, Object... args);
@ -47,7 +46,6 @@ public interface Logger
/**
* Formats and logs at info level.
* @param msg the formatting string
* @param arg the first argument
* @param args the optional arguments
*/
public void info(String msg, Object... args);
@ -79,7 +77,6 @@ public interface Logger
/**
* Formats and logs at debug level.
* @param msg the formatting string
* @param arg the first argument
* @param args the optional arguments
*/
public void debug(String msg, Object... args);

6
jetty-util/src/main/java/org/eclipse/jetty/util/resource/JarFileResource.java
View File

@ -315,7 +315,7 @@ class JarFileResource extends JarResource
* Take a Resource that possibly might use URLConnection caching
* and turn it into one that doesn't.
* @param resource
* @return
* @return the non-caching resource
*/
public static Resource getNonCachingResource (Resource resource)
{
@ -331,9 +331,9 @@ class JarFileResource extends JarResource
/**
* Check if this jar:file: resource is contained in the
* named resource. Eg jar:file:///a/b/c/foo.jar!/x.html isContainedIn file:///a/b/c/foo.jar
* named resource. Eg <code>jar:file:///a/b/c/foo.jar!/x.html</code> isContainedIn <code>file:///a/b/c/foo.jar</code>
* @param resource
* @return
* @return true if resource is contained in the named resource
* @throws MalformedURLException
*/
@Override

4
jetty-util/src/main/java/org/eclipse/jetty/util/statistic/SampleStatistic.java
View File

@ -24,7 +24,7 @@ import java.util.concurrent.atomic.AtomicLong;
* deviation of continuous sequence of samples.
* <p>
* Calculates estimates of mean, variance, and standard deviation
* characteristics of a sample using a non synchronised
* characteristics of a sample using a non synchronized
* approximation of the on-line algorithm presented
* in Donald Knuth's Art of Computer Programming, Volume 2,
* Seminumerical Algorithms, 3rd edition, page 232,
@ -73,7 +73,7 @@ public class SampleStatistic
/* ------------------------------------------------------------ */
/**
* @return
* @return the max value
*/
public long getMax()
{