Package org.atmosphere.jersey

Class SuspendResponse.SuspendResponseBuilder<E>

java.lang.Object
com.sun.jersey.api.JResponse.AJResponseBuilder<E,SuspendResponse.SuspendResponseBuilder<E>>
org.atmosphere.jersey.SuspendResponse.SuspendResponseBuilder<E>
Type Parameters:
E -
Enclosing class:
SuspendResponse<E>
public static class SuspendResponse.SuspendResponseBuilder<E> extends com.sun.jersey.api.JResponse.AJResponseBuilder<E,SuspendResponse.SuspendResponseBuilder<E>>
A Builder for SuspendResponse

  • Field Details

    • suspendTimeout

      protected SuspendResponse.TimeSpan suspendTimeout

    • scope

      protected org.atmosphere.annotation.Suspend.SCOPE scope

    • outputComments

      protected boolean outputComments

    • resumeOnBroadcast

      protected boolean resumeOnBroadcast

    • listeners

      protected final Collection<org.atmosphere.cpr.AtmosphereResourceEventListener> listeners

  • Constructor Details

    • SuspendResponseBuilder

      public SuspendResponseBuilder()
      Default constructor.

    • SuspendResponseBuilder

      public SuspendResponseBuilder(SuspendResponse.SuspendResponseBuilder<E> that)
      Construct a shallow copy. The metadata map will be copied but not the key/value references.
      Parameters:
      that - the AJResponseBuilder to copy from.

  • Method Details

    • scope

      public SuspendResponse.SuspendResponseBuilder<E> scope(org.atmosphere.annotation.Suspend.SCOPE scope)
      Set the Suspend.SCOPE value
      Parameters:
      scope - Suspend.SCOPE value
      Returns:
      this

    • period

      public SuspendResponse.SuspendResponseBuilder<E> period(int suspendTimeout, TimeUnit timeUnit)
      Set the timeout period.
      Parameters:
      suspendTimeout - the period
      timeUnit - the TimeUnit
      Returns:
      this

    • outputComments

      public SuspendResponse.SuspendResponseBuilder<E> outputComments(boolean outputComments)
      Set true to tell Atmosphere to write comments when suspending.
      Parameters:
      outputComments - true to tell Atmosphere to write comments when suspending
      Returns:
      this

    • resumeOnBroadcast

      public SuspendResponse.SuspendResponseBuilder<E> resumeOnBroadcast(boolean resumeOnBroadcast)
      Set to true to resume the connection on the first Broadcaster.broadcast(Object)
      Parameters:
      resumeOnBroadcast - true to resume the connection on the first Broadcaster.broadcast(Object)
      Returns:
      this

    • broadcaster

      public SuspendResponse.SuspendResponseBuilder<E> broadcaster(org.atmosphere.cpr.Broadcaster broadcaster)
      Set the Broadcaster
      Parameters:
      broadcaster - Broadcaster
      Returns:
      this

    • writeEntity

      public SuspendResponse.SuspendResponseBuilder<E> writeEntity(boolean writeEntity)
      Write the returned entity back to the calling connection. Default is false.

    • addListener

      public SuspendResponse.SuspendResponseBuilder<E> addListener(org.atmosphere.cpr.AtmosphereResourceEventListener e)
      Add AtmosphereResourceEventListener
      Parameters:
      e - AtmosphereResourceEventListener
      Returns:
      this

    • build

      public SuspendResponse<E> build()
      Build the SuspendResponse
      Returns:
      an instance of SuspendResponse