org.eclipse.jetty.websocket.common.extensions

Class AbstractExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.common.extensions.AbstractExtension

All Implemented Interfaces:

Container, Destroyable, Dumpable, LifeCycle, Extension, IncomingFrames, OutgoingFrames

Direct Known Subclasses:

CompressExtension, FragmentExtension, FrameDebugExtension, IdentityExtension

@ManagedObject(value="Abstract Extension")
public abstract class AbstractExtension
extends ContainerLifeCycle
implements Extension

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
AbstractExtension()

Method Summary

Methods

Modifier and Type	Method and Description
void	dump(Appendable out, String indent)
protected void	dumpWithHeading(Appendable out, String indent, String heading, Object bean)
ByteBufferPool	getBufferPool()
ExtensionConfig	getConfig() The active configuration for this extension.
LogicalConnection	getConnection()
String	getName() The Sec-WebSocket-Extensions name for this extension.
IncomingFrames	getNextIncoming()
OutgoingFrames	getNextOutgoing()
WebSocketPolicy	getPolicy()
void	incomingError(Throwable e)
boolean	isRsv1User() Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.
boolean	isRsv2User() Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.
boolean	isRsv3User() Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.
protected void	nextIncomingError(Throwable e)
protected void	nextIncomingFrame(Frame frame)
protected void	nextOutgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)
void	setBufferPool(ByteBufferPool bufferPool)
void	setConfig(ExtensionConfig config)
void	setConnection(LogicalConnection connection)
void	setNextIncomingFrames(IncomingFrames nextIncoming) Set the next IncomingFrames to call in the chain.
void	setNextOutgoingFrames(OutgoingFrames nextOutgoing) Set the next OutgoingFrames to call in the chain.
void	setPolicy(WebSocketPolicy policy)
String	toString()

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, doStop, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.websocket.api.extensions.IncomingFrames

incomingFrame

Methods inherited from interface org.eclipse.jetty.websocket.api.extensions.OutgoingFrames

outgoingFrame

Constructor Detail

AbstractExtension

public AbstractExtension()

Method Detail

dump

public void dump(Appendable out,
        String indent)
          throws IOException

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Throws:

IOException

dumpWithHeading

protected void dumpWithHeading(Appendable out,
                   String indent,
                   String heading,
                   Object bean)
                        throws IOException

Throws:

IOException

getBufferPool

public ByteBufferPool getBufferPool()

getConfig

public ExtensionConfig getConfig()

Description copied from interface: Extension

The active configuration for this extension.

Specified by:

getConfig in interface Extension

Returns:

the configuration for this extension. never null.

getConnection

public LogicalConnection getConnection()

getName

public String getName()

Description copied from interface: Extension

The Sec-WebSocket-Extensions name for this extension.

Also known as the extension-token per Section 9.1. Negotiating Extensions.

Specified by:

getName in interface Extension

getNextIncoming

@ManagedAttribute(name="Next Incoming Frame Handler",
                  readonly=true)
public IncomingFrames getNextIncoming()

getNextOutgoing

@ManagedAttribute(name="Next Outgoing Frame Handler",
                  readonly=true)
public OutgoingFrames getNextOutgoing()

getPolicy

public WebSocketPolicy getPolicy()

incomingError

public void incomingError(Throwable e)

Specified by:

incomingError in interface IncomingFrames

isRsv1User

public boolean isRsv1User()

Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing.

This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV1.

Specified by:

isRsv1User in interface Extension

Returns:

true if extension uses RSV1 for its own purposes.

isRsv2User

public boolean isRsv2User()

Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing.

This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV2.

Specified by:

isRsv2User in interface Extension

Returns:

true if extension uses RSV2 for its own purposes.

isRsv3User

public boolean isRsv3User()

Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing.

This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV3.

Specified by:

isRsv3User in interface Extension

Returns:

true if extension uses RSV3 for its own purposes.

nextIncomingError

protected void nextIncomingError(Throwable e)

nextIncomingFrame

protected void nextIncomingFrame(Frame frame)

nextOutgoingFrame

protected void nextOutgoingFrame(Frame frame,
                     WriteCallback callback,
                     BatchMode batchMode)

setBufferPool

public void setBufferPool(ByteBufferPool bufferPool)

setConfig

public void setConfig(ExtensionConfig config)

setConnection

public void setConnection(LogicalConnection connection)

setNextIncomingFrames

public void setNextIncomingFrames(IncomingFrames nextIncoming)

Description copied from interface: Extension

Set the next IncomingFrames to call in the chain.

Specified by:

setNextIncomingFrames in interface Extension

Parameters:

nextIncoming - the next incoming extension

setNextOutgoingFrames

public void setNextOutgoingFrames(OutgoingFrames nextOutgoing)

Description copied from interface: Extension

Set the next OutgoingFrames to call in the chain.

Specified by:

setNextOutgoingFrames in interface Extension

Parameters:

nextOutgoing - the next outgoing extension

setPolicy

public void setPolicy(WebSocketPolicy policy)

toString

public String toString()

Overrides:

toString in class Object