@ManagedObject(value="Abstract Extension") public abstract class AbstractExtension extends AbstractLifeCycle implements Extension
AbstractLifeCycle.AbstractLifeCycleListener
LifeCycle.Listener
Constructor and Description |
---|
AbstractExtension() |
Modifier and Type | Method and Description |
---|---|
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 |
init(WebSocketContainerScope container)
Deprecated.
|
void |
init(WebSocketPolicy policy,
ByteBufferPool bufferPool) |
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.
|
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() |
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
incomingFrame
outgoingFrame
@Deprecated public void init(WebSocketContainerScope container)
public void init(WebSocketPolicy policy, ByteBufferPool bufferPool)
public ByteBufferPool getBufferPool()
public ExtensionConfig getConfig()
Extension
public LogicalConnection getConnection()
public String getName()
Extension
Sec-WebSocket-Extensions
name for this extension.
Also known as the extension-token
per Section 9.1. Negotiating Extensions.
@ManagedAttribute(name="Next Incoming Frame Handler", readonly=true) public IncomingFrames getNextIncoming()
@ManagedAttribute(name="Next Outgoing Frame Handler", readonly=true) public OutgoingFrames getNextOutgoing()
public WebSocketPolicy getPolicy()
public boolean isRsv1User()
This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV1.
isRsv1User
in interface Extension
public boolean isRsv2User()
This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV2.
isRsv2User
in interface Extension
public boolean isRsv3User()
This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV3.
isRsv3User
in interface Extension
public void setBufferPool(ByteBufferPool bufferPool)
public void setConfig(ExtensionConfig config)
public void setConnection(LogicalConnection connection)
public void setNextIncomingFrames(IncomingFrames nextIncoming)
Extension
IncomingFrames
to call in the chain.setNextIncomingFrames
in interface Extension
nextIncoming
- the next incoming extensionpublic void setNextOutgoingFrames(OutgoingFrames nextOutgoing)
Extension
OutgoingFrames
to call in the chain.setNextOutgoingFrames
in interface Extension
nextOutgoing
- the next outgoing extensionpublic void setPolicy(WebSocketPolicy policy)
public String toString()
toString
in class AbstractLifeCycle
Copyright © 2010 - 2020 Adobe. All Rights Reserved