org.granite.client.messaging.channel

Class AbstractChannelFactory

java.lang.Object

org.granite.client.messaging.channel.AbstractChannelFactory

All Implemented Interfaces:

ChannelFactory

Direct Known Subclasses:

AMFChannelFactory, JMFChannelFactory

public abstract class AbstractChannelFactory
extends java.lang.Object
implements ChannelFactory

Author:

Franck WOLFF

Field Summary

Fields

Modifier and Type	Field and Description
protected AliasRegistry	aliasRegistry
protected ContentType	contentType
protected java.lang.Object	context
protected ChannelBuilder	defaultChannelBuilder
protected java.lang.Long	defaultTimeToLive
protected Transport	messagingTransport
protected java.util.Map<java.lang.String,Transport>	messagingTransports
protected Transport	remotingTransport
protected java.util.Set<java.lang.String>	scanPackageNames

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractChannelFactory(ContentType contentType)
protected	AbstractChannelFactory(ContentType contentType, java.lang.Object context)
protected	AbstractChannelFactory(ContentType contentType, java.lang.Object context, Transport remotingTransport, Transport messagingTransport)

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
protected abstract java.lang.Class<? extends RemotingChannel>	getRemotingChannelClass()
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
protected abstract <M> MessagingCodec<M>	newMessagingCodec(java.lang.Class<M> messageClass)
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	setScanPackageNames(java.lang.String... packageNames)
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.

Methods inherited from class java.lang.Object

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

Field Detail

contentType

protected final ContentType contentType

remotingTransport

protected Transport remotingTransport

messagingTransport

protected Transport messagingTransport

messagingTransports

protected java.util.Map<java.lang.String,Transport> messagingTransports

context

protected java.lang.Object context

defaultChannelBuilder

protected ChannelBuilder defaultChannelBuilder

scanPackageNames

protected java.util.Set<java.lang.String> scanPackageNames

aliasRegistry

protected AliasRegistry aliasRegistry

defaultTimeToLive

protected java.lang.Long defaultTimeToLive

Constructor Detail

AbstractChannelFactory

protected AbstractChannelFactory(ContentType contentType)

AbstractChannelFactory

protected AbstractChannelFactory(ContentType contentType,
                      java.lang.Object context)

AbstractChannelFactory

protected AbstractChannelFactory(ContentType contentType,
                      java.lang.Object context,
                      Transport remotingTransport,
                      Transport messagingTransport)

Method Detail

getContext

public java.lang.Object getContext()

Description copied from interface: ChannelFactory

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

Specified by:

getContext in interface ChannelFactory

Returns:

current context

See Also:

Transport

setContext

public void setContext(java.lang.Object context)

Description copied from interface: ChannelFactory

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

Specified by:

setContext in interface ChannelFactory

Parameters:

context - current context

See Also:

Transport

setDefaultChannelBuilder

public void setDefaultChannelBuilder(ChannelBuilder channelBuilder)

Description copied from interface: ChannelFactory

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

Specified by:

setDefaultChannelBuilder in interface ChannelFactory

Parameters:

channelBuilder - the channel builder

See Also:

DefaultChannelBuilder

getContentType

public ContentType getContentType()

Description copied from interface: ChannelFactory

The encoding (AMF or JMF) for this ChannelFactory

Specified by:

getContentType in interface ChannelFactory

Returns:

the content type

See Also:

ContentType

getDefaultTimeToLive

public long getDefaultTimeToLive()

Description copied from interface: ChannelFactory

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

Specified by:

getDefaultTimeToLive in interface ChannelFactory

Returns:

time to live in milliseconds

setDefaultTimeToLive

public void setDefaultTimeToLive(long defaultTimeToLive)

Description copied from interface: ChannelFactory

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

Specified by:

setDefaultTimeToLive in interface ChannelFactory

Parameters:

defaultTimeToLive - time to live in milliseconds

setAliasRegistry

public void setAliasRegistry(AliasRegistry aliasRegistry)

Description copied from interface: ChannelFactory

The alias registry for this factory

Specified by:

setAliasRegistry in interface ChannelFactory

Parameters:

aliasRegistry - alias registry

See Also:

AliasRegistry

setDefaultChannelType

public void setDefaultChannelType(java.lang.String channelType)

Description copied from interface: ChannelFactory

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

Specified by:

setDefaultChannelType in interface ChannelFactory

Parameters:

channelType - default type of messaging channels

See Also:

ChannelType

getDefaultChannelType

public java.lang.String getDefaultChannelType()

Description copied from interface: ChannelFactory

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

Specified by:

getDefaultChannelType in interface ChannelFactory

Returns:

default type of messaging channels

getRemotingTransport

public Transport getRemotingTransport()

Description copied from interface: ChannelFactory

The transport for remoting channels

Specified by:

getRemotingTransport in interface ChannelFactory

Returns:

transport

See Also:

Transport

setRemotingTransport

public void setRemotingTransport(Transport remotingTransport)

