Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	PUFilter.InternalCompletionHandler
private class	PUFilter.InternalProcessingHandler
private class	PUFilter.SuspendedContextCopyListener

Field Summary

Modifier and Type	Field and Description
private final BackChannelFilter	backChannelFilter
private final boolean	isCloseUnrecognizedConnection
private static final Logger	LOGGER
private final ArraySet<PUProtocol>	protocols
pack-priv final Attribute<PUContext>	puContextAttribute
pack-priv final Attribute<FilterChainContext>	suspendedContextAttribute
private final PUFilter.SuspendedContextCopyListener	suspendedContextCopyListener

Constructor Summary

Access	Constructor and Description
public	PUFilter()
public	PUFilter(final boolean `true` if a `Connection` whose protocol is not recognized will be automatically closed, or `false` if normal `FilterChain` processing will be continued for such `Connection`, so a `Filter` next to `PUFilter` may implement custom logic to process unrecognized connection. isCloseUnrecognizedConnection) Constructs PUFilter.

Method Summary

Modifier and Type	Method and Description
public void	deregister(final PUProtocol `PUProtocol` puProtocol) Deregisters the `PUProtocol`.
protected void	findProtocol(final PUContext puContext, final FilterChainContext ctx)
public Filter	Returns: back channel `Filter`. getBackChannelFilter() Get the back channel `Filter` implementation, which should connect the custom protocol `FilterChain` with the main `FilterChain`.
public Set<PUProtocol>	Returns: `PUProtocol` `Set`. getProtocols() Get registered port unification protocols - `PUProtocol`s.
public FilterChainBuilder	Returns: `FilterChainBuilder`. getPUFilterChainBuilder() Returns the `FilterChainBuilder`, developers may use to build there custom protocol filter chain.
public NextAction	handleClose(FilterChainContext ctx) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleClose. Implements org.glassfish.grizzly.filterchain.Filter.handleClose. Execute a unit of processing work to be performed, when connection has been closed.
public NextAction	handleEvent(final FilterChainContext ctx, final FilterChainEvent event) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleEvent. Implements org.glassfish.grizzly.filterchain.Filter.handleEvent. Handle custom event associated with the `Connection`.
public NextAction	handleRead(final FilterChainContext ctx) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Implements org.glassfish.grizzly.filterchain.Filter.handleRead. Execute a unit of processing work to be performed, when channel will become available for reading.
public boolean	isCloseUnrecognizedConnection() Returns `true` if a `Connection` whose protocol is not recognized will be automatically closed, or `false` if normal `FilterChain` processing will be continued for such `Connection`, so a `Filter` next to `PUFilter` may implement custom logic to process unrecognized connection.
private static boolean	isUpstream(final FilterChainContext context)
private FilterChainContext	obtainChildFilterChainContext(final PUProtocol protocol, final Connection<L> connection, final FilterChainContext ctx)
public PUProtocol	Returns: `PUProtocol`, which wraps passed `ProtocolFinder` and `FilterChain`. register(final ProtocolFinder `ProtocolFinder` protocolFinder, final FilterChain `FilterChain` filterChain) Registers new `ProtocolFinder` - `FilterChain` pair, which defines the protocol.
public void	register(final PUProtocol `PUProtocol` puProtocol) Registers new `PUProtocol`.

Inherited from org.glassfish.grizzly.filterchain.BaseFilter:: createContext exceptionOccurred handleAccept handleConnect handleWrite onAdded onFilterChainChanged onRemoved toString

Field Detail

backChannelFilter	back to summary
private final BackChannelFilter backChannelFilter

isCloseUnrecognizedConnection	back to summary
private final boolean isCloseUnrecognizedConnection

LOGGER	back to summary
private static final Logger LOGGER

protocols	back to summary
private final ArraySet<PUProtocol> protocols

puContextAttribute	back to summary
pack-priv final Attribute<PUContext> puContextAttribute

suspendedContextAttribute	back to summary
pack-priv final Attribute<FilterChainContext> suspendedContextAttribute

suspendedContextCopyListener	back to summary
private final PUFilter.SuspendedContextCopyListener suspendedContextCopyListener

Constructor Detail

PUFilter	back to summary
public PUFilter()

PUFilter back to summary

PUFilter	back to summary
public PUFilter(final boolean isCloseUnrecognizedConnection) Constructs PUFilter. Parameters isCloseUnrecognizedConnection:boolean `true` if a `Connection` whose protocol is not recognized will be automatically closed, or `false` if normal `FilterChain` processing will be continued for such `Connection`, so a `Filter` next to `PUFilter` may implement custom logic to process unrecognized connection.

public PUFilter(final boolean isCloseUnrecognizedConnection)

