Package org.apache.camel.component.websocket

Class WebsocketConstants

java.lang.Object

org.apache.camel.component.websocket.WebsocketConstants

public final class WebsocketConstants
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECTION_KEY
static final String	DEFAULT_HOST
static final int	DEFAULT_PORT
static final String	RELATIVE_PATH
static final String	REMOTE_ADDRESS
static final String	SEND_TO_ALL
static final String	SUBPROTOCOL
static final String	WS_PROTOCOL
static final String	WSS_PROTOCOL

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

• Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

• Constant Field Values

CONNECTION_KEY

@Metadata(description="*Producer:* Sends the message to all clients which are currently connected. You can\nuse the `sendToAll` option on the endpoint instead of using this header.\n*Consumer:* Connection key identifying an individual client connection. You can save this and specify it again when routing to a producer endpoing in order to direct messages to a specific connected client.",
          javaType="String")
public static final String CONNECTION_KEY

See Also:

• Constant Field Values

SEND_TO_ALL

@Metadata(label="producer",
          description="Sends the message to all clients which are currently connected. You can use the sendToAll option on the endpoint instead of using this header.",
          javaType="Boolean")
public static final String SEND_TO_ALL

See Also:

• Constant Field Values

REMOTE_ADDRESS

@Metadata(label="consumer",
          description="Remote address of the websocket session.",
          javaType="java.net.InetSocketAddress")
public static final String REMOTE_ADDRESS

See Also:

• Constant Field Values

SUBPROTOCOL

@Metadata(label="consumer",
          description="If a specific subprotocol was negotiated, it will be specfied in this header. Note that if you specify the \"any\" subprotocol to be supported, and a client requests a specific subprotocol, the connection will be accepted without a specific subprotocol being used. You need to specifically support a given protocol by name if you want it returned to the client and to show up in the message header.",
          javaType="String")
public static final String SUBPROTOCOL

See Also:

• Constant Field Values

RELATIVE_PATH

@Metadata(label="consumer",
          description="If you specify a wildcard URI path for an endpoint, and a websocket client connects to that websocket endpoing, the relative path that the client specified will be provided in this header.\n\nFor example, if you specified `websocket://0.0.0.0:80/api/*` as your endpoint URI, and a client connects to the server at `ws://host.com/api/specialized/apipath` then `specialized/apipath` is provided in the relative path header of all messages from that client.",
          javaType="String")
public static final String RELATIVE_PATH

See Also:

• Constant Field Values

WS_PROTOCOL

public static final String WS_PROTOCOL

See Also:

• Constant Field Values

WSS_PROTOCOL

public static final String WSS_PROTOCOL

See Also:

• Constant Field Values