Class AbstractExtension
- java.lang.Object
-
- org.eclipse.jetty.util.component.AbstractLifeCycle
-
- org.eclipse.jetty.websocket.common.extensions.AbstractExtension
-
- All Implemented Interfaces:
Dumpable
,LifeCycle
,Extension
,IncomingFrames
,OutgoingFrames
- Direct Known Subclasses:
CompressExtension
,FragmentExtension
,FrameCaptureExtension
,IdentityExtension
@ManagedObject("Abstract Extension") public abstract class AbstractExtension extends AbstractLifeCycle implements Dumpable, 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.LifeCycle
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
dump()
void
dump(Appendable out, String indent)
protected void
dumpWithHeading(Appendable out, String indent, String heading, Object bean)
ByteBufferPool
getBufferPool()
ExtensionConfig
getConfig()
LogicalConnection
getConnection()
String
getName()
IncomingFrames
getNextIncoming()
OutgoingFrames
getNextOutgoing()
WebSocketPolicy
getPolicy()
void
incomingError(Throwable e)
void
init(WebSocketContainerScope container)
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)
void
setNextOutgoingFrames(OutgoingFrames nextOutgoing)
void
setPolicy(WebSocketPolicy policy)
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 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
-
-
-
-
Method Detail
-
dump
public void dump(Appendable out, String indent) throws IOException
- Specified by:
dump
in interfaceDumpable
- Throws:
IOException
-
dumpWithHeading
protected void dumpWithHeading(Appendable out, String indent, String heading, Object bean) throws IOException
- Throws:
IOException
-
init
public void init(WebSocketContainerScope container)
-
getBufferPool
public ByteBufferPool getBufferPool()
-
getConfig
public ExtensionConfig getConfig()
-
getConnection
public LogicalConnection getConnection()
-
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 interfaceIncomingFrames
-
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 interfaceExtension
- 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 interfaceExtension
- 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 interfaceExtension
- 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)
- Specified by:
setNextIncomingFrames
in interfaceExtension
-
setNextOutgoingFrames
public void setNextOutgoingFrames(OutgoingFrames nextOutgoing)
- Specified by:
setNextOutgoingFrames
in interfaceExtension
-
setPolicy
public void setPolicy(WebSocketPolicy policy)
-
-