WebSocketEndpointConfiguration (Citrus :: Endpoints :: Websocket 3.4.0 API)

All Superinterfaces:

EndpointConfiguration, PollableEndpointConfiguration

All Known Implementing Classes:

AbstractWebSocketEndpointConfiguration, WebSocketClientEndpointConfiguration, WebSocketServerEndpointConfiguration
```
public interface WebSocketEndpointConfiguration
extends PollableEndpointConfiguration
```
Web socket endpoint configuration interface defines set of properties all web socket endpoints should have.

Since:

2.3

Author:

Christoph Deppisch

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getEndpointUri()`	Gets the web socket endpoint uri.
`EndpointUriResolver`	`getEndpointUriResolver()`	Gets the endpointUriResolver.
`CitrusWebSocketHandler`	`getHandler()`	Gets or constructs new web socket handler.
`WebSocketMessageConverter`	`getMessageConverter()`	Gets the message converter.
`void`	`setEndpointUri(String endpointUri)`	Sets the web socket endpoint uri.
`void`	`setEndpointUriResolver(EndpointUriResolver endpointUriResolver)`	Sets the endpoint uri resolver.
`void`	`setHandler(CitrusWebSocketHandler handler)`	Sets web socket handler.
`void`	`setMessageConverter(WebSocketMessageConverter messageConverter)`	Sets the message converter.

Methods inherited from interface com.consol.citrus.endpoint.EndpointConfiguration
getTimeout, setTimeout

Methods inherited from interface com.consol.citrus.endpoint.PollableEndpointConfiguration
getPollingInterval, setPollingInterval

- Method Detail
  - getHandler
```
CitrusWebSocketHandler getHandler()
```
    Gets or constructs new web socket handler.
    
    Returns:
  - setHandler
```
void setHandler(CitrusWebSocketHandler handler)
```
    Sets web socket handler.
  - getEndpointUri
```
String getEndpointUri()
```
    Gets the web socket endpoint uri.
    
    Returns:
  - setEndpointUri
```
void setEndpointUri(String endpointUri)
```
    Sets the web socket endpoint uri.
    
    Parameters:
    
    endpointUri -
  - getMessageConverter
```
WebSocketMessageConverter getMessageConverter()
```
    Gets the message converter.
    
    Returns:
  - setMessageConverter
```
void setMessageConverter(WebSocketMessageConverter messageConverter)
```
    Sets the message converter.
    
    Parameters:
    
    messageConverter -
  - getEndpointUriResolver
```
EndpointUriResolver getEndpointUriResolver()
```
    Gets the endpointUriResolver.
    
    Returns:
    
    the endpointUriResolver
  - setEndpointUriResolver
```
void setEndpointUriResolver(EndpointUriResolver endpointUriResolver)
```
    Sets the endpoint uri resolver.
    
    Parameters:
    
    endpointUriResolver - the endpointUriResolver to set