org.granite.gravity

Class DefaultGravity

java.lang.Object

org.granite.gravity.DefaultGravity

All Implemented Interfaces:

ShutdownListener, DefaultGravityMBean, Gravity, GravityInternal

Direct Known Subclasses:

GAEGravity

public class DefaultGravity
extends java.lang.Object
implements Gravity, GravityInternal, DefaultGravityMBean

Author:

William DRAI, Franck WOLFF

Nested Class Summary

Nested classes/interfaces inherited from interface org.granite.gravity.Gravity

Gravity.Listener

Field Summary

Fields inherited from interface org.granite.gravity.GravityInternal

BYTEARRAY_BODY_HEADER, ENCODE_MESSAGE_BODY_KEY, RECONNECT_INTERVAL_MS_KEY, RECONNECT_MAX_ATTEMPTS_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultGravity(GravityConfig gravityConfig, ServicesConfig servicesConfig, GraniteConfig graniteConfig)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	access(java.lang.String channelId)
boolean	cancel(AsyncChannelRunner runner)
protected <C extends Channel> C	createChannel(ChannelFactory<C> channelFactory, java.lang.String clientId)
void	execute(AsyncChannelRunner runner)
Channel	findChannelByClientId(java.lang.String clientId) Find the channel for a specified clientId
java.util.List<Channel>	findConnectedChannelsByUser(java.lang.String name) Find all channels for an authenticated user name
Channel	findCurrentChannel(java.lang.String destination) Current channel for the specified destination
<C extends Channel> C	getChannel(ChannelFactory<C> channelFactory, java.lang.String clientId)
long	getChannelIdleTimeoutMillis()
java.util.List<Channel>	getConnectedChannels() Currently connected channels
java.util.List<Channel>	getConnectedChannelsByDestination(java.lang.String destination) Channels currently connected for a specified destination
java.util.Set<java.security.Principal>	getConnectedUsers() Currently connected authenticated users
java.util.Set<java.security.Principal>	getConnectedUsersByDestination(java.lang.String destination) Authenticated users currently connected for a specified destination
int	getCorePoolSize()
GraniteConfig	getGraniteConfig() Current Granite configuration
GravityConfig	getGravityConfig() Current Gravity configuration
java.lang.String	getGravityFactoryName()
long	getKeepAliveTimeMillis()
long	getLongPollingTimeoutMillis()
int	getMaximumPoolSize()
int	getMaxMessagesQueuedPerChannel()
int	getQueueCapacity()
int	getQueueRemainingCapacity()
int	getQueueSize()
long	getReconnectIntervalMillis()
int	getReconnectMaxAttempts()
ServiceAdapter	getServiceAdapter(java.lang.String messageType, java.lang.String destinationId)
ServicesConfig	getServicesConfig() Current services configuration
UdpReceiverFactory	getUdpReceiverFactory()
Message	handleMessage(ChannelFactory<?> channelFactory, Message message)
Message	handleMessage(ChannelFactory<?> channelFactory, Message message, boolean skipInterceptor)
Message	handleMessage(Message message) Handle a message using the configured service adapter
Message	handleMessage(Message message, boolean skipInterceptor) Handle a message using the configured service adapter, optionally skipping interceptors
boolean	hasUdpReceiverFactory()
GraniteContext	initThread(java.lang.String sessionId, java.lang.String clientType)
protected void	internalStart()
boolean	isRetryOnError()
boolean	isStarted() State of the Gravity component
void	notifyAuthenticated(Channel channel, java.security.Principal principal)
void	notifyConnected(Channel channel)
void	notifyDisconnected(Channel channel)
protected void	postManage(Channel channel)
Message	publishMessage(AsyncMessage message) Publish a message to connected users from the default server channel
Message	publishMessage(Channel fromChannel, AsyncMessage message) Publish a message to connected users from the specified user channel
void	reconfigure(GravityConfig gravityConfig, GraniteConfig graniteConfig) Update the current configuration and restarts
void	registerListener(Gravity.Listener listener) Registers a listener which will be notified of channel events (connect/disconnect/subscription/unsubscription)
void	releaseThread()
Channel	removeChannel(java.lang.String channelId, boolean timeout)
void	restart()
Message	sendRequest(Channel fromChannel, AsyncMessage message) Send a server-to-client request, waiting synchronously for the response
void	setChannelIdleTimeoutMillis(long channelIdleTimeoutMillis)
void	setCorePoolSize(int corePoolSize)
void	setKeepAliveTimeMillis(long keepAliveTimeMillis)
void	setLongPollingTimeoutMillis(long longPollingTimeoutMillis)
void	setMaximumPoolSize(int maximumPoolSize)
void	setMaxMessagesQueuedPerChannel(int maxMessagesQueuedPerChannel)
void	setRetryOnError(boolean retryOnError)
void	start() Start the Gravity component
void	stop() Stop the Gravity component
void	stop(boolean now) Stop the Gravity component, optionally forcing immediate shutdown (without waiting for channel closing)
void	unregisterListener(Gravity.Listener listener) Unregisters a listener which will be notified of channel events (connect/disconnect/subscription/unsubscription)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGravity

