Package org.eclipse.jetty.websocket.common.extensions

Class AbstractExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

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

All Implemented Interfaces:

org.eclipse.jetty.util.component.Dumpable, Extension, IncomingFrames, OutgoingFrames

Direct Known Subclasses:

CompressExtension, FragmentExtension, FrameCaptureExtension, IdentityExtension

@ManagedObject("Abstract Extension")
public abstract class AbstractExtension
extends org.eclipse.jetty.util.component.AbstractLifeCycle
implements org.eclipse.jetty.util.component.Dumpable, Extension

Nested Class Summary

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

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

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

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
AbstractExtension()

Method Summary

Modifier and Type	Method	Description
java.lang.String	dump()
void	dump(java.lang.Appendable out, java.lang.String indent)
protected void	dumpWithHeading(java.lang.Appendable out, java.lang.String indent, java.lang.String heading, java.lang.Object bean)
org.eclipse.jetty.io.ByteBufferPool	getBufferPool()
ExtensionConfig	getConfig()
LogicalConnection	getConnection()
java.lang.String	getName()
IncomingFrames	getNextIncoming()
OutgoingFrames	getNextOutgoing()
WebSocketPolicy	getPolicy()
void	incomingError(java.lang.Throwable e)
void	init(WebSocketPolicy policy, org.eclipse.jetty.io.ByteBufferPool bufferPool)
void	init(WebSocketContainerScope container)	Deprecated.
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(java.lang.Throwable e)
protected void	nextIncomingFrame(Frame frame)
protected void	nextOutgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)
void	setBufferPool(org.eclipse.jetty.io.ByteBufferPool bufferPool)
void	setConfig(ExtensionConfig config)
void	setConnection(LogicalConnection connection)
void	setNextIncomingFrames(IncomingFrames nextIncoming)
void	setNextOutgoingFrames(OutgoingFrames nextOutgoing)
void	setPolicy(WebSocketPolicy policy)
java.lang.String	toString()

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

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

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

incomingFrame

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

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.OutgoingFrames

outgoingFrame

Constructor Detail

AbstractExtension

public AbstractExtension()

Method Detail

dump

public java.lang.String dump()

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

dump

public void dump(java.lang.Appendable out,
                 java.lang.String indent)
          throws java.io.IOException

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Throws:

java.io.IOException

dumpWithHeading

protected void dumpWithHeading(java.lang.Appendable out,
                               java.lang.String indent,
                               java.lang.String heading,
                               java.lang.Object bean)
                        throws java.io.IOException

Throws:

java.io.IOException

init

@Deprecated
public void init(WebSocketContainerScope container)

Deprecated.

init

public void init(WebSocketPolicy policy,
                 org.eclipse.jetty.io.ByteBufferPool bufferPool)

getBufferPool

public org.eclipse.jetty.io.ByteBufferPool getBufferPool()

getConfig

public ExtensionConfig getConfig()

Specified by:

getConfig in interface Extension

getConnection

public LogicalConnection getConnection()

getName

public java.lang.String getName()

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(java.lang.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(java.lang.Throwable e)

nextIncomingFrame

protected void nextIncomingFrame(Frame frame)

nextOutgoingFrame

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

setBufferPool

public void setBufferPool(org.eclipse.jetty.io.ByteBufferPool bufferPool)

setConfig

public void setConfig(ExtensionConfig config)

setConnection

public void setConnection(LogicalConnection connection)

setNextIncomingFrames

public void setNextIncomingFrames(IncomingFrames nextIncoming)

Specified by:

setNextIncomingFrames in interface Extension

setNextOutgoingFrames

public void setNextOutgoingFrames(OutgoingFrames nextOutgoing)

Specified by:

setNextOutgoingFrames in interface Extension

setPolicy

public void setPolicy(WebSocketPolicy policy)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object