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

Class AbstractExtension

  • All Implemented Interfaces:
    org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.websocket.api.extensions.Extension, org.eclipse.jetty.websocket.api.extensions.IncomingFrames, org.eclipse.jetty.websocket.api.extensions.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.websocket.api.extensions.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, STOPPED, STOPPING

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      org.eclipse.jetty.io.ByteBufferPool getBufferPool()  
      org.eclipse.jetty.websocket.api.extensions.ExtensionConfig getConfig()  
      LogicalConnection getConnection()  
      java.lang.String getName()  
      org.eclipse.jetty.websocket.api.extensions.IncomingFrames getNextIncoming()  
      org.eclipse.jetty.websocket.api.extensions.OutgoingFrames getNextOutgoing()  
      org.eclipse.jetty.websocket.api.WebSocketPolicy getPolicy()  
      void init​(org.eclipse.jetty.websocket.api.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 nextIncomingFrame​(org.eclipse.jetty.websocket.api.extensions.Frame frame)  
      protected void nextOutgoingFrame​(org.eclipse.jetty.websocket.api.extensions.Frame frame, org.eclipse.jetty.websocket.api.WriteCallback callback, org.eclipse.jetty.websocket.api.BatchMode batchMode)  
      void setBufferPool​(org.eclipse.jetty.io.ByteBufferPool bufferPool)  
      void setConfig​(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig config)  
      void setConnection​(LogicalConnection connection)  
      void setNextIncomingFrames​(org.eclipse.jetty.websocket.api.extensions.IncomingFrames nextIncoming)  
      void setNextOutgoingFrames​(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames nextOutgoing)  
      void setPolicy​(org.eclipse.jetty.websocket.api.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 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

      • init

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

      • getBufferPool

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

      • getConfig

        public org.eclipse.jetty.websocket.api.extensions.ExtensionConfig getConfig()
        Specified by:
        getConfig in interface org.eclipse.jetty.websocket.api.extensions.Extension

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface org.eclipse.jetty.websocket.api.extensions.Extension

      • getNextIncoming

        @ManagedAttribute(name="Next Incoming Frame Handler",
                  readonly=true)
public org.eclipse.jetty.websocket.api.extensions.IncomingFrames getNextIncoming()

      • getNextOutgoing

        @ManagedAttribute(name="Next Outgoing Frame Handler",
                  readonly=true)
public org.eclipse.jetty.websocket.api.extensions.OutgoingFrames getNextOutgoing()

      • getPolicy

        public org.eclipse.jetty.websocket.api.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 org.eclipse.jetty.websocket.api.extensions.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 org.eclipse.jetty.websocket.api.extensions.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 org.eclipse.jetty.websocket.api.extensions.Extension
        Returns:
        true if extension uses RSV3 for its own purposes.

      • nextIncomingFrame

        protected void nextIncomingFrame​(org.eclipse.jetty.websocket.api.extensions.Frame frame)

      • nextOutgoingFrame

        protected void nextOutgoingFrame​(org.eclipse.jetty.websocket.api.extensions.Frame frame,
                                 org.eclipse.jetty.websocket.api.WriteCallback callback,
                                 org.eclipse.jetty.websocket.api.BatchMode batchMode)

      • setBufferPool

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

      • setConfig

        public void setConfig​(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig config)

      • setNextIncomingFrames

        public void setNextIncomingFrames​(org.eclipse.jetty.websocket.api.extensions.IncomingFrames nextIncoming)
        Specified by:
        setNextIncomingFrames in interface org.eclipse.jetty.websocket.api.extensions.Extension

      • setNextOutgoingFrames

        public void setNextOutgoingFrames​(org.eclipse.jetty.websocket.api.extensions.OutgoingFrames nextOutgoing)
        Specified by:
        setNextOutgoingFrames in interface org.eclipse.jetty.websocket.api.extensions.Extension

      • setPolicy

        public void setPolicy​(org.eclipse.jetty.websocket.api.WebSocketPolicy policy)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.eclipse.jetty.util.component.AbstractLifeCycle