Package org.apache.juneau.console

Class BridgeDecl

java.lang.Object
org.apache.juneau.console.BridgeDecl
public final class BridgeDecl extends Object
Declares one server bridge in the page contract's bridges list.
Example:

PageSpec.create() .topic(TopicDecl.of("ops.jobs").retain(true).publisher(TopicDecl.Publisher.SERVER)) .bridge(BridgeDecl.sse("ops", "servlet:/juneau-bus/session").downstream("ops.jobs", Topics.cmd("jobs"))); // WebSocket, with an upstream topic a ribbon item publishes: BridgeDecl.websocket("ops", "servlet:/juneau-bus/session") .downstream("ops.jobs").upstream("ops.cancel-all");

Since:
10.0.0

  • Method Details

    • sse

      public static BridgeDecl sse(String id, String sessionUrl)
      Parameters:
      id - The bridge id. @param sessionUrl The session-POST URL. @return A new downstream-only SSE bridge.

    • websocket

      public static BridgeDecl websocket(String id, String sessionUrl)
      Parameters:
      id - The bridge id. @param sessionUrl The session-POST URL. @return A new WebSocket bridge.

    • downstream

      public BridgeDecl downstream(String... topicPatterns)
      Parameters:
      topicPatterns - Topics the page accepts from the server; appends. @return This object.

    • upstream

      public BridgeDecl upstream(String... topics)
      Parameters:
      topics - Custom topics forwarded to the server; appends. WebSocket only. @return This object.

    • maxAttempts

      public BridgeDecl maxAttempts(int v)
      Parameters:
      v - Give up after this many failed attempts (at least 1); unset retries while the page is open. @return This object.

    • id

      public String id()
      Returns:
      The id.

    • toMap

      public JsonMap toMap()
      Returns:
      The $defs/bridgeDecl entry, with session unresolved.