Description copied from interface: ChannelFactory

Set the transport for remoting channels

Specified by:

setRemotingTransport in interface ChannelFactory

Parameters:

remotingTransport - transport

See Also:

Transport

setMessagingTransport

public void setMessagingTransport(Transport messagingTransport)

Description copied from interface: ChannelFactory

Set the default transport for messaging channels

Specified by:

setMessagingTransport in interface ChannelFactory

Parameters:

messagingTransport - transport

setMessagingTransport

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

Description copied from interface: ChannelFactory

Set the transport for the specified messaging channel type

Specified by:

setMessagingTransport in interface ChannelFactory

Parameters:

channelType - channel type

messagingTransport - transport

See Also:

ChannelType, Transport

getMessagingTransport

public Transport getMessagingTransport()

Description copied from interface: ChannelFactory

The default transport for messaging channels

Specified by:

getMessagingTransport in interface ChannelFactory

Returns:

the transport

See Also:

Transport

getMessagingTransports

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

Description copied from interface: ChannelFactory

The transports for messaging channels

Specified by:

getMessagingTransports in interface ChannelFactory

Returns:

a map of transports keyed by channel type

getMessagingTransport

public Transport getMessagingTransport(java.lang.String channelType)

Description copied from interface: ChannelFactory

The transport for the specified messaging channel type

Specified by:

getMessagingTransport in interface ChannelFactory

Parameters:

channelType - channel type

Returns:

the transport

See Also:

ChannelType, Transport

setScanPackageNames

public void setScanPackageNames(java.lang.String... packageNames)

setScanPackageNames

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

Description copied from interface: ChannelFactory

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

Specified by:

setScanPackageNames in interface ChannelFactory

See Also:

AliasRegistry

start

public void start()

Description copied from interface: ChannelFactory

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

Specified by:

start in interface ChannelFactory

stop

public void stop()

Description copied from interface: ChannelFactory

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.

Specified by:

stop in interface ChannelFactory

stop

public void stop(boolean stopTransports)

Description copied from interface: ChannelFactory

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.

Specified by:

stop in interface ChannelFactory

Parameters:

stopTransports - true to stop associated transports

newRemotingChannel

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

Description copied from interface: ChannelFactory

Create a remoting channel using the specified uri

Specified by:

newRemotingChannel in interface ChannelFactory

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

Returns:

a new initialized messaging channel

See Also:

RemotingChannel

newRemotingChannel

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

Description copied from interface: ChannelFactory

Create a remoting channel using the specified URI

Specified by:

newRemotingChannel in interface ChannelFactory

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

Returns:

a new initialized messaging channel

See Also:

RemotingChannel

newRemotingChannel

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

Description copied from interface: ChannelFactory

Create a remoting channel using the specified server application definition

Specified by:

newRemotingChannel in interface ChannelFactory

Parameters:

id - identifier for this channel

serverApp - server application to connect to

Returns:

an initializer channel

See Also:

RemotingChannel, ServerApp

newRemotingChannel

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

Description copied from interface: ChannelFactory

Create a remoting channel using the specified uri

Specified by:

newRemotingChannel in interface ChannelFactory

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

newRemotingChannel

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

Description copied from interface: ChannelFactory

Create a remoting channel using the specified URI

Specified by:

newRemotingChannel in interface ChannelFactory

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

newRemotingChannel

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

Description copied from interface: ChannelFactory

Create a remoting channel using the specified server application definition

Specified by:

newRemotingChannel in interface ChannelFactory

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

getRemotingChannelClass

protected abstract java.lang.Class<? extends RemotingChannel> getRemotingChannelClass()

newMessagingChannel

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

Description copied from interface: ChannelFactory

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

Specified by:

newMessagingChannel in interface ChannelFactory

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

Returns:

an initializer channel

See Also:

MessagingChannel

newMessagingChannel

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

Description copied from interface: ChannelFactory

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

Specified by:

newMessagingChannel in interface ChannelFactory

Parameters:

id - identifier for this channel

uri - uri of the server to connect to

Returns:

a new initialized messaging channel

See Also:

MessagingChannel

newMessagingChannel

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

Description copied from interface: ChannelFactory

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

Specified by:

newMessagingChannel in interface ChannelFactory

Parameters:

id - identifier for this channel

serverApp - server application to connect to

Returns:

a new initialized messaging channel

See Also:

MessagingChannel, ServerApp

newMessagingChannel

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

Description copied from interface: ChannelFactory

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

Specified by:

newMessagingChannel in interface ChannelFactory

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

newMessagingChannel

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

Description copied from interface: ChannelFactory

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

Specified by:

newMessagingChannel in interface ChannelFactory

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

newMessagingChannel

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

Description copied from interface: ChannelFactory

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

Specified by:

newMessagingChannel in interface ChannelFactory

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

newMessagingCodec

protected abstract <M> MessagingCodec<M> newMessagingCodec(java.lang.Class<M> messageClass)