org.granite.client.messaging.channel

Class DefaultChannelBuilder

java.lang.Object

org.granite.client.messaging.channel.DefaultChannelBuilder

All Implemented Interfaces:

ChannelBuilder

public class DefaultChannelBuilder
extends java.lang.Object
implements ChannelBuilder

Default implementation of ChannelBuilder handling the built-in channel types (long polling and websocket) This can also be used to specify custom url mappings for the server channel uris: channelFactory.setChannelBuilder(new DefaultChannelBuilder("/customremoting/amf", "/customgravity/amf", "/customws/amf"); channelFactory.start();

Author:

William DRAI

Constructor Summary

Constructors

Constructor and Description
DefaultChannelBuilder() Create a channel builder with conventional defaults for url mappings
DefaultChannelBuilder(java.lang.String graniteUrlMapping, java.lang.String gravityUrlMapping, java.lang.String websocketUrlMapping) Create a channel builder with specified url mappings

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 maxConcurrentRequest, 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
void	setGraniteUrlMapping(java.lang.String graniteUrlMapping) Set url mapping for remoting
void	setGravityUrlMapping(java.lang.String gravityUrlMapping) Set url mapping for long polling
void	setWebsocketUrlMapping(java.lang.String websocketUrlMapping) Set url mapping for websocket

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultChannelBuilder

public DefaultChannelBuilder()

Create a channel builder with conventional defaults for url mappings

DefaultChannelBuilder

public DefaultChannelBuilder(java.lang.String graniteUrlMapping,
                     java.lang.String gravityUrlMapping,
                     java.lang.String websocketUrlMapping)

Create a channel builder with specified url mappings

Parameters:

graniteUrlMapping - url mapping for remoting

gravityUrlMapping - url mapping for long polling

websocketUrlMapping - url mapping for websocket

Method Detail

setGraniteUrlMapping

public void setGraniteUrlMapping(java.lang.String graniteUrlMapping)

Set url mapping for remoting

Parameters:

graniteUrlMapping - url mapping

setGravityUrlMapping

public void setGravityUrlMapping(java.lang.String gravityUrlMapping)

Set url mapping for long polling

Parameters:

gravityUrlMapping - url mapping

setWebsocketUrlMapping

public void setWebsocketUrlMapping(java.lang.String websocketUrlMapping)

Set url mapping for websocket

Parameters:

websocketUrlMapping - url mapping

buildRemotingChannel

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

Description copied from interface: ChannelBuilder

Build a remoting channel with the specified URI

Specified by:

buildRemotingChannel in interface ChannelBuilder

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

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

Description copied from interface: ChannelBuilder

Build a remoting channel with the specified server application ServerApp

Specified by:

buildRemotingChannel in interface ChannelBuilder

Parameters:

channelClass - channel class

id - channel id

serverApp - server application

maxConcurrentRequest - max concurrent requests

transport - transport for the channel

codec - codec to apply to the transmitted messages

Returns:

a new remoting channel

buildMessagingChannel

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

Description copied from interface: ChannelBuilder

Build a messaging channel with the specified URI

Specified by:

buildMessagingChannel in interface ChannelBuilder

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

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

Description copied from interface: ChannelBuilder

Build a messaging channel with the specified server application ServerApp

Specified by:

buildMessagingChannel in interface ChannelBuilder

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