public DefaultGravity(GravityConfig gravityConfig,
              ServicesConfig servicesConfig,
              GraniteConfig graniteConfig)

Method Detail

getGravityConfig

public GravityConfig getGravityConfig()

Description copied from interface: Gravity

Current Gravity configuration

Specified by:

getGravityConfig in interface Gravity

Specified by:

getGravityConfig in interface GravityInternal

Returns:

config

getServicesConfig

public ServicesConfig getServicesConfig()

Description copied from interface: Gravity

Current services configuration

Specified by:

getServicesConfig in interface Gravity

Specified by:

getServicesConfig in interface GravityInternal

Returns:

config

getGraniteConfig

public GraniteConfig getGraniteConfig()

Description copied from interface: Gravity

Current Granite configuration

Specified by:

getGraniteConfig in interface Gravity

Specified by:

getGraniteConfig in interface GravityInternal

Returns:

config

isStarted

public boolean isStarted()

Description copied from interface: Gravity

State of the Gravity component

Specified by:

isStarted in interface DefaultGravityMBean

Specified by:

isStarted in interface Gravity

Specified by:

isStarted in interface GravityInternal

Returns:

true if started

getServiceAdapter

public ServiceAdapter getServiceAdapter(java.lang.String messageType,
                               java.lang.String destinationId)

Specified by:

getServiceAdapter in interface GravityInternal

start

public void start()
           throws java.lang.Exception

Description copied from interface: Gravity

Start the Gravity component

Specified by:

start in interface DefaultGravityMBean

Specified by:

start in interface Gravity

Throws:

java.lang.Exception

internalStart

protected void internalStart()

restart

public void restart()
             throws java.lang.Exception

Specified by:

restart in interface DefaultGravityMBean

Throws:

java.lang.Exception

reconfigure

public void reconfigure(GravityConfig gravityConfig,
               GraniteConfig graniteConfig)

Description copied from interface: Gravity

Update the current configuration and restarts

Specified by:

reconfigure in interface Gravity

Parameters:

gravityConfig - Gravity config

graniteConfig - Granite config

stop

public void stop()
          throws java.lang.Exception

Description copied from interface: Gravity

Stop the Gravity component

Specified by:

stop in interface ShutdownListener

Specified by:

stop in interface DefaultGravityMBean

Specified by:

stop in interface Gravity

Throws:

java.lang.Exception

stop

public void stop(boolean now)
          throws java.lang.Exception

Description copied from interface: Gravity

Stop the Gravity component, optionally forcing immediate shutdown (without waiting for channel closing)

Specified by:

stop in interface Gravity

Throws:

java.lang.Exception

getGravityFactoryName

public java.lang.String getGravityFactoryName()

Specified by:

getGravityFactoryName in interface DefaultGravityMBean

getChannelIdleTimeoutMillis

public long getChannelIdleTimeoutMillis()

Specified by:

getChannelIdleTimeoutMillis in interface DefaultGravityMBean

setChannelIdleTimeoutMillis

public void setChannelIdleTimeoutMillis(long channelIdleTimeoutMillis)

Specified by:

setChannelIdleTimeoutMillis in interface DefaultGravityMBean

isRetryOnError

public boolean isRetryOnError()

Specified by:

isRetryOnError in interface DefaultGravityMBean