Constructs PUFilter.

Parameters

isCloseUnrecognizedConnection:boolean: true if a Connection whose protocol is not recognized will be automatically closed, or false if normal FilterChain processing will be continued for such Connection, so a Filter next to PUFilter may implement custom logic to process unrecognized connection.

Method Detail

deregister back to summary

deregister	back to summary
public void deregister(final PUProtocol puProtocol) Deregisters the `PUProtocol`. Parameters puProtocol:PUProtocol `PUProtocol`

public void deregister(final PUProtocol puProtocol)

Deregisters the PUProtocol.

Parameters

puProtocol:PUProtocol: PUProtocol

findProtocol	back to summary
protected void findProtocol(final PUContext puContext, final FilterChainContext ctx)

getBackChannelFilter back to summary

getBackChannelFilter	back to summary
public Filter getBackChannelFilter() Get the back channel `Filter` implementation, which should connect the custom protocol `FilterChain` with the main `FilterChain`. Usually developers shouldn't use this method, if they build custom protocol chains using `getPUFilterChainBuilder()`, otherwise they have to make sure there custom protocol `FilterChain` contains back channel `Filter` (usually first Filter in the custom protocol filter chain). Returns:Filter back channel `Filter`.

public Filter getBackChannelFilter()

Get the back channel Filter implementation, which should connect the custom protocol FilterChain with the main FilterChain. Usually developers shouldn't use this method, if they build custom protocol chains using getPUFilterChainBuilder(), otherwise they have to make sure there custom protocol FilterChain contains back channel Filter (usually first Filter in the custom protocol filter chain).

Returns:Filter: back channel Filter.

getProtocols back to summary

getProtocols	back to summary
public Set<PUProtocol> getProtocols() Get registered port unification protocols - `PUProtocol`s. Returns:Set<PUProtocol> `PUProtocol` `Set`.

public Set<PUProtocol> getProtocols()

Get registered port unification protocols - PUProtocols.

Returns:Set<PUProtocol>: PUProtocol Set.

getPUFilterChainBuilder back to summary

getPUFilterChainBuilder	back to summary
public FilterChainBuilder getPUFilterChainBuilder() Returns the `FilterChainBuilder`, developers may use to build there custom protocol filter chain. The returned `FilterChainBuilder` may have some `Filter`s pre-added. Returns:FilterChainBuilder `FilterChainBuilder`.

public FilterChainBuilder getPUFilterChainBuilder()

Returns the FilterChainBuilder, developers may use to build there custom protocol filter chain. The returned FilterChainBuilder may have some Filters pre-added.

Returns:FilterChainBuilder: FilterChainBuilder.

handleClose back to summary

