org.wso2.transport.http.netty.contract

Interface HttpWsConnectorFactory

All Known Implementing Classes:

DefaultHttpWsConnectorFactory

public interface HttpWsConnectorFactory

Allows you create server and client connectors.

Method Summary

Modifier and Type	Method and Description
HttpClientConnector	createHttpClientConnector(BootstrapConfiguration bootstrapConfiguration, SenderConfiguration senderConfiguration, ConnectionManager connectionManager) Creates a client connector with given client bootstrap configuration and connection manager.
HttpClientConnector	createHttpClientConnector(Map<String,Object> transportProperties, SenderConfiguration senderConfiguration) This method can be used to get http client connectors.
HttpClientConnector	createHttpClientConnector(Map<String,Object> transportProperties, SenderConfiguration senderConfiguration, ConnectionManager connectionManager) Creates a client connector with a given connection manager.
ServerConnector	createServerConnector(ServerBootstrapConfiguration serverBootstrapConfiguration, ListenerConfiguration listenerConfiguration) This method can be used to get new server connectors.
WebSocketClientConnector	createWsClientConnector(WebSocketClientConnectorConfig clientConnectorConfig) This method is used to get WebSocket client connector.
void	shutdown() Shutdown all the server channels and the accepted channels.

Method Detail

createServerConnector

ServerConnector createServerConnector(ServerBootstrapConfiguration serverBootstrapConfiguration,
                                      ListenerConfiguration listenerConfiguration)

This method can be used to get new server connectors.

Parameters:

serverBootstrapConfiguration - configTargetHandler socket related stuff.

listenerConfiguration - contains SSL and socket bindings.

Returns:

connector that represents the server socket and additional details.

createHttpClientConnector

HttpClientConnector createHttpClientConnector(Map<String,Object> transportProperties,
                                              SenderConfiguration senderConfiguration)

This method can be used to get http client connectors.

Parameters:

transportProperties - configTargetHandler stuff like global timeout, number of outbound connections, etc.

senderConfiguration - contains SSL configuration and endpoint details.

Returns:

HttpClientConnector.

createHttpClientConnector

HttpClientConnector createHttpClientConnector(Map<String,Object> transportProperties,
                                              SenderConfiguration senderConfiguration,
                                              ConnectionManager connectionManager)

Creates a client connector with a given connection manager.

Parameters:

transportProperties - Represents the configurations related to HTTP client

senderConfiguration - Represents the configurations related to client channel creation

connectionManager - Manages the client pool

Returns:

the HttpClientConnector

createHttpClientConnector

HttpClientConnector createHttpClientConnector(BootstrapConfiguration bootstrapConfiguration,
                                              SenderConfiguration senderConfiguration,
                                              ConnectionManager connectionManager)

Creates a client connector with given client bootstrap configuration and connection manager.

Parameters:

bootstrapConfiguration - Represents the client bootstrap configurations.

senderConfiguration - Represents the configurations related to client channel creation

connectionManager - Manages the client pool

Returns:

the HttpClientConnector

createWsClientConnector

WebSocketClientConnector createWsClientConnector(WebSocketClientConnectorConfig clientConnectorConfig)

This method is used to get WebSocket client connector.

Parameters:

clientConnectorConfig - Properties to create a client connector.

Returns:

WebSocketClientConnector.

shutdown

void shutdown()
       throws InterruptedException

Shutdown all the server channels and the accepted channels. It also shutdown all the eventloop groups.

Throws:

InterruptedException - when interrupted by some other event