Class Filter<UP_IN,UP_OUT,DOWN_OUT,DOWN_IN>
java.lang.Object
org.glassfish.jersey.jdk.connector.internal.Filter<UP_IN,UP_OUT,DOWN_OUT,DOWN_IN>
- Direct Known Subclasses:
HttpConnection.ConnectionFilter
,HttpFilter
,ProxyFilter
,SslFilter
,TransportFilter
A filter can add functionality to JDK client transport. Filters are composed together to
create JDK client transport.
-
Field Summary
FieldsModifier and TypeFieldDescription -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) void
close()
Close the filter, invokes close operation on the next filter in the filter chain.(package private) void
connect
(SocketAddress address, Filter<?, ?, UP_IN, UP_OUT> upstreamFilter) Initiate connect.(package private) void
handleConnect
(SocketAddress address, Filter upstreamFilter) Handleconnect(SocketAddress, Filter)
.(package private) void
An event listener that is called when a connection is set up.(package private) final void
An event listener that is called when the connection is closed by the peer.(package private) final void
An event listener that is called when an error has occurred.(package private) final void
An event listener that is called when some data is read.(package private) final void
An event listener that is called, when SSL completes its handshake.(package private) void
ProcessonConnect()
.(package private) void
ProcessonConnectionClosed()
.(package private) void
ProcessonError(Throwable)
.(package private) boolean
processRead
(DOWN_IN data) ProcessonRead(Object)
.(package private) void
ProcessonSslHandshakeCompleted()
.(package private) void
startSsl()
Signal to turn on SSL, it is passed on in the filter chain until a filter responsible for SSL is reached.(package private) void
write
(UP_IN data, CompletionHandler<UP_IN> completionHandler) Perform write operation for this filter and invokes write method on the next filter in the filter chain.
-
Field Details
-
upstreamFilter
-
downstreamFilter
-
-
Constructor Details
-
Filter
Constructor.- Parameters:
downstreamFilter
- downstream filter. Accessible directly asdownstreamFilter
protected field.
-
-
Method Details
-
write
Perform write operation for this filter and invokes write method on the next filter in the filter chain.- Parameters:
data
- on which write operation is performed.completionHandler
- will be invoked when the write operation is completed or has failed.
-
close
void close()Close the filter, invokes close operation on the next filter in the filter chain. The filter is expected to clean up any allocated resources and pass the invocation to downstream filter. -
startSsl
void startSsl()Signal to turn on SSL, it is passed on in the filter chain until a filter responsible for SSL is reached. -
connect
Initiate connect. If theFilter
needs to do something during this phase, it must implementhandleConnect(SocketAddress, Filter)
method.- Parameters:
address
- an address where to connect (server or proxy).upstreamFilter
- a filter positioned upstream.
-
onConnect
void onConnect()An event listener that is called when a connection is set up. This event travels up in the filter chain. If theFilter
needs to process this event, it must implementprocessConnect()
method. -
onRead
An event listener that is called when some data is read. If theFilter
needs to process this event, it must implementonRead(Object)
()} method. If the method returnstrue
, the processing will continue with upstream filters; if the method invocation returnsfalse
, the processing won't continue.- Parameters:
data
- that has been read.
-
onConnectionClosed
final void onConnectionClosed()An event listener that is called when the connection is closed by the peer. If theFilter
needs to process this event, it must implementprocessConnectionClosed()
method. -
onSslHandshakeCompleted
final void onSslHandshakeCompleted()An event listener that is called, when SSL completes its handshake. If theFilter
needs to process this event, it must implementprocessSslHandshakeCompleted()
method. -
onError
An event listener that is called when an error has occurred. Errors travel in direction from downstream filter to upstream filter. If theFilter
needs to process this event, it must implementprocessError(Throwable)
method.- Parameters:
t
- an error that has occurred.
-
handleConnect
Handleconnect(SocketAddress, Filter)
.- Parameters:
address
- an address where to connect (server or proxy).upstreamFilter
- a filter positioned upstream.- See Also:
-
processConnect
void processConnect()ProcessonConnect()
.- See Also:
-
processRead
ProcessonRead(Object)
.- Parameters:
data
- read data.- Returns:
true
if the data should be sent to processing to upper filter in the chain,false
otherwise.
-
processConnectionClosed
void processConnectionClosed()ProcessonConnectionClosed()
.- See Also:
-
processSslHandshakeCompleted
void processSslHandshakeCompleted()ProcessonSslHandshakeCompleted()
.- See Also:
-
processError
ProcessonError(Throwable)
.- Parameters:
t
- an error that has occurred.- See Also:
-