more javadoc fixes #2056
Signed-off-by: olivier lamy <olamy@webtide.com>
This commit is contained in:
olivier lamy
parent
2a89f23a46
commit
1a49a6fb7e
|
|
@ -70,7 +70,7 @@ public class BasicAuthentication extends AbstractAuthentication
|
|||
* Basic authentication result.
|
||||
* <p>
|
||||
* Application may utilize this class directly via
|
||||
* {@link AuthenticationStore#addAuthenticationResult(Result)}
|
||||
* {@link org.eclipse.jetty.client.api.AuthenticationStore#addAuthenticationResult(Result)}
|
||||
* to perform preemptive authentication, that is immediately
|
||||
* sending the authorization header based on the fact that the
|
||||
* URI is known to require authentication and that username
|
||||
|
|
|
|||
|
|
@ -48,6 +48,7 @@ public class PriorityFrame extends Frame
|
|||
|
||||
/**
|
||||
* @deprecated use {@link #getParentStreamId()} instead.
|
||||
* @return <code>int</code> of the Parent Stream
|
||||
*/
|
||||
@Deprecated
|
||||
public int getDependentStreamId()
|
||||
|
|
|
|||
|
|
@ -512,6 +512,9 @@ public class DoSFilter implements Filter
|
|||
|
||||
/**
|
||||
* @deprecated use {@link #onRequestTimeout(HttpServletRequest, HttpServletResponse, Thread)} instead
|
||||
* @param request the current request
|
||||
* @param response the current response
|
||||
* @param thread the handling thread
|
||||
*/
|
||||
@Deprecated
|
||||
protected void closeConnection(HttpServletRequest request, HttpServletResponse response, Thread thread)
|
||||
|
|
|
|||
|
|
@ -33,7 +33,6 @@ import org.eclipse.jetty.websocket.common.scopes.SimpleContainerScope;
|
|||
/**
|
||||
* Client {@link ContainerProvider} implementation.
|
||||
* <p>
|
||||
* <p>
|
||||
* Created by a {@link java.util.ServiceLoader} call in the
|
||||
* {@link javax.websocket.ContainerProvider#getWebSocketContainer()} call.
|
||||
* </p>
|
||||
|
|
@ -79,7 +78,6 @@ public class JettyClientContainerProvider extends ContainerProvider
|
|||
* find and return the {@code javax.websocket.server.ServerContainer} from the
|
||||
* active {@code javax.servlet.ServletContext}.
|
||||
* <p>
|
||||
* <p>
|
||||
* This will only work if the call to {@link ContainerProvider#getWebSocketContainer()}
|
||||
* occurs within a thread being processed by the Servlet container.
|
||||
* </p>
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ public interface IJsrMethod
|
|||
/**
|
||||
* The message decoder class to use.
|
||||
*
|
||||
* @param decoderClass
|
||||
* @param decoderClass the {@link Decoder} implementation to use
|
||||
*/
|
||||
void setMessageDecoder(Class<? extends Decoder> decoderClass);
|
||||
|
||||
|
|
|
|||
|
|
@ -265,6 +265,8 @@ public class WebSocketClient extends ContainerLifeCycle implements WebSocketCont
|
|||
* the EventDriver Factory to use
|
||||
* @param sessionFactory
|
||||
* the SessionFactory to use
|
||||
* @param httpClient
|
||||
* the httpClient to use
|
||||
*/
|
||||
public WebSocketClient(final WebSocketContainerScope scope, EventDriverFactory eventDriverFactory, SessionFactory sessionFactory, HttpClient httpClient)
|
||||
{
|
||||
|
|
@ -462,6 +464,7 @@ public class WebSocketClient extends ContainerLifeCycle implements WebSocketCont
|
|||
|
||||
/**
|
||||
* @deprecated not used, no replacement
|
||||
* @return a {@link RandomMasker} instance
|
||||
*/
|
||||
@Deprecated
|
||||
public Masker getMasker()
|
||||
|
|
@ -634,6 +637,7 @@ public class WebSocketClient extends ContainerLifeCycle implements WebSocketCont
|
|||
|
||||
/**
|
||||
* @deprecated not used, configure threading in HttpClient instead
|
||||
* @param daemon do nothing
|
||||
*/
|
||||
@Deprecated
|
||||
public void setDaemon(boolean daemon)
|
||||
|
|
@ -654,6 +658,7 @@ public class WebSocketClient extends ContainerLifeCycle implements WebSocketCont
|
|||
|
||||
/**
|
||||
* @deprecated not used, no replacement
|
||||
* @param masker do nothing
|
||||
*/
|
||||
@Deprecated
|
||||
public void setMasker(Masker masker)
|
||||
|
|
|
|||
|
|
@ -363,7 +363,8 @@ public class WebSocketUpgradeRequest extends HttpRequest implements CompleteList
|
|||
* Exists for internal use of HttpClient by WebSocketClient.
|
||||
* <p>
|
||||
* Maintained for Backward compatibility and also for JSR356 WebSocket ClientContainer use.
|
||||
*
|
||||
*
|
||||
* @param wsClient the WebSocketClient that this request uses
|
||||
* @param httpClient the HttpClient that this request uses
|
||||
* @param request the ClientUpgradeRequest (backward compat) to base this request from
|
||||
*/
|
||||
|
|
@ -375,7 +376,8 @@ public class WebSocketUpgradeRequest extends HttpRequest implements CompleteList
|
|||
|
||||
/**
|
||||
* Initiating a WebSocket Upgrade using HTTP/1.1
|
||||
*
|
||||
*
|
||||
* @param wsClient the WebSocketClient that this request uses
|
||||
* @param httpClient the HttpClient that this request uses
|
||||
* @param localEndpoint the local endpoint (following Jetty WebSocket Client API rules) to use for incoming
|
||||
* WebSocket events
|
||||
|
|
|
|||
|
|
@ -175,6 +175,8 @@ public class WebSocketSession extends ContainerLifeCycle implements Session, Rem
|
|||
|
||||
/**
|
||||
* Aborts the active session abruptly.
|
||||
* @param statusCode the status code
|
||||
* @param reason the raw reason code
|
||||
*/
|
||||
public void abort(int statusCode, String reason)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -450,6 +450,7 @@ public abstract class AbstractWebSocketConnection extends AbstractConnection imp
|
|||
|
||||
/**
|
||||
* Event for no activity on connection (read or write)
|
||||
* @return true to signal that the endpoint must be closed, false to keep the endpoint open
|
||||
*/
|
||||
@Override
|
||||
protected boolean onReadTimeout()
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ public interface MappedWebSocketCreator
|
|||
/**
|
||||
* Returns the creator for the given path spec.
|
||||
*
|
||||
* @param spec @param spec the spec to test for (using the same spec syntax as seen in {@link #addMapping(String, WebSocketCreator)})
|
||||
* @param spec the spec to test for (using the same spec syntax as seen in {@link #addMapping(String, WebSocketCreator)})
|
||||
* @return the websocket creator if path spec exists, or null
|
||||
*/
|
||||
WebSocketCreator getMapping(String spec);
|
||||
|
|
|
|||
|
|
@ -56,6 +56,12 @@ public class WebSocketUpgradeFilter implements Filter, MappedWebSocketCreator, D
|
|||
public static final String CONTEXT_ATTRIBUTE_KEY = "contextAttributeKey";
|
||||
public static final String CONFIG_ATTRIBUTE_KEY = "configAttributeKey";
|
||||
|
||||
/**
|
||||
*
|
||||
* @param context the {@link ServletContextHandler} to use
|
||||
* @return a configured {@link WebSocketUpgradeFilter} instance
|
||||
* @throws ServletException if the filer cannot be configured
|
||||
*/
|
||||
public static WebSocketUpgradeFilter configureContext(ServletContextHandler context) throws ServletException
|
||||
{
|
||||
// Prevent double configure
|
||||
|
|
@ -90,6 +96,9 @@ public class WebSocketUpgradeFilter implements Filter, MappedWebSocketCreator, D
|
|||
|
||||
/**
|
||||
* @deprecated use {@link #configureContext(ServletContextHandler)} instead
|
||||
* @param context the ServletContext to use
|
||||
* @return a configured {@link WebSocketUpgradeFilter} instance
|
||||
* @throws ServletException if the filer cannot be configured
|
||||
*/
|
||||
@Deprecated
|
||||
public static WebSocketUpgradeFilter configureContext(ServletContext context) throws ServletException
|
||||
|
|
|
|||
Loading…
Reference in New Issue