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.LifeCycle, 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 Extension
  • Field Details

  • Constructor Details

    • AbstractExtension

      public AbstractExtension()
  • Method Details

    • 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()
      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
      Returns:
      the name of the 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()
    • 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.
    • 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)
      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 org.eclipse.jetty.util.component.AbstractLifeCycle