setRetryOnError

public void setRetryOnError(boolean retryOnError)

Specified by:

setRetryOnError in interface DefaultGravityMBean

getLongPollingTimeoutMillis

public long getLongPollingTimeoutMillis()

Specified by:

getLongPollingTimeoutMillis in interface DefaultGravityMBean

setLongPollingTimeoutMillis

public void setLongPollingTimeoutMillis(long longPollingTimeoutMillis)

Specified by:

setLongPollingTimeoutMillis in interface DefaultGravityMBean

getMaxMessagesQueuedPerChannel

public int getMaxMessagesQueuedPerChannel()

Specified by:

getMaxMessagesQueuedPerChannel in interface DefaultGravityMBean

setMaxMessagesQueuedPerChannel

public void setMaxMessagesQueuedPerChannel(int maxMessagesQueuedPerChannel)

Specified by:

setMaxMessagesQueuedPerChannel in interface DefaultGravityMBean

getReconnectIntervalMillis

public long getReconnectIntervalMillis()

Specified by:

getReconnectIntervalMillis in interface DefaultGravityMBean

getReconnectMaxAttempts

public int getReconnectMaxAttempts()

Specified by:

getReconnectMaxAttempts in interface DefaultGravityMBean

getCorePoolSize

public int getCorePoolSize()

Specified by:

getCorePoolSize in interface DefaultGravityMBean

setCorePoolSize

public void setCorePoolSize(int corePoolSize)

Specified by:

setCorePoolSize in interface DefaultGravityMBean

getKeepAliveTimeMillis

public long getKeepAliveTimeMillis()

Specified by:

getKeepAliveTimeMillis in interface DefaultGravityMBean

setKeepAliveTimeMillis

public void setKeepAliveTimeMillis(long keepAliveTimeMillis)

Specified by:

setKeepAliveTimeMillis in interface DefaultGravityMBean

getMaximumPoolSize

public int getMaximumPoolSize()

Specified by:

getMaximumPoolSize in interface DefaultGravityMBean

setMaximumPoolSize

public void setMaximumPoolSize(int maximumPoolSize)

Specified by:

setMaximumPoolSize in interface DefaultGravityMBean

getQueueCapacity

public int getQueueCapacity()

Specified by:

getQueueCapacity in interface DefaultGravityMBean

getQueueRemainingCapacity

public int getQueueRemainingCapacity()

Specified by:

getQueueRemainingCapacity in interface DefaultGravityMBean

getQueueSize

public int getQueueSize()

Specified by:

getQueueSize in interface DefaultGravityMBean

hasUdpReceiverFactory

public boolean hasUdpReceiverFactory()

Specified by:

hasUdpReceiverFactory in interface GravityInternal

getUdpReceiverFactory

public UdpReceiverFactory getUdpReceiverFactory()

Specified by:

getUdpReceiverFactory in interface GravityInternal

createChannel

protected <C extends Channel> C createChannel(ChannelFactory<C> channelFactory,
                                  java.lang.String clientId)

getChannel

public <C extends Channel> C getChannel(ChannelFactory<C> channelFactory,
                               java.lang.String clientId)

Specified by:

getChannel in interface GravityInternal

removeChannel

public Channel removeChannel(java.lang.String channelId,
                    boolean timeout)

Specified by:

removeChannel in interface GravityInternal

access

public boolean access(java.lang.String channelId)

Specified by:

access in interface GravityInternal

execute

public void execute(AsyncChannelRunner runner)

Specified by:

execute in interface GravityInternal

cancel

public boolean cancel(AsyncChannelRunner runner)

Specified by:

cancel in interface GravityInternal

handleMessage

public Message handleMessage(Message message)

Description copied from interface: Gravity

Handle a message using the configured service adapter

Specified by:

handleMessage in interface Gravity

Parameters:

message - message

Returns:

acknowledge or error

handleMessage

public Message handleMessage(Message message,
                    boolean skipInterceptor)

Description copied from interface: Gravity

Handle a message using the configured service adapter, optionally skipping interceptors

Specified by:

handleMessage in interface Gravity

Parameters:

message - message

skipInterceptor - skip interceptors

Returns:

acknowledge or error

handleMessage

