more javadoc fixes #2056
Signed-off-by: olivier lamy <olamy@webtide.com>
This commit is contained in:
parent
942e819a7c
commit
e07ba49283
|
@ -60,7 +60,7 @@ public abstract class NamingEntry
|
||||||
*
|
*
|
||||||
* @param scope an object representing the scope of the name to be bound into jndi, where null means jvm scope.
|
* @param scope an object representing the scope of the name to be bound into jndi, where null means jvm scope.
|
||||||
* @param jndiName the name that will be associated with an object bound into jndi
|
* @param jndiName the name that will be associated with an object bound into jndi
|
||||||
* @throws NamingException
|
* @throws NamingException if jndiName is null
|
||||||
*/
|
*/
|
||||||
protected NamingEntry (Object scope, String jndiName)
|
protected NamingEntry (Object scope, String jndiName)
|
||||||
throws NamingException
|
throws NamingException
|
||||||
|
|
|
@ -107,9 +107,9 @@ public class HouseKeeper extends AbstractLifeCycle
|
||||||
* Get a scheduler. First try a common scheduler, failing that
|
* Get a scheduler. First try a common scheduler, failing that
|
||||||
* create our own.
|
* create our own.
|
||||||
*
|
*
|
||||||
* @throws Exception
|
* @throws Exception when the scheduler cannot be started
|
||||||
*/
|
*/
|
||||||
protected void findScheduler () throws Exception
|
protected void findScheduler() throws Exception
|
||||||
{
|
{
|
||||||
if (_scheduler == null)
|
if (_scheduler == null)
|
||||||
{
|
{
|
||||||
|
@ -133,9 +133,9 @@ public class HouseKeeper extends AbstractLifeCycle
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If scavenging is not scheduled, schedule it.
|
* If scavenging is not scheduled, schedule it.
|
||||||
* @throws Exception
|
* @throws Exception if any error during scheduling the scavenging
|
||||||
*/
|
*/
|
||||||
protected void startScavenging() throws Exception
|
protected void startScavenging() throws Exception
|
||||||
{
|
{
|
||||||
synchronized (this)
|
synchronized (this)
|
||||||
{
|
{
|
||||||
|
@ -155,7 +155,7 @@ public class HouseKeeper extends AbstractLifeCycle
|
||||||
/**
|
/**
|
||||||
* If scavenging is scheduled, stop it.
|
* If scavenging is scheduled, stop it.
|
||||||
*
|
*
|
||||||
* @throws Exception
|
* @throws Exception if any error during stopping the scavenging
|
||||||
*/
|
*/
|
||||||
protected void stopScavenging() throws Exception
|
protected void stopScavenging() throws Exception
|
||||||
{
|
{
|
||||||
|
@ -195,9 +195,9 @@ public class HouseKeeper extends AbstractLifeCycle
|
||||||
/**
|
/**
|
||||||
* Set the period between scavenge cycles
|
* Set the period between scavenge cycles
|
||||||
* @param sec the interval (in seconds)
|
* @param sec the interval (in seconds)
|
||||||
* @throws Exception
|
* @throws Exception if any error during restarting the scavenging
|
||||||
*/
|
*/
|
||||||
public void setIntervalSec (long sec) throws Exception
|
public void setIntervalSec(long sec) throws Exception
|
||||||
{
|
{
|
||||||
if (isStarted() || isStarting())
|
if (isStarted() || isStarting())
|
||||||
{
|
{
|
||||||
|
|
|
@ -54,7 +54,7 @@ public class JDBCSessionDataStoreFactory extends AbstractSessionDataStoreFactory
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param adaptor
|
* @param adaptor the {@link DatabaseAdaptor} to set
|
||||||
*/
|
*/
|
||||||
public void setDatabaseAdaptor (DatabaseAdaptor adaptor)
|
public void setDatabaseAdaptor (DatabaseAdaptor adaptor)
|
||||||
{
|
{
|
||||||
|
@ -63,7 +63,7 @@ public class JDBCSessionDataStoreFactory extends AbstractSessionDataStoreFactory
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param schema
|
* @param schema the {@link JDBCSessionDataStoreFactory} to set
|
||||||
*/
|
*/
|
||||||
public void setSessionTableSchema (JDBCSessionDataStore.SessionTableSchema schema)
|
public void setSessionTableSchema (JDBCSessionDataStore.SessionTableSchema schema)
|
||||||
{
|
{
|
||||||
|
|
|
@ -32,7 +32,7 @@ public class NullSessionCache extends AbstractSessionCache
|
||||||
{
|
{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param handler
|
* @param handler The SessionHandler related to this SessionCache
|
||||||
*/
|
*/
|
||||||
public NullSessionCache(SessionHandler handler)
|
public NullSessionCache(SessionHandler handler)
|
||||||
{
|
{
|
||||||
|
|
|
@ -1006,7 +1006,7 @@ public class SessionHandler extends ScopedHandler
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param cache
|
* @param cache the session store to use
|
||||||
*/
|
*/
|
||||||
public void setSessionCache (SessionCache cache)
|
public void setSessionCache (SessionCache cache)
|
||||||
{
|
{
|
||||||
|
@ -1294,7 +1294,7 @@ public class SessionHandler extends ScopedHandler
|
||||||
* configurable amount of time, or the session itself
|
* configurable amount of time, or the session itself
|
||||||
* has passed its expiry.
|
* has passed its expiry.
|
||||||
*
|
*
|
||||||
* @param session
|
* @param session the session
|
||||||
*/
|
*/
|
||||||
public void sessionInactivityTimerExpired (Session session)
|
public void sessionInactivityTimerExpired (Session session)
|
||||||
{
|
{
|
||||||
|
@ -1349,8 +1349,8 @@ public class SessionHandler extends ScopedHandler
|
||||||
*
|
*
|
||||||
* @param id identity of session to check
|
* @param id identity of session to check
|
||||||
*
|
*
|
||||||
* @return true if this manager knows about this id
|
* @return <code>true</code> if this manager knows about this id
|
||||||
* @throws Exception
|
* @throws Exception if any error occurred
|
||||||
*/
|
*/
|
||||||
public boolean isIdInUse(String id) throws Exception
|
public boolean isIdInUse(String id) throws Exception
|
||||||
{
|
{
|
||||||
|
|
|
@ -52,14 +52,14 @@ public class UnreadableSessionDataException extends Exception
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param id
|
* @param id the session id
|
||||||
* @param contextId
|
* @param sessionContext the sessionContext
|
||||||
* @param t
|
* @param t the cause of the exception
|
||||||
*/
|
*/
|
||||||
public UnreadableSessionDataException (String id, SessionContext contextId, Throwable t)
|
public UnreadableSessionDataException (String id, SessionContext sessionContext, Throwable t)
|
||||||
{
|
{
|
||||||
super ("Unreadable session "+id+" for "+contextId, t);
|
super ("Unreadable session "+id+" for "+sessionContext, t);
|
||||||
_sessionContext = contextId;
|
_sessionContext = sessionContext;
|
||||||
_id = id;
|
_id = id;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -833,6 +833,9 @@ public class ServletHandler extends ScopedHandler
|
||||||
/* ------------------------------------------------------------ */
|
/* ------------------------------------------------------------ */
|
||||||
/**
|
/**
|
||||||
* Create a new CachedChain
|
* Create a new CachedChain
|
||||||
|
* @param filters a collection of {@link FilterHolder}
|
||||||
|
* @param servletHolder the servletHolder
|
||||||
|
* @return a new {@link CachedChain} instance
|
||||||
*/
|
*/
|
||||||
public CachedChain newCachedChain(List<FilterHolder> filters, ServletHolder servletHolder)
|
public CachedChain newCachedChain(List<FilterHolder> filters, ServletHolder servletHolder)
|
||||||
{
|
{
|
||||||
|
@ -1590,7 +1593,7 @@ public class ServletHandler extends ScopedHandler
|
||||||
/* ------------------------------------------------------------ */
|
/* ------------------------------------------------------------ */
|
||||||
/**
|
/**
|
||||||
* @param filters list of {@link FilterHolder} objects
|
* @param filters list of {@link FilterHolder} objects
|
||||||
* @param servletHolder
|
* @param servletHolder the current {@link ServletHolder}
|
||||||
*/
|
*/
|
||||||
protected CachedChain(List<FilterHolder> filters, ServletHolder servletHolder)
|
protected CachedChain(List<FilterHolder> filters, ServletHolder servletHolder)
|
||||||
{
|
{
|
||||||
|
|
|
@ -113,7 +113,7 @@ public class MetaInfConfiguration extends AbstractConfiguration
|
||||||
* @param context the context for the scan
|
* @param context the context for the scan
|
||||||
* @param jars the jars to scan
|
* @param jars the jars to scan
|
||||||
* @param useCaches if true, the scanned info is cached
|
* @param useCaches if true, the scanned info is cached
|
||||||
* @throws Exception
|
* @throws Exception if unable to scan the jars
|
||||||
*/
|
*/
|
||||||
public void scanJars (final WebAppContext context, Collection<Resource> jars, boolean useCaches)
|
public void scanJars (final WebAppContext context, Collection<Resource> jars, boolean useCaches)
|
||||||
throws Exception
|
throws Exception
|
||||||
|
|
|
@ -177,7 +177,7 @@ public class WebInfConfiguration extends AbstractConfiguration
|
||||||
* look at the java.class.path, and the jdk.module.path.
|
* look at the java.class.path, and the jdk.module.path.
|
||||||
*
|
*
|
||||||
* @param context the WebAppContext being deployed
|
* @param context the WebAppContext being deployed
|
||||||
* @throws Exception
|
* @throws Exception if unable to apply optional filtering on the container's classpath
|
||||||
*/
|
*/
|
||||||
public void findAndFilterContainerPaths (final WebAppContext context)
|
public void findAndFilterContainerPaths (final WebAppContext context)
|
||||||
throws Exception
|
throws Exception
|
||||||
|
@ -287,7 +287,7 @@ public class WebInfConfiguration extends AbstractConfiguration
|
||||||
* all jars are considered selected.
|
* all jars are considered selected.
|
||||||
*
|
*
|
||||||
* @param context the WebAppContext being deployed
|
* @param context the WebAppContext being deployed
|
||||||
* @throws Exception
|
* @throws Exception if unable to find the jars or apply filtering
|
||||||
*/
|
*/
|
||||||
public void findAndFilterWebAppPaths (WebAppContext context)
|
public void findAndFilterWebAppPaths (WebAppContext context)
|
||||||
throws Exception
|
throws Exception
|
||||||
|
|
Loading…
Reference in New Issue