EE10 :: Servlet 12.0.6 · org.eclipse.jetty.ee10.servlet.ServletChannel

Modifier and Type	Field and Description
private Callback	_callback
private final ConnectionMetaData	_connectionMetaData
private final ServletContextHandler.ServletScopedContext	_context
pack-priv final HttpInput	_httpInput
private final HttpOutput	_httpOutput
private Request	_request
private final AtomicLong	_requests
private Response	_response
private final ServletContextHandler.ServletContextApi	_servletContextApi
private ServletContextRequest	_servletContextRequest
private final ServletChannelState	_state
private static final Logger	LOG

Access	Constructor and Description
public	ServletChannel(ServletContextHandler servletContextHandler, Request request)
public	ServletChannel(ServletContextHandler servletContextHandler, ConnectionMetaData connectionMetaData)

Method Summary

Modifier and Type	Method and Description
public void	abort(Throwable the failure that caused the abort. failure) If a write or similar operation to this channel fails, then this method should be called.
public void	associate(ServletContextRequest The servlet context request to associate servletContextRequest) Associate this channel with a specific request.
public void	associate(Request The request, which may have been wrapped after #`ServletContextHandler#wrapRequest(Request, Response)` request, Response The response, which may have been wrapped after #`ServletContextHandler#wrapResponse(ContextRequest, Response)` response, Callback The context, which may have been wrapped after `ServletContextHandler#handle(Request, Response, Callback)` callback) Associate this channel with possibly wrapped values for `getRequest()`, `getResponse()` and `getCallback()`.
private void	dispatch()
public void	dispatchAsync()
protected void	execute(Runnable task)
protected String	Returns: Default implementation returns `HostPort#normalizeHost(String)` formatAddrOrHost(String The address or host addr) Format the address or host returned from Request methods
private long	getBytesWritten()
public Callback	getCallback()
public Connection	getConnection()
public ConnectionMetaData	getConnectionMetaData()
public ServletContextHandler.ServletScopedContext	getContext()
public EndPoint	getEndPoint()
public HttpConfiguration	getHttpConfiguration()
public HttpInput	getHttpInput()
public HttpOutput	getHttpOutput()
public long	Returns: the idle timeout (in milliseconds) getIdleTimeout() Get the idle timeout.
public InetSocketAddress	getLocalAddress()
public String	Returns: the local name, or null getLocalName() Return the local name of the connected channel.
public int	Returns: the local port, or 0 if unspecified getLocalPort() Return the Local Port of the connected channel.
public InetSocketAddress	getRemoteAddress()
public Request	Returns: The core `Request` associated with the request. This may differ from `getServletContextRequest()` if the request was wrapped by another handler after the `ServletContextHandler` and passed to `ServletChannel#associate(Request, Response, Callback)`. getRequest()
public Response	Returns: The core `Response` associated with the API response. This may differ from `getServletContextResponse()` if the response was wrapped by another handler after the `ServletContextHandler` and passed to `ServletChannel#associate(Request, Response, Callback)`. getResponse()
public Server	getServer()
public HostPort	Returns: return the HttpConfiguration server authority override getServerAuthority() Get return the HttpConfiguration server authority override.
public ServletContextHandler.ServletContextApi	getServletContextApi()
public ServletContextHandler	getServletContextHandler()
public ServletContextRequest	Returns: The `ServletContextRequest` as wrapped by the `ServletContextHandler`. getServletContextRequest()
public ServletContextResponse	Returns: The ServetContextResponse as wrapped by the `ServletContextHandler`. getServletContextResponse()
public ServletChannelState	getServletRequestState()
public void	handle() Handle the servlet request.
protected void	handleException(Throwable the Throwable that caused the problem failure) Sends an error 500, performing a special logic to detect whether the request is suspended, to avoid concurrent writes from the application.
public boolean	isAborted()
public boolean	isCommitted()
public boolean	Returns: True if the request lifecycle is completed isRequestCompleted()
public boolean	Returns: True if the response is completely written. isResponseCompleted()
public boolean	isSendError()
public void	onCompleted()
pack-priv void	onTrailers(HttpFields trailers)
pack-priv void	recycle(Throwable Any completion exception, or null for successful completion. x) Prepare to be reused.
private void	reopen()
private boolean	Returns: true if we have sent an error, false if we have aborted. sendErrorOrAbort(String the error message. message)
public void	sendErrorResponseAndComplete()
public void	setIdleTimeout(long the idle timeout in milliseconds timeoutMs) Set the idle timeout.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected Throwable	Returns: A target throwable or null unwrap(Throwable The throwable to have its causes unwrapped failure, Class<?>... Exception classes that we should not unwrap targets) Unwrap failure causes to find target class

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

_callback	back to summary
private Callback _callback

_context	back to summary
private final ServletContextHandler.ServletScopedContext _context

_httpInput	back to summary
pack-priv final HttpInput _httpInput

_httpOutput	back to summary
private final HttpOutput _httpOutput

_request	back to summary
private Request _request

_requests	back to summary
private final AtomicLong _requests

_response	back to summary
private Response _response

_servletContextApi	back to summary
private final ServletContextHandler.ServletContextApi _servletContextApi

_servletContextRequest	back to summary
private ServletContextRequest _servletContextRequest

_state	back to summary
private final ServletChannelState _state

LOG	back to summary
private static final Logger LOG

ServletChannel	back to summary
public ServletChannel(ServletContextHandler servletContextHandler, Request request)

Method Detail

abort back to summary

abort	back to summary
public void abort(Throwable failure) If a write or similar operation to this channel fails, then this method should be called. Parameters failure:Throwable the failure that caused the abort. See Also `onCompleted()`

public void abort(Throwable failure)

If a write or similar operation to this channel fails, then this method should be called.

Parameters

failure:Throwable: the failure that caused the abort.

See Also

onCompleted()

associate back to summary

associate	back to summary
public void associate(ServletContextRequest servletContextRequest) Associate this channel with a specific request. This method is called by the `ServletContextHandler` when a core `Request` is accepted and associated with a servlet mapping. The association remains functional until `recycle(Throwable)` is called, and it remains readable until a call to `recycle(Throwable)` or a subsequent call to `associate`. Parameters servletContextRequest:ServletContextRequest The servlet context request to associate See Also `recycle(Throwable)`

public void associate(ServletContextRequest servletContextRequest)

Associate this channel with a specific request. This method is called by the ServletContextHandler when a core Request is accepted and associated with a servlet mapping. The association remains functional until recycle(Throwable) is called, and it remains readable until a call to recycle(Throwable) or a subsequent call to associate.

Parameters

servletContextRequest:ServletContextRequest: The servlet context request to associate

See Also

recycle(Throwable)

associate back to summary

associate	back to summary
public void associate(Request request, Response response, Callback callback) Associate this channel with possibly wrapped values for `getRequest()`, `getResponse()` and `getCallback()`. This is called by the `ServletHandler` immediately before calling `handle()` on the initial dispatch. This allows for handlers between the `ServletContextHandler` and the `ServletHandler` to wrap the instances. Parameters request:Request The request, which may have been wrapped after #`ServletContextHandler#wrapRequest(Request, Response)` response:Response The response, which may have been wrapped after #`ServletContextHandler#wrapResponse(ContextRequest, Response)` callback:Callback The context, which may have been wrapped after `ServletContextHandler#handle(Request, Response, Callback)`

public void associate(Request request, Response response, Callback callback)

Associate this channel with possibly wrapped values for getRequest(), getResponse() and getCallback(). This is called by the ServletHandler immediately before calling handle() on the initial dispatch. This allows for handlers between the ServletContextHandler and the ServletHandler to wrap the instances.

Parameters

request:Request: The request, which may have been wrapped after #ServletContextHandler#wrapRequest(Request, Response)
response:Response: The response, which may have been wrapped after #ServletContextHandler#wrapResponse(ContextRequest, Response)
callback:Callback: The context, which may have been wrapped after ServletContextHandler#handle(Request, Response, Callback)

dispatch	back to summary
private void dispatch() throws Exception

dispatchAsync	back to summary
public void dispatchAsync() throws Exception

execute	back to summary
protected void execute(Runnable task)

formatAddrOrHost back to summary

formatAddrOrHost	back to summary
protected String formatAddrOrHost(String addr) Format the address or host returned from Request methods Parameters addr:String The address or host Returns:String Default implementation returns `HostPort#normalizeHost(String)`

protected String formatAddrOrHost(String addr)

Format the address or host returned from Request methods

Parameters

addr:String: The address or host

Returns:String

Default implementation returns HostPort#normalizeHost(String)

getBytesWritten	back to summary
private long getBytesWritten()

getCallback	back to summary
public Callback getCallback()

getConnection	back to summary
public Connection getConnection()

getConnectionMetaData	back to summary
public ConnectionMetaData getConnectionMetaData()

getContext	back to summary
public ServletContextHandler.ServletScopedContext getContext()

getEndPoint	back to summary
public EndPoint getEndPoint()

getHttpConfiguration	back to summary
public HttpConfiguration getHttpConfiguration()

getHttpInput	back to summary
public HttpInput getHttpInput()

getHttpOutput	back to summary
public HttpOutput getHttpOutput()

getIdleTimeout back to summary

getIdleTimeout	back to summary
public long getIdleTimeout() Get the idle timeout. This is implemented as a call to `EndPoint#getIdleTimeout()`, but may be overridden by channels that have timeouts different from their connections. Returns:long the idle timeout (in milliseconds)

public long getIdleTimeout()

Get the idle timeout.

This is implemented as a call to EndPoint#getIdleTimeout(), but may be overridden by channels that have timeouts different from their connections.

Returns:long: the idle timeout (in milliseconds)

getLocalAddress	back to summary
public InetSocketAddress getLocalAddress()

getLocalName back to summary

getLocalName	back to summary
public String getLocalName() Return the local name of the connected channel. This is the host name after the connector is bound and the connection is accepted. Value can be overridden by `HttpConfiguration#setLocalAddress(SocketAddress)`. Note some connectors are not based on IP networking, and default behavior here will result in a null return. Use `HttpConfiguration#setLocalAddress(SocketAddress)` to set the value to an acceptable host name. Returns:String the local name, or null

public String getLocalName()

Return the local name of the connected channel.

This is the host name after the connector is bound and the connection is accepted.

Value can be overridden by HttpConfiguration#setLocalAddress(SocketAddress).

Note

some connectors are not based on IP networking, and default behavior here will result in a null return. Use HttpConfiguration#setLocalAddress(SocketAddress) to set the value to an acceptable host name.

Returns:String: the local name, or null

getLocalPort back to summary

getLocalPort	back to summary
public int getLocalPort() Return the Local Port of the connected channel. This is the port the connector is bound to and is accepting connections on. Value can be overridden by `HttpConfiguration#setLocalAddress(SocketAddress)`. Note some connectors are not based on IP networking, and default behavior here will result in a value of 0 returned. Use `HttpConfiguration#setLocalAddress(SocketAddress)` to set the value to an acceptable port. Returns:int the local port, or 0 if unspecified

public int getLocalPort()

Return the Local Port of the connected channel.

This is the port the connector is bound to and is accepting connections on.

Value can be overridden by HttpConfiguration#setLocalAddress(SocketAddress).

Note

some connectors are not based on IP networking, and default behavior here will result in a value of 0 returned. Use HttpConfiguration#setLocalAddress(SocketAddress) to set the value to an acceptable port.

Returns:int: the local port, or 0 if unspecified

getRemoteAddress	back to summary
public InetSocketAddress getRemoteAddress()

getRequest	back to summary
public Request getRequest() Returns:Request The core `Request` associated with the request. This may differ from `getServletContextRequest()` if the request was wrapped by another handler after the `ServletContextHandler` and passed to `ServletChannel#associate(Request, Response, Callback)`. See Also `getServletContextRequest()`, `associate(Request, Response, Callback)`

getResponse	back to summary
public Response getResponse() Returns:Response The core `Response` associated with the API response. This may differ from `getServletContextResponse()` if the response was wrapped by another handler after the `ServletContextHandler` and passed to `ServletChannel#associate(Request, Response, Callback)`. See Also `getServletContextResponse()`, `associate(Request, Response, Callback)`

getServer	back to summary
public Server getServer()

getServerAuthority	back to summary
public HostPort getServerAuthority() Get return the HttpConfiguration server authority override. Returns:HostPort return the HttpConfiguration server authority override

getServerAuthority

back to summary

public HostPort getServerAuthority()

Get return the HttpConfiguration server authority override.

Returns:HostPort: return the HttpConfiguration server authority override

getServletContextApi	back to summary
public ServletContextHandler.ServletContextApi getServletContextApi()

getServletContextHandler	back to summary
public ServletContextHandler getServletContextHandler()

getServletContextRequest	back to summary
public ServletContextRequest getServletContextRequest() Returns:ServletContextRequest The `ServletContextRequest` as wrapped by the `ServletContextHandler`. See Also `getRequest()`

getServletContextResponse	back to summary
public ServletContextResponse getServletContextResponse() Returns:ServletContextResponse The ServetContextResponse as wrapped by the `ServletContextHandler`. See Also `getResponse()`

getServletRequestState	back to summary
public ServletChannelState getServletRequestState()

handle	back to summary
public void handle() Handle the servlet request. This is called on the initial dispatch and then again on any asynchronous events.

handleException back to summary

handleException	back to summary
protected void handleException(Throwable failure) Sends an error 500, performing a special logic to detect whether the request is suspended, to avoid concurrent writes from the application. It may happen that the application suspends, and then throws an exception, while an application spawned thread writes the response content; in such case, we attempt to commit the error directly bypassing the `ErrorHandler` mechanisms and the response OutputStream. Parameters failure:Throwable the Throwable that caused the problem

protected void handleException(Throwable failure)

Sends an error 500, performing a special logic to detect whether the request is suspended, to avoid concurrent writes from the application.

It may happen that the application suspends, and then throws an exception, while an application spawned thread writes the response content; in such case, we attempt to commit the error directly bypassing the ErrorHandler mechanisms and the response OutputStream.

Parameters

failure:Throwable: the Throwable that caused the problem

isAborted	back to summary
public boolean isAborted()

isCommitted	back to summary
public boolean isCommitted()

isRequestCompleted	back to summary
public boolean isRequestCompleted() Returns:boolean True if the request lifecycle is completed

isResponseCompleted	back to summary
public boolean isResponseCompleted() Returns:boolean True if the response is completely written.

isSendError	back to summary
public boolean isSendError()

onCompleted	back to summary
public void onCompleted() See Also `abort(Throwable)`

onTrailers	back to summary
pack-priv void onTrailers(HttpFields trailers)

recycle back to summary

pack-priv void recycle(Throwable x)

Prepare to be reused.

Parameters

x:Throwable: Any completion exception, or null for successful completion.

See Also

associate(ServletContextRequest)

reopen	back to summary
private void reopen()

sendErrorOrAbort	back to summary
private boolean sendErrorOrAbort(String message) Parameters message:String the error message. Returns:boolean true if we have sent an error, false if we have aborted.

sendErrorResponseAndComplete	back to summary
public void sendErrorResponseAndComplete()

setIdleTimeout back to summary

public void setIdleTimeout(long timeoutMs)

Set the idle timeout.

This is implemented as a call to EndPoint#setIdleTimeout(long), but may be overridden by channels that have timeouts different from their connections.

Parameters

timeoutMs:long: the idle timeout in milliseconds

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

unwrap

back to summary

protected Throwable unwrap(Throwable failure, Class<?>... targets)

Unwrap failure causes to find target class

Parameters

failure:Throwable: The throwable to have its causes unwrapped
targets:Class<?>[]: Exception classes that we should not unwrap

Returns:Throwable

A target throwable or null

public Class ServletChannel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail