Fixing javadoc build errors

This commit is contained in:
Joakim Erdfelt 2016-03-25 11:18:00 -07:00
parent 5353aeb573
commit 5c896d88ec
14 changed files with 23 additions and 96 deletions

View File

@ -19,6 +19,9 @@
package org.eclipse.jetty.gcloud.session;
import com.google.gcloud.AuthCredentials;
import com.google.gcloud.datastore.DatastoreOptions;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
@ -28,9 +31,6 @@ import java.util.Properties;
import org.eclipse.jetty.util.security.Password;
import com.google.gcloud.AuthCredentials;
import com.google.gcloud.datastore.DatastoreOptions;
/**
@ -57,9 +57,9 @@ public class GCloudConfiguration
/**
* Generate a configuration from a properties file
*
* @param propsFile
* @return
* @throws IOException
* @param propsFile the properties filename
* @return the configuration
* @throws IOException if unable to read the properties file
*/
public static GCloudConfiguration fromFile(String propsFile)
throws IOException
@ -163,10 +163,6 @@ public class GCloudConfiguration
return _options;
}
/**
* @return
* @throws Exception
*/
public AuthCredentials getAuthCredentials()
throws Exception
{

View File

@ -110,35 +110,23 @@ public class GCloudSessionDataStore extends AbstractSessionDataStore
}
/**
* @param cfg
*/
public void setGCloudConfiguration (GCloudConfiguration cfg)
{
_config = cfg;
}
/**
* @return
*/
public GCloudConfiguration getGCloudConfiguration ()
{
return _config;
}
/**
* @return
*/
public int getMaxResults()
{
return _maxResults;
}
/**
* @param maxResults
*/
public void setMaxResults(int maxResults)
{
if (_maxResults <= 0)
@ -182,7 +170,7 @@ public class GCloudSessionDataStore extends AbstractSessionDataStore
}
/**
* @see org.eclipse.jetty.server.session.SessionDataStore#getExpired(Set, int)
* @see org.eclipse.jetty.server.session.SessionDataStore#getExpired(Set)
*/
@Override
public Set<String> doGetExpired(Set<String> candidates)
@ -382,9 +370,9 @@ public class GCloudSessionDataStore extends AbstractSessionDataStore
/**
* Generate SessionData from an Entity retrieved from gcloud datastore.
* @param entity
* @return
* @throws Exception
* @param entity the entity
* @return the session data
* @throws Exception if unable to get the entity
*/
private SessionData sessionFromEntity (Entity entity) throws Exception
{

View File

@ -52,9 +52,6 @@ public class GCloudSessionManager extends SessionManager
/**
* @return
*/
public GCloudSessionDataStore getSessionDataStore()
{
return _sessionDataStore;

View File

@ -26,7 +26,6 @@ import java.util.concurrent.atomic.AtomicReference;
import org.eclipse.jetty.server.SessionIdManager;
import org.eclipse.jetty.server.session.AbstractSessionDataStore;
import org.eclipse.jetty.server.session.SessionContext;
import org.eclipse.jetty.server.session.SessionData;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
@ -56,7 +55,7 @@ public class InfinispanSessionDataStore extends AbstractSessionDataStore
/**
* Get the clustered cache instance.
*
* @return
* @return the cache
*/
public BasicCache<String, Object> getCache()
{
@ -68,7 +67,7 @@ public class InfinispanSessionDataStore extends AbstractSessionDataStore
/**
* Set the clustered cache instance.
*
* @param cache
* @param cache the cache
*/
public void setCache (BasicCache<String, Object> cache)
{
@ -131,7 +130,7 @@ public class InfinispanSessionDataStore extends AbstractSessionDataStore
}
/**
* @see org.eclipse.jetty.server.session.SessionDataStore#getExpired(Set, int)
* @see org.eclipse.jetty.server.session.SessionDataStore#getExpired(Set)
*/
@Override
public Set<String> doGetExpired(Set<String> candidates)
@ -222,11 +221,6 @@ public class InfinispanSessionDataStore extends AbstractSessionDataStore
}
/**
* @param id
* @param context
* @return
*/
public String getCacheKey (String id)
{
return _context.getCanonicalContextPath()+"_"+_context.getVhost()+"_"+id;
@ -313,9 +307,6 @@ public class InfinispanSessionDataStore extends AbstractSessionDataStore
_infinispanIdleTimeoutSec = sec;
}
/**
* @return
*/
public int getInfinispanIdleTimeoutSec ()
{
return _infinispanIdleTimeoutSec;

View File

@ -80,9 +80,6 @@ public class InfinispanSessionManager extends SessionManager
/**
* @return
*/
public InfinispanSessionDataStore getSessionDataStore()
{
return _sessionDataStore;

View File

@ -345,7 +345,7 @@ public class MongoSessionDataStore extends NoSqlSessionDataStore
/**
* @see org.eclipse.jetty.server.session.SessionDataStore#getExpired(Set, int)
* @see org.eclipse.jetty.server.session.SessionDataStore#getExpired(Set)
*/
@Override
public Set<String> doGetExpired(Set<String> candidates)

View File

@ -22,7 +22,6 @@ import java.util.Set;
import javax.servlet.http.HttpServletRequest;
import org.eclipse.jetty.server.session.Session;
import org.eclipse.jetty.util.component.LifeCycle;
/**
@ -52,7 +51,7 @@ public interface SessionIdManager extends LifeCycle
/**
* Invalidate all sessions on all contexts that share the same id.
*
* @param id
* @param id the session id
*/
public void invalidateAll (String id);
@ -110,7 +109,7 @@ public interface SessionIdManager extends LifeCycle
/* ------------------------------------------------------------ */
/**
* Get the set of all session managers for this node
* @return
* @return the set of session managers
*/
public Set<SessionManager> getSessionManagers();
}

View File

@ -19,10 +19,8 @@
package org.eclipse.jetty.server.session;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Set;
import java.util.stream.Stream;
import javax.servlet.http.HttpServletRequest;
@ -60,9 +58,9 @@ public abstract class AbstractSessionStore extends AbstractLifeCycle implements
/**
* Create a new Session for a request.
*
* @param request
* @param data
* @return
* @param request the request
* @param data the session data
* @return the new session
*/
public abstract Session newSession (HttpServletRequest request, SessionData data);

View File

@ -432,9 +432,6 @@ public class DefaultSessionIdManager extends AbstractLifeCycle implements Sessio
}
/* ------------------------------------------------------------ */
/**
* @param id
*/
public void invalidateAll (String id)
{
//tell all contexts that may have a session object with this id to

View File

@ -112,7 +112,7 @@ public class FileSessionDataStore extends AbstractSessionDataStore
/**
* @see org.eclipse.jetty.server.session.SessionDataStore#getExpired(Set, int)
* @see org.eclipse.jetty.server.session.SessionDataStore#getExpired(Set)
*/
@Override
public Set<String> doGetExpired(final Set<String> candidates)
@ -336,10 +336,6 @@ public class FileSessionDataStore extends AbstractSessionDataStore
return ""+data.getExpiry()+"_"+getFileName(data.getId());
}
/**
* @param file
* @return
*/
private String getIdFromFile (File file)
{
if (file == null)
@ -349,10 +345,6 @@ public class FileSessionDataStore extends AbstractSessionDataStore
return name.substring(name.lastIndexOf('_')+1);
}
/**
* @param file
* @return
*/
private long getExpiryFromFile (File file)
{
if (file == null)
@ -367,9 +359,9 @@ public class FileSessionDataStore extends AbstractSessionDataStore
/**
* Find a File for the session id for the current context.
*
* @param storeDir
* @param id
* @return
* @param storeDir the session storage directory
* @param id the session id
* @return the file
*/
private File getFile (final File storeDir, final String id)
{

View File

@ -36,12 +36,10 @@ import javax.servlet.http.HttpSessionContext;
import javax.servlet.http.HttpSessionEvent;
import org.eclipse.jetty.io.IdleTimeout;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.thread.Locker;
import org.eclipse.jetty.util.thread.Locker.Lock;
import org.eclipse.jetty.util.thread.Scheduler;
@ -192,9 +190,6 @@ public class Session implements SessionManager.SessionIf
/* ------------------------------------------------------------- */
/**
* @param manager
*/
public void setSessionManager (SessionManager manager)
{
_manager = manager;
@ -202,9 +197,6 @@ public class Session implements SessionManager.SessionIf
/* ------------------------------------------------------------- */
/**
* @param extendedId
*/
public void setExtendedId (String extendedId)
{
_extendedId = extendedId;

View File

@ -57,15 +57,6 @@ public class SessionData implements Serializable
protected boolean _dirty;
protected long _lastSaved; //time in msec since last save
/**
* @param id
* @param cpath
* @param vhost
* @param created
* @param accessed
* @param lastAccessed
* @param maxInactiveMs
*/
public SessionData (String id, String cpath, String vhost, long created, long accessed, long lastAccessed, long maxInactiveMs)
{
_id = id;

View File

@ -808,9 +808,6 @@ public class SessionManager extends ContainerLifeCycle implements org.eclipse.je
}
/**
* @param store
*/
public void setSessionStore (SessionStore store)
{
_sessionStore = store;
@ -1140,9 +1137,6 @@ public class SessionManager extends ContainerLifeCycle implements org.eclipse.je
/* ------------------------------------------------------------ */
/**
* @return
*/
public Scheduler getScheduler()
{
return _scheduler;

View File

@ -18,8 +18,6 @@
package org.eclipse.jetty.server.session;
import java.util.stream.Stream;
import javax.servlet.SessionCookieConfig;
import javax.servlet.http.HttpServletRequest;
@ -41,9 +39,6 @@ public class SessionCookieTest
public class MockSessionStore extends AbstractSessionStore
{
/**
* @param manager
*/
public MockSessionStore(SessionManager manager)
{
super(manager);