Javadoc fixes
This commit is contained in:
parent
7f82124d54
commit
80675ce1d2
|
@ -57,6 +57,7 @@ public class ScopeBasicsTest
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Validation of Scope / Inject logic on non-websocket-scoped classes
|
* Validation of Scope / Inject logic on non-websocket-scoped classes
|
||||||
|
* @throws Exception on test failure
|
||||||
*/
|
*/
|
||||||
@Test
|
@Test
|
||||||
public void testBasicBehavior() throws Exception
|
public void testBasicBehavior() throws Exception
|
||||||
|
|
|
@ -61,6 +61,7 @@ public class WebSocketScopeBaselineTest
|
||||||
* Test behavior of {@link WebSocketScope} in basic operation.
|
* Test behavior of {@link WebSocketScope} in basic operation.
|
||||||
* <p>
|
* <p>
|
||||||
* Food is declared as part of WebSocketScope, and as such, only 1 instance of it can exist.
|
* Food is declared as part of WebSocketScope, and as such, only 1 instance of it can exist.
|
||||||
|
* @throws Exception on test failure
|
||||||
*/
|
*/
|
||||||
@Test
|
@Test
|
||||||
public void testScopeBehavior() throws Exception
|
public void testScopeBehavior() throws Exception
|
||||||
|
|
|
@ -77,19 +77,12 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param server
|
|
||||||
*/
|
|
||||||
public InfinispanSessionIdManager(Server server)
|
public InfinispanSessionIdManager(Server server)
|
||||||
{
|
{
|
||||||
super();
|
super();
|
||||||
_server = server;
|
_server = server;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param server
|
|
||||||
* @param random
|
|
||||||
*/
|
|
||||||
public InfinispanSessionIdManager(Server server, Random random)
|
public InfinispanSessionIdManager(Server server, Random random)
|
||||||
{
|
{
|
||||||
super(random);
|
super(random);
|
||||||
|
@ -279,7 +272,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the cache.
|
* Get the cache.
|
||||||
* @return
|
* @return the cache
|
||||||
*/
|
*/
|
||||||
public BasicCache<String,Object> getCache()
|
public BasicCache<String,Object> getCache()
|
||||||
{
|
{
|
||||||
|
@ -288,7 +281,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the cache.
|
* Set the cache.
|
||||||
* @param cache
|
* @param cache the cache
|
||||||
*/
|
*/
|
||||||
public void setCache(BasicCache<String,Object> cache)
|
public void setCache(BasicCache<String,Object> cache)
|
||||||
{
|
{
|
||||||
|
@ -300,7 +293,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
/**
|
/**
|
||||||
* Do any operation to the session id in the cache to
|
* Do any operation to the session id in the cache to
|
||||||
* ensure its idle expiry time moves forward
|
* ensure its idle expiry time moves forward
|
||||||
* @param id
|
* @param id the session id
|
||||||
*/
|
*/
|
||||||
public void touch (String id)
|
public void touch (String id)
|
||||||
{
|
{
|
||||||
|
@ -312,8 +305,8 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
/**
|
/**
|
||||||
* Ask the cluster if a particular id exists.
|
* Ask the cluster if a particular id exists.
|
||||||
*
|
*
|
||||||
* @param id
|
* @param id the session id
|
||||||
* @return
|
* @return true if exists
|
||||||
*/
|
*/
|
||||||
protected boolean exists (String id)
|
protected boolean exists (String id)
|
||||||
{
|
{
|
||||||
|
@ -327,7 +320,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
/**
|
/**
|
||||||
* Put a session id into the cluster.
|
* Put a session id into the cluster.
|
||||||
*
|
*
|
||||||
* @param id
|
* @param id the session id
|
||||||
*/
|
*/
|
||||||
protected void insert (String id)
|
protected void insert (String id)
|
||||||
{
|
{
|
||||||
|
@ -341,7 +334,8 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
/**
|
/**
|
||||||
* Put a session id into the cluster with an idle expiry.
|
* Put a session id into the cluster with an idle expiry.
|
||||||
*
|
*
|
||||||
* @param id
|
* @param id the session id
|
||||||
|
* @param idleTimeOutSec idle timeout in seconds
|
||||||
*/
|
*/
|
||||||
protected void insert (String id, long idleTimeOutSec)
|
protected void insert (String id, long idleTimeOutSec)
|
||||||
{
|
{
|
||||||
|
@ -355,7 +349,7 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
/**
|
/**
|
||||||
* Remove a session id from the cluster.
|
* Remove a session id from the cluster.
|
||||||
*
|
*
|
||||||
* @param id
|
* @param id the session id
|
||||||
*/
|
*/
|
||||||
protected void delete (String id)
|
protected void delete (String id)
|
||||||
{
|
{
|
||||||
|
@ -370,8 +364,8 @@ public class InfinispanSessionIdManager extends AbstractSessionIdManager
|
||||||
/**
|
/**
|
||||||
* Generate a unique cache key from the session id.
|
* Generate a unique cache key from the session id.
|
||||||
*
|
*
|
||||||
* @param id
|
* @param id the session id
|
||||||
* @return
|
* @return unique cache id
|
||||||
*/
|
*/
|
||||||
protected String makeKey (String id)
|
protected String makeKey (String id)
|
||||||
{
|
{
|
||||||
|
|
|
@ -267,7 +267,7 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
/**
|
/**
|
||||||
* A new session.
|
* A new session.
|
||||||
*
|
*
|
||||||
* @param request
|
* @param request the request
|
||||||
*/
|
*/
|
||||||
protected Session (HttpServletRequest request)
|
protected Session (HttpServletRequest request)
|
||||||
{
|
{
|
||||||
|
@ -295,10 +295,10 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
/**
|
/**
|
||||||
* A restored session.
|
* A restored session.
|
||||||
*
|
*
|
||||||
* @param sessionId
|
* @param sessionId the session id
|
||||||
* @param created
|
* @param created time created
|
||||||
* @param accessed
|
* @param accessed time last accessed
|
||||||
* @param maxInterval
|
* @param maxInterval max expiry interval
|
||||||
*/
|
*/
|
||||||
protected Session (String sessionId, long created, long accessed, long maxInterval)
|
protected Session (String sessionId, long created, long accessed, long maxInterval)
|
||||||
{
|
{
|
||||||
|
@ -406,8 +406,8 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Test if the session is stale
|
/** Test if the session is stale
|
||||||
* @param atTime
|
* @param atTime time when stale
|
||||||
* @return
|
* @return true if stale
|
||||||
*/
|
*/
|
||||||
protected boolean isStale (long atTime)
|
protected boolean isStale (long atTime)
|
||||||
{
|
{
|
||||||
|
@ -416,7 +416,7 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
|
|
||||||
|
|
||||||
/** Test if the session is dirty
|
/** Test if the session is dirty
|
||||||
* @return
|
* @return true if dirty
|
||||||
*/
|
*/
|
||||||
protected boolean isDirty ()
|
protected boolean isDirty ()
|
||||||
{
|
{
|
||||||
|
@ -711,7 +711,7 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
* often.
|
* often.
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
* @param sec
|
* @param sec scavenge interval in seconds
|
||||||
*/
|
*/
|
||||||
public void setScavengeInterval (long sec)
|
public void setScavengeInterval (long sec)
|
||||||
{
|
{
|
||||||
|
@ -752,7 +752,7 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
/**
|
/**
|
||||||
* Get the clustered cache instance.
|
* Get the clustered cache instance.
|
||||||
*
|
*
|
||||||
* @return
|
* @return the cache
|
||||||
*/
|
*/
|
||||||
public BasicCache<String, Object> getCache()
|
public BasicCache<String, Object> getCache()
|
||||||
{
|
{
|
||||||
|
@ -764,7 +764,7 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
/**
|
/**
|
||||||
* Set the clustered cache instance.
|
* Set the clustered cache instance.
|
||||||
*
|
*
|
||||||
* @param cache
|
* @param cache the cache
|
||||||
*/
|
*/
|
||||||
public void setCache (BasicCache<String, Object> cache)
|
public void setCache (BasicCache<String, Object> cache)
|
||||||
{
|
{
|
||||||
|
@ -990,8 +990,8 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
/**
|
/**
|
||||||
* Load a session from the clustered cache.
|
* Load a session from the clustered cache.
|
||||||
*
|
*
|
||||||
* @param key
|
* @param key the session key
|
||||||
* @return
|
* @return the session
|
||||||
*/
|
*/
|
||||||
protected Session load (String key)
|
protected Session load (String key)
|
||||||
{
|
{
|
||||||
|
@ -1019,8 +1019,8 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
/**
|
/**
|
||||||
* Save or update the session to the cluster cache
|
* Save or update the session to the cluster cache
|
||||||
*
|
*
|
||||||
* @param session
|
* @param session the session
|
||||||
* @throws Exception
|
* @throws Exception if unable to save
|
||||||
*/
|
*/
|
||||||
protected void save (InfinispanSessionManager.Session session)
|
protected void save (InfinispanSessionManager.Session session)
|
||||||
throws Exception
|
throws Exception
|
||||||
|
@ -1053,7 +1053,7 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
/**
|
/**
|
||||||
* Remove the session from the cluster cache.
|
* Remove the session from the cluster cache.
|
||||||
*
|
*
|
||||||
* @param session
|
* @param session the session
|
||||||
*/
|
*/
|
||||||
protected void delete (InfinispanSessionManager.Session session)
|
protected void delete (InfinispanSessionManager.Session session)
|
||||||
{
|
{
|
||||||
|
@ -1067,7 +1067,7 @@ public class InfinispanSessionManager extends AbstractSessionManager
|
||||||
/**
|
/**
|
||||||
* Invalidate a session for this context with the given id
|
* Invalidate a session for this context with the given id
|
||||||
*
|
*
|
||||||
* @param idInCluster
|
* @param idInCluster session id in cluster
|
||||||
*/
|
*/
|
||||||
public void invalidateSession (String idInCluster)
|
public void invalidateSession (String idInCluster)
|
||||||
{
|
{
|
||||||
|
|
|
@ -564,7 +564,7 @@ public abstract class AbstractJettyMojo extends AbstractMojo
|
||||||
* Run a scanner thread on the given list of files and directories, calling
|
* Run a scanner thread on the given list of files and directories, calling
|
||||||
* stop/start on the given list of LifeCycle objects if any of the watched
|
* stop/start on the given list of LifeCycle objects if any of the watched
|
||||||
* files change.
|
* files change.
|
||||||
*
|
* @throws Exception if unable to start scanner
|
||||||
*/
|
*/
|
||||||
public void startScanner() throws Exception
|
public void startScanner() throws Exception
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in New Issue