public Message handleMessage(ChannelFactory<?> channelFactory,
                    Message message)

Specified by:

handleMessage in interface GravityInternal

handleMessage

public Message handleMessage(ChannelFactory<?> channelFactory,
                    Message message,
                    boolean skipInterceptor)

Specified by:

handleMessage in interface GravityInternal

initThread

public GraniteContext initThread(java.lang.String sessionId,
                        java.lang.String clientType)

Specified by:

initThread in interface GravityInternal

releaseThread

public void releaseThread()

Specified by:

releaseThread in interface GravityInternal

registerListener

public void registerListener(Gravity.Listener listener)

Description copied from interface: Gravity

Registers a listener which will be notified of channel events (connect/disconnect/subscription/unsubscription)

Specified by:

registerListener in interface Gravity

unregisterListener

public void unregisterListener(Gravity.Listener listener)

Description copied from interface: Gravity

Unregisters a listener which will be notified of channel events (connect/disconnect/subscription/unsubscription)

Specified by:

unregisterListener in interface Gravity

notifyConnected

public void notifyConnected(Channel channel)

Specified by:

notifyConnected in interface GravityInternal

notifyDisconnected

public void notifyDisconnected(Channel channel)

Specified by:

notifyDisconnected in interface GravityInternal

notifyAuthenticated

public void notifyAuthenticated(Channel channel,
                       java.security.Principal principal)

Specified by:

notifyAuthenticated in interface GravityInternal

getConnectedChannels

public java.util.List<Channel> getConnectedChannels()

Description copied from interface: Gravity

Currently connected channels

Specified by:

getConnectedChannels in interface Gravity

Returns:

list of channels

getConnectedUsers

public java.util.Set<java.security.Principal> getConnectedUsers()

Description copied from interface: Gravity

Currently connected authenticated users

Specified by:

getConnectedUsers in interface Gravity

Returns:

set of users

getConnectedChannelsByDestination

public java.util.List<Channel> getConnectedChannelsByDestination(java.lang.String destination)

Description copied from interface: Gravity

Channels currently connected for a specified destination

Specified by:

getConnectedChannelsByDestination in interface Gravity

Parameters:

destination - a destination

Returns:

list of channels

getConnectedUsersByDestination

public java.util.Set<java.security.Principal> getConnectedUsersByDestination(java.lang.String destination)

Description copied from interface: Gravity

Authenticated users currently connected for a specified destination

Specified by:

getConnectedUsersByDestination in interface Gravity

Parameters:

destination - a destination

Returns:

set of users

findConnectedChannelsByUser

public java.util.List<Channel> findConnectedChannelsByUser(java.lang.String name)

Description copied from interface: Gravity

Find all channels for an authenticated user name

Specified by:

findConnectedChannelsByUser in interface Gravity

Parameters:

name - user name

Returns:

list of channels

findChannelByClientId

public Channel findChannelByClientId(java.lang.String clientId)

Description copied from interface: Gravity

Find the channel for a specified clientId

Specified by:

findChannelByClientId in interface Gravity

Parameters:

clientId - client id

Returns:

channel

findCurrentChannel

public Channel findCurrentChannel(java.lang.String destination)

Description copied from interface: Gravity

Current channel for the specified destination

Specified by:

findCurrentChannel in interface Gravity

Parameters:

destination - destination

Returns:

channel

publishMessage

public Message publishMessage(AsyncMessage message)

Description copied from interface: Gravity

Publish a message to connected users from the default server channel

Specified by:

publishMessage in interface Gravity

Parameters:

message - message to publish

Returns:

acknowledge or error

publishMessage

public Message publishMessage(Channel fromChannel,
                     AsyncMessage message)

Description copied from interface: Gravity

Publish a message to connected users from the specified user channel

Specified by:

publishMessage in interface Gravity

Parameters:

fromChannel - originating channel

message - message to publish

Returns:

acknowledge or error

sendRequest

public Message sendRequest(Channel fromChannel,
                  AsyncMessage message)

Description copied from interface: Gravity

Send a server-to-client request, waiting synchronously for the response

Specified by:

sendRequest in interface Gravity

Parameters:

fromChannel - originating channel

message - request

Returns:

response

postManage

protected void postManage(Channel channel)