handleClose	back to summary
public NextAction handleClose(FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleClose. Implements org.glassfish.grizzly.filterchain.Filter.handleClose. Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleClose. Execute a unit of processing work to be performed, when connection has been closed. This `Filter` may either complete the required processing and return false, or delegate remaining processing to the next `Filter` in a `FilterChain` containing this `Filter` by returning true. Annotations @Override

public NextAction handleClose(FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleClose.

Implements org.glassfish.grizzly.filterchain.Filter.handleClose.

Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleClose.

Execute a unit of processing work to be performed, when connection has been closed. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Annotations

@Override

handleEvent back to summary

handleEvent	back to summary
public NextAction handleEvent(final FilterChainContext ctx, final FilterChainEvent event) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleEvent. Implements org.glassfish.grizzly.filterchain.Filter.handleEvent. Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleEvent. Handle custom event associated with the `Connection`. This `Filter` may either complete the required processing and return `StopAction`, or delegate remaining processing to the next `Filter` in a `FilterChain` containing this `Filter` by returning `InvokeAction`. Annotations @Override

public NextAction handleEvent(final FilterChainContext ctx, final FilterChainEvent event) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleEvent.

Implements org.glassfish.grizzly.filterchain.Filter.handleEvent.

Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleEvent.

Handle custom event associated with the Connection. This Filter may either complete the required processing and return StopAction, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning InvokeAction.

Annotations

@Override

handleRead back to summary

handleRead	back to summary
public NextAction handleRead(final FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Implements org.glassfish.grizzly.filterchain.Filter.handleRead. Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Execute a unit of processing work to be performed, when channel will become available for reading. This `Filter` may either complete the required processing and return false, or delegate remaining processing to the next `Filter` in a `FilterChain` containing this `Filter` by returning true. Annotations @Override

public NextAction handleRead(final FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead.

Implements org.glassfish.grizzly.filterchain.Filter.handleRead.

Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleRead.

Execute a unit of processing work to be performed, when channel will become available for reading. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Annotations

@Override

isCloseUnrecognizedConnection	back to summary
public boolean isCloseUnrecognizedConnection() Returns `true` if a `Connection` whose protocol is not recognized will be automatically closed, or `false` if normal `FilterChain` processing will be continued for such `Connection`, so a `Filter` next to `PUFilter` may implement custom logic to process unrecognized connection.

isUpstream	back to summary
private static boolean isUpstream(final FilterChainContext context)

obtainChildFilterChainContext	back to summary
private FilterChainContext obtainChildFilterChainContext(final PUProtocol protocol, final Connection<L> connection, final FilterChainContext ctx)

register	back to summary
public PUProtocol register(final ProtocolFinder protocolFinder, final FilterChain filterChain) Registers new `ProtocolFinder` - `FilterChain` pair, which defines the protocol. Parameters protocolFinder:ProtocolFinder `ProtocolFinder` filterChain:FilterChain `FilterChain` Returns:PUProtocol `PUProtocol`, which wraps passed `ProtocolFinder` and `FilterChain`.

public PUProtocol register(final ProtocolFinder protocolFinder, final FilterChain filterChain)

Registers new ProtocolFinder - FilterChain pair, which defines the protocol.

Parameters

protocolFinder:ProtocolFinder: ProtocolFinder
filterChain:FilterChain: FilterChain

Returns:PUProtocol

PUProtocol, which wraps passed ProtocolFinder and FilterChain.

register	back to summary
public void register(final PUProtocol puProtocol) Registers new `PUProtocol`. Parameters puProtocol:PUProtocol `PUProtocol`

public void register(final PUProtocol puProtocol)

Registers new PUProtocol.

Parameters

puProtocol:PUProtocol: PUProtocol

org.glassfish.grizzly.portunif back to summary

private Class PUFilter.InternalCompletionHandler

Class Inheritance

extends Object
implements CompletionHandler<FilterChainContext>

java.lang.Object
org.glassfish.grizzly.portunif.PUFilter.InternalCompletionHandler

All Implemented Interfaces

org.glassfish.grizzly.CompletionHandler

Field Summary

Modifier and Type	Field and Description
private final FilterChainContext	suspendedContext

Constructor Summary

Access	Constructor and Description
public	InternalCompletionHandler(FilterChainContext suspendedContext)

Method Summary

Modifier and Type	Method and Description
public void	cancelled() Implements org.glassfish.grizzly.CompletionHandler.cancelled. The operation was cancelled.
public void	completed(final FilterChainContext context) Implements org.glassfish.grizzly.CompletionHandler.completed. The operation was completed.
public void	failed(final Throwable throwable) Implements org.glassfish.grizzly.CompletionHandler.failed. The operation was failed.
public void	updated(FilterChainContext result) Implements org.glassfish.grizzly.CompletionHandler.updated. The callback method may be called, when there is some progress in operation execution, but it is still not completed

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

Field Detail

suspendedContext	back to summary
private final FilterChainContext suspendedContext

Constructor Detail

InternalCompletionHandler	back to summary
public InternalCompletionHandler(FilterChainContext suspendedContext)

Method Detail

cancelled	back to summary
public void cancelled() Implements org.glassfish.grizzly.CompletionHandler.cancelled. Doc from org.glassfish.grizzly.CompletionHandler.cancelled. The operation was cancelled. Annotations @Override

cancelled

back to summary

public void cancelled()

Implements org.glassfish.grizzly.CompletionHandler.cancelled.

Doc from org.glassfish.grizzly.CompletionHandler.cancelled.

The operation was cancelled.

Annotations

@Override

completed	back to summary
public void completed(final FilterChainContext context) Implements org.glassfish.grizzly.CompletionHandler.completed. Doc from org.glassfish.grizzly.CompletionHandler.completed. The operation was completed. Annotations @Override

completed

back to summary

public void completed(final FilterChainContext context)

Implements org.glassfish.grizzly.CompletionHandler.completed.

Doc from org.glassfish.grizzly.CompletionHandler.completed.

The operation was completed.

Annotations

@Override

failed	back to summary
public void failed(final Throwable throwable) Implements org.glassfish.grizzly.CompletionHandler.failed. Doc from org.glassfish.grizzly.CompletionHandler.failed. The operation was failed. Annotations @Override

failed

back to summary

public void failed(final Throwable throwable)

Implements org.glassfish.grizzly.CompletionHandler.failed.

Doc from org.glassfish.grizzly.CompletionHandler.failed.

The operation was failed.

Annotations

@Override

updated	back to summary
public void updated(FilterChainContext result) Implements org.glassfish.grizzly.CompletionHandler.updated. Doc from org.glassfish.grizzly.CompletionHandler.updated. The callback method may be called, when there is some progress in operation execution, but it is still not completed Annotations @Override

updated

back to summary

public void updated(FilterChainContext result)

Implements org.glassfish.grizzly.CompletionHandler.updated.

Doc from org.glassfish.grizzly.CompletionHandler.updated.

The callback method may be called, when there is some progress in operation execution, but it is still not completed

Annotations

@Override

org.glassfish.grizzly.portunif back to summary

private Class PUFilter.InternalProcessingHandler

Class Inheritance

extends Adapter

java.lang.Object
org.glassfish.grizzly.IOEventLifeCycleListener.Adapter
org.glassfish.grizzly.portunif.PUFilter.InternalProcessingHandler

Field Summary

Modifier and Type	Field and Description
private final FilterChainContext	parentContext

Constructor Summary

Access	Constructor and Description
private	InternalProcessingHandler(final FilterChainContext parentContext)

Method Summary

Modifier and Type	Method and Description
public void	onComplete(final Context context, final Object data) Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete. Implements org.glassfish.grizzly.IOEventLifeCycleListener.onComplete. `IOEvent` processing completed.
public void	onReregister(final Context context) Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onReregister. Implements org.glassfish.grizzly.IOEventLifeCycleListener.onReregister. Reregister `IOEvent` interest.

Inherited from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter:: onContextManualIOEventControl onContextResume onContextSuspend onError onLeave onNotRun onRerun onTerminate

Field Detail

parentContext	back to summary
private final FilterChainContext parentContext

Constructor Detail

InternalProcessingHandler	back to summary
private InternalProcessingHandler(final FilterChainContext parentContext)

Method Detail

onComplete back to summary

onComplete	back to summary
public void onComplete(final Context context, final Object data) throws IOException Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete. Implements org.glassfish.grizzly.IOEventLifeCycleListener.onComplete. Doc from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete. `IOEvent` processing completed. Annotations @Override Exceptions IOException: Doc from org.glassfish.grizzly.IOEventLifeCycleListener.onComplete. on error

public void onComplete(final Context context, final Object data) throws IOException

Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete.

Implements org.glassfish.grizzly.IOEventLifeCycleListener.onComplete.

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete.

IOEvent processing completed.

Annotations

@Override

Exceptions

IOException:

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.onComplete.

on error

onReregister back to summary

onReregister	back to summary
public void onReregister(final Context context) throws IOException Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onReregister. Implements org.glassfish.grizzly.IOEventLifeCycleListener.onReregister. Doc from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onReregister. Reregister `IOEvent` interest. Annotations @Override Exceptions IOException: Doc from org.glassfish.grizzly.IOEventLifeCycleListener.onReregister. on error

public void onReregister(final Context context) throws IOException

Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onReregister.

Implements org.glassfish.grizzly.IOEventLifeCycleListener.onReregister.

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onReregister.

Reregister IOEvent interest.

Annotations

@Override

Exceptions

IOException:

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.onReregister.

on error

org.glassfish.grizzly.portunif back to summary

private Class PUFilter.SuspendedContextCopyListener

Class Inheritance

extends Object
implements CopyListener

java.lang.Object
org.glassfish.grizzly.portunif.PUFilter.SuspendedContextCopyListener

All Implemented Interfaces

org.glassfish.grizzly.filterchain.FilterChainContext.CopyListener

Constructor Summary

Access	Constructor and Description
private	SuspendedContextCopyListener()

Method Summary

Modifier and Type	Method and Description
public void	onCopy(final FilterChainContext srcContext, final FilterChainContext copiedContext) Implements org.glassfish.grizzly.filterchain.FilterChainContext.CopyListener.onCopy. The method is called, when passed `FilterChainContext` is copied.

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

Constructor Detail

SuspendedContextCopyListener	back to summary
private SuspendedContextCopyListener()

Method Detail

onCopy back to summary

onCopy	back to summary
public void onCopy(final FilterChainContext srcContext, final FilterChainContext copiedContext) Implements org.glassfish.grizzly.filterchain.FilterChainContext.CopyListener.onCopy. Doc from org.glassfish.grizzly.filterchain.FilterChainContext.CopyListener.onCopy. The method is called, when passed `FilterChainContext` is copied. Annotations @Override

public void onCopy(final FilterChainContext srcContext, final FilterChainContext copiedContext)

Implements org.glassfish.grizzly.filterchain.FilterChainContext.CopyListener.onCopy.

Doc from org.glassfish.grizzly.filterchain.FilterChainContext.CopyListener.onCopy.

The method is called, when passed FilterChainContext is copied.

Annotations

@Override

public Class PUFilter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PUFilter.InternalCompletionHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PUFilter.InternalProcessingHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PUFilter.SuspendedContextCopyListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail