org.granite.client.messaging.channel

Interface ChannelFactory

All Known Implementing Classes:

AbstractChannelFactory, AMFChannelFactory, JMFChannelFactory

public interface ChannelFactory

ChannelFactory is the main entry point for using the low-level GraniteDS remoting and messaging API. It can be used to create new channels and attach them to the underlying transports Transport. The usual way of using ChannelFactory is as follows:

 ChannelFactory channelFactory = new JMFChannelFactory();
 channelFactory.start();
 RemotingChannel remotingCannel = channelFactory.newRemotingChannel("remoting", "http://localhost:8080/myapp/graniteamf/amf.txt");
 MessagingChannel messagingChannel = channelFactory.newMessagingChannel("messaging", "http://localhost:8080/myapp/gravityamf/amf.txt");
 MessagingChannel websocketChannel = channelFactory.newMessagingChannel(ChannelType.WEBSOCKET, "websocket", "ws://localhost:8080/myapp/websocketamf/amf");
 
 

Author:

Franck WOLFF

Method Summary

Methods

Modifier and Type	Method and Description
ContentType	getContentType() The encoding (AMF or JMF) for this ChannelFactory
java.lang.Object	getContext() A generic context object used to create transports (actual type of the context depends on the Platform)
java.lang.String	getDefaultChannelType() Return the default type of messaging channels (initially ChannelType.LONG_POLLING)
long	getDefaultTimeToLive() The default time to live defined for channels created by this factory
Transport	getMessagingTransport() The default transport for messaging channels
Transport	getMessagingTransport(java.lang.String channelType) The transport for the specified messaging channel type
java.util.Map<java.lang.String,Transport>	getMessagingTransports() The transports for messaging channels
Transport	getRemotingTransport() The transport for remoting channels
MessagingChannel	newMessagingChannel(java.lang.String id, ServerApp serverApp) Create a messaging channel of the default type using the specified server application definition
MessagingChannel	newMessagingChannel(java.lang.String id, java.lang.String uri) Create a messaging channel of the default type using the specified uri
MessagingChannel	newMessagingChannel(java.lang.String channelType, java.lang.String id, ServerApp serverApp) Create a messaging channel of the specified type using the specified server application definition
MessagingChannel	newMessagingChannel(java.lang.String channelType, java.lang.String id, java.lang.String uri) Create a messaging channel of the specified type using the specified uri
MessagingChannel	newMessagingChannel(java.lang.String channelType, java.lang.String id, java.net.URI uri) Create a messaging channel of the specified type using the specified URI
MessagingChannel	newMessagingChannel(java.lang.String id, java.net.URI uri) Create a messaging channel of the default type using the specified URI
RemotingChannel	newRemotingChannel(java.lang.String id, ServerApp serverApp) Create a remoting channel using the specified server application definition
RemotingChannel	newRemotingChannel(java.lang.String id, ServerApp serverApp, int maxConcurrentRequests) Create a remoting channel using the specified server application definition
RemotingChannel	newRemotingChannel(java.lang.String id, java.lang.String uri) Create a remoting channel using the specified uri
RemotingChannel	newRemotingChannel(java.lang.String id, java.lang.String uri, int maxConcurrentRequests) Create a remoting channel using the specified uri
RemotingChannel	newRemotingChannel(java.lang.String id, java.net.URI uri) Create a remoting channel using the specified URI
RemotingChannel	newRemotingChannel(java.lang.String id, java.net.URI uri, int maxConcurrentRequests) Create a remoting channel using the specified URI
void	setAliasRegistry(AliasRegistry aliasRegistry) The alias registry for this factory
void	setContext(java.lang.Object context) Set the current context used to create transports (actual type of this context depends on the Platform)
void	setDefaultChannelBuilder(ChannelBuilder channelBuilder) Set the default builder for channels A custom channel builder can also be defined to change the default url mappings of the remoting and messaging channels
void	setDefaultChannelType(java.lang.String channelType) Set the default type of messaging channels (initially ChannelType.LONG_POLLING)
void	setDefaultTimeToLive(long defaultTimeToLive) Set the default time to live for the channels created by this factory
void	setMessagingTransport(java.lang.String channelType, Transport messagingTransport) Set the transport for the specified messaging channel type
void	setMessagingTransport(Transport messagingTransport) Set the default transport for messaging channels
void	setRemotingTransport(Transport remotingTransport) Set the transport for remoting channels
void	setScanPackageNames(java.util.Set<java.lang.String> packageNames) Set of package names to scan The classes of these packages will be scanned during the start of this factory to find aliased classes
void	start() Start this ChannelFactory Must be called before trying to create channels and after all properties have been set.
void	stop() Stop this ChannelFactory All defined transports are also stopped and unregistered.
void	stop(boolean stopTransports) Stop this ChannelFactory Optionally when stopTransports is true all defined transports are also stopped and unregistered.

Method Detail

getContentType

ContentType getContentType()

The encoding (AMF or JMF) for this ChannelFactory

Returns:

the content type

See Also:

ContentType

getDefaultTimeToLive

long getDefaultTimeToLive()

The default time to live defined for channels created by this factory

Returns:

time to live in milliseconds

setDefaultTimeToLive

void setDefaultTimeToLive(long defaultTimeToLive)

Set the default time to live for the channels created by this factory

Parameters:

defaultTimeToLive - time to live in milliseconds

getContext

java.lang.Object getContext()

A generic context object used to create transports (actual type of the context depends on the Platform)

Returns:

current context

See Also:

Transport

setContext

void setContext(java.lang.Object context)

Set the current context used to create transports (actual type of this context depends on the Platform)

Parameters:

context - current context

See Also:

Transport

setDefaultChannelType

void setDefaultChannelType(java.lang.String channelType)

Set the default type of messaging channels (initially ChannelType.LONG_POLLING)

Parameters:

channelType - default type of messaging channels

See Also:

ChannelType

getDefaultChannelType

java.lang.String getDefaultChannelType()

Return the default type of messaging channels (initially ChannelType.LONG_POLLING)

Returns:

default type of messaging channels

setDefaultChannelBuilder

void setDefaultChannelBuilder(ChannelBuilder channelBuilder)

Set the default builder for channels A custom channel builder can also be defined to change the default url mappings of the remoting and messaging channels

Parameters:

channelBuilder - the channel builder

See Also:

DefaultChannelBuilder

getRemotingTransport

Transport getRemotingTransport()

The transport for remoting channels

Returns:

transport

See Also:

Transport

setRemotingTransport

void setRemotingTransport(Transport remotingTransport)

Set the transport for remoting channels

Parameters:

remotingTransport - transport

See Also:

Transport

setMessagingTransport

void setMessagingTransport(Transport messagingTransport)

Set the default transport for messaging channels

Parameters:

messagingTransport - transport

setMessagingTransport

void setMessagingTransport(java.lang.String channelType,
                         Transport messagingTransport)

Set the transport for the specified messaging channel type

Parameters:

channelType - channel type

messagingTransport - transport

See Also:

ChannelType, Transport

getMessagingTransport

Transport getMessagingTransport()

The default transport for messaging channels

Returns:

the transport

See Also:

Transport

getMessagingTransports

java.util.Map<java.lang.String,Transport> getMessagingTransports()

The transports for messaging channels

Returns:

a map of transports keyed by channel type

getMessagingTransport

Transport getMessagingTransport(java.lang.String channelType)

The transport for the specified messaging channel type

Parameters:

channelType - channel type

Returns:

the transport

See Also:

ChannelType, Transport

setAliasRegistry

void setAliasRegistry(AliasRegistry aliasRegistry)

The alias registry for this factory

Parameters:

aliasRegistry - alias registry

See Also:

AliasRegistry

setScanPackageNames

void setScanPackageNames(java.util.Set<java.lang.String> packageNames)

Set of package names to scan The classes of these packages will be scanned during the start of this factory to find aliased classes

Parameters:

packageNames -

See Also:

AliasRegistry

start

void start()

Start this ChannelFactory Must be called before trying to create channels and after all properties have been set.

stop

void stop()

Stop this ChannelFactory All defined transports are also stopped and unregistered. After stop, it is recommended to create a new ChannelFactory instead of restarting an existing one.

stop

void stop(boolean stopTransports)

Stop this ChannelFactory Optionally when stopTransports is true all defined transports are also stopped and unregistered. If the transportshe ChannelFactory should not be restarted after stop, a new ChannelFactory should be created.

Parameters:

stopTransports - true to stop associated transports

newRemotingChannel

RemotingChannel newRemotingChannel(java.lang.String id,
                                 java.lang.String uri)

Create a remoting channel using the specified uri

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

Returns:

a new initialized messaging channel

See Also:

RemotingChannel

newRemotingChannel

RemotingChannel newRemotingChannel(java.lang.String id,
                                 java.lang.String uri,
                                 int maxConcurrentRequests)

Create a remoting channel using the specified uri

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

maxConcurrentRequests - maximum number of concurrent requests

Returns:

an initializer channel

See Also:

RemotingChannel

newMessagingChannel

MessagingChannel newMessagingChannel(java.lang.String id,
                                   java.lang.String uri)

Create a messaging channel of the default type using the specified uri

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

Returns:

an initializer channel

See Also:

MessagingChannel

newMessagingChannel

MessagingChannel newMessagingChannel(java.lang.String channelType,
                                   java.lang.String id,
                                   java.lang.String uri)

Create a messaging channel of the specified type using the specified uri

Parameters:

channelType - a channel type

id - identifier for this channel

uri - uri of the server to connect to

Returns:

a new initialized messaging channel

See Also:

ChannelType, MessagingChannel

newRemotingChannel

RemotingChannel newRemotingChannel(java.lang.String id,
                                 java.net.URI uri)

Create a remoting channel using the specified URI

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

Returns:

a new initialized messaging channel

See Also:

RemotingChannel

newRemotingChannel

RemotingChannel newRemotingChannel(java.lang.String id,
                                 java.net.URI uri,
                                 int maxConcurrentRequests)

Create a remoting channel using the specified URI

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

maxConcurrentRequests - maximum number of concurrent requests

Returns:

an initializer channel

See Also:

RemotingChannel

newMessagingChannel

MessagingChannel newMessagingChannel(java.lang.String id,
                                   java.net.URI uri)

Create a messaging channel of the default type using the specified URI

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

Returns:

a new initialized messaging channel

See Also:

MessagingChannel

newMessagingChannel

MessagingChannel newMessagingChannel(java.lang.String channelType,
                                   java.lang.String id,
                                   java.net.URI uri)

Create a messaging channel of the specified type using the specified URI

Parameters:

channelType - a channel type

id - identifier for this channel

uri - uri of the server to connect to

Returns:

a new initialized messaging channel

See Also:

ChannelType, MessagingChannel

newRemotingChannel

RemotingChannel newRemotingChannel(java.lang.String id,
                                 ServerApp serverApp)

Create a remoting channel using the specified server application definition

Parameters:

id - identifier for this channel

serverApp - server application to connect to

Returns:

an initializer channel

See Also:

RemotingChannel, ServerApp

newRemotingChannel

RemotingChannel newRemotingChannel(java.lang.String id,
                                 ServerApp serverApp,
                                 int maxConcurrentRequests)

Create a remoting channel using the specified server application definition

Parameters:

id - identifier for this channel

serverApp - server application to connect to

maxConcurrentRequests - maximum number of concurrent requests

Returns:

a new initialized remoting channel

See Also:

RemotingChannel, ServerApp

newMessagingChannel

MessagingChannel newMessagingChannel(java.lang.String id,
                                   ServerApp serverApp)

Create a messaging channel of the default type using the specified server application definition

Parameters:

id - identifier for this channel

serverApp - server application to connect to

Returns:

a new initialized messaging channel

See Also:

MessagingChannel, ServerApp

newMessagingChannel

MessagingChannel newMessagingChannel(java.lang.String channelType,
                                   java.lang.String id,
                                   ServerApp serverApp)

Create a messaging channel of the specified type using the specified server application definition

Parameters:

channelType - a channel type

id - identifier for this channel

serverApp - server application to connect to

Returns:

a new initialized messaging channel

See Also:

ChannelType, MessagingChannel, ServerApp