org.granite.client.messaging.channel

Interface ChannelBuilder

All Known Implementing Classes:

DefaultChannelBuilder

public interface ChannelBuilder

SPI for builders of remoting and messaging channels Modules that provide custom channels should also register a ChannelBuilder implementation in the ServiceLoader registry (i.e. a file META-INF/services/org.granite.client.messaging.channel.ChannelBuilder) The ChannelFactory will look for all registered channel builders and find the first one able to build the requested channel type. A ChannelBuilder should return null for any of the interface methods it can't fulfill.

Author:

William DRAI

Method Summary

Methods

Modifier and Type	Method and Description
MessagingChannel	buildMessagingChannel(java.lang.String channelType, java.lang.String id, ServerApp serverApp, Transport transport, MessagingCodec<Message[]> codec) Build a messaging channel with the specified server application ServerApp
MessagingChannel	buildMessagingChannel(java.lang.String channelType, java.lang.String id, java.net.URI uri, Transport transport, MessagingCodec<Message[]> codec) Build a messaging channel with the specified URI
RemotingChannel	buildRemotingChannel(java.lang.Class<? extends RemotingChannel> channelClass, java.lang.String id, ServerApp serverApp, int maxConcurrentRequests, Transport transport, MessagingCodec<AMF0Message> codec) Build a remoting channel with the specified server application ServerApp
RemotingChannel	buildRemotingChannel(java.lang.Class<? extends RemotingChannel> channelClass, java.lang.String id, java.net.URI uri, int maxConcurrentRequests, Transport transport, MessagingCodec<AMF0Message> codec) Build a remoting channel with the specified URI

Method Detail

buildRemotingChannel

RemotingChannel buildRemotingChannel(java.lang.Class<? extends RemotingChannel> channelClass,
                                   java.lang.String id,
                                   java.net.URI uri,
                                   int maxConcurrentRequests,
                                   Transport transport,
                                   MessagingCodec<AMF0Message> codec)

Build a remoting channel with the specified URI

Parameters:

channelClass - channel class

id - channel id

uri - channel uri

maxConcurrentRequests - max concurrent requests

transport - transport for the channel

codec - codec to apply to the transmitted messages

Returns:

a new remoting channel

buildRemotingChannel

RemotingChannel buildRemotingChannel(java.lang.Class<? extends RemotingChannel> channelClass,
                                   java.lang.String id,
                                   ServerApp serverApp,
                                   int maxConcurrentRequests,
                                   Transport transport,
                                   MessagingCodec<AMF0Message> codec)

Build a remoting channel with the specified server application ServerApp

Parameters:

channelClass - channel class

id - channel id

serverApp - server application

maxConcurrentRequests - max concurrent requests

transport - transport for the channel

codec - codec to apply to the transmitted messages

Returns:

a new remoting channel

buildMessagingChannel

MessagingChannel buildMessagingChannel(java.lang.String channelType,
                                     java.lang.String id,
                                     java.net.URI uri,
                                     Transport transport,
                                     MessagingCodec<Message[]> codec)

Build a messaging channel with the specified URI

Parameters:

channelType - channel type ChannelType

id - channel id

uri - channel uri

transport - transport for the channel

codec - codec to apply to the transmitted messages

Returns:

a new messaging channel

buildMessagingChannel

MessagingChannel buildMessagingChannel(java.lang.String channelType,
                                     java.lang.String id,
                                     ServerApp serverApp,
                                     Transport transport,
                                     MessagingCodec<Message[]> codec)

Build a messaging channel with the specified server application ServerApp

Parameters:

channelType - channel type ChannelType

id - channel id

serverApp - server application definition

transport - transport for the channel

codec - codec to apply to the transmitted messages

Returns:

a new messaging channel