Package org.apache.camel.builder.endpoint.dsl

Interface AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointBuilder
Enclosing interface:
AtmosphereWebsocketEndpointBuilderFactory
public static interface AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Atmosphere Websocket component.

  • Method Details

    • advanced

      default AtmosphereWebsocketEndpointBuilderFactory.AdvancedAtmosphereWebsocketEndpointProducerBuilder advanced()

    • chunked

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder chunked(boolean chunked)
      If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      chunked - the value to set
      Returns:
      the dsl builder

    • chunked

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder chunked(String chunked)
      If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response. The option will be converted to a <code>boolean</code> type. Default: true Group: common
      Parameters:
      chunked - the value to set
      Returns:
      the dsl builder

    • disableStreamCache

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder disableStreamCache(boolean disableStreamCache)
      Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      disableStreamCache - the value to set
      Returns:
      the dsl builder

    • disableStreamCache

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder disableStreamCache(String disableStreamCache)
      Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. The option will be converted to a <code>boolean</code> type. Default: false Group: common
      Parameters:
      disableStreamCache - the value to set
      Returns:
      the dsl builder

    • sendToAll

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder sendToAll(boolean sendToAll)
      Whether to send to all (broadcast) or send to a single receiver. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      sendToAll - the value to set
      Returns:
      the dsl builder

    • sendToAll

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder sendToAll(String sendToAll)
      Whether to send to all (broadcast) or send to a single receiver. The option will be converted to a <code>boolean</code> type. Default: false Group: common
      Parameters:
      sendToAll - the value to set
      Returns:
      the dsl builder

    • transferException

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder transferException(boolean transferException)
      If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      transferException - the value to set
      Returns:
      the dsl builder

    • transferException

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder transferException(String transferException)
      If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option will be converted to a <code>boolean</code> type. Default: false Group: common
      Parameters:
      transferException - the value to set
      Returns:
      the dsl builder

    • useStreaming

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder useStreaming(boolean useStreaming)
      To enable streaming to send data as multiple text fragments. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      useStreaming - the value to set
      Returns:
      the dsl builder

    • useStreaming

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder useStreaming(String useStreaming)
      To enable streaming to send data as multiple text fragments. The option will be converted to a <code>boolean</code> type. Default: false Group: common
      Parameters:
      useStreaming - the value to set
      Returns:
      the dsl builder

    • bridgeEndpoint

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder bridgeEndpoint(boolean bridgeEndpoint)
      If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      bridgeEndpoint - the value to set
      Returns:
      the dsl builder

    • bridgeEndpoint

      default AtmosphereWebsocketEndpointBuilderFactory.AtmosphereWebsocketEndpointProducerBuilder bridgeEndpoint(String bridgeEndpoint)
      If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
      Parameters:
      bridgeEndpoint - the value to set
      Returns:
      the dsl builder