org.granite.gravity

Class GravityProxy

java.lang.Object

org.granite.gravity.GravityProxy

All Implemented Interfaces:

Gravity

public class GravityProxy
extends java.lang.Object
implements Gravity

Author:

William DRAI

Nested Class Summary

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

Gravity.Listener

Constructor Summary

Constructors

Constructor and Description
GravityProxy()
GravityProxy(javax.servlet.ServletContext servletContext)

Method Summary

Methods

Modifier and Type	Method and Description
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
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
GraniteConfig	getGraniteConfig() Current Granite configuration
protected Gravity	getGravity()
GravityConfig	getGravityConfig() Current Gravity configuration
ServicesConfig	getServicesConfig() Current services configuration
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	isStarted() State of the Gravity component
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)
Message	sendRequest(Channel fromChannel, AsyncMessage message) Send a server-to-client request, waiting synchronously for the response
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

GravityProxy

public GravityProxy()

GravityProxy

public GravityProxy(javax.servlet.ServletContext servletContext)

Method Detail

getGravity

protected Gravity getGravity()

getGravityConfig

public GravityConfig getGravityConfig()

Description copied from interface: Gravity

Current Gravity configuration

Specified by:

getGravityConfig in interface Gravity

Returns:

config

getServicesConfig

public ServicesConfig getServicesConfig()

Description copied from interface: Gravity

Current services configuration

Specified by:

getServicesConfig in interface Gravity

Returns:

config

getGraniteConfig

public GraniteConfig getGraniteConfig()

Description copied from interface: Gravity

Current Granite configuration

Specified by:

getGraniteConfig in interface Gravity

Returns:

config

isStarted

public boolean isStarted()

Description copied from interface: Gravity

State of the Gravity component

Specified by:

isStarted in interface Gravity

Returns:

true if started

start

public void start()
           throws java.lang.Exception

Description copied from interface: Gravity

Start the Gravity component

Specified by:

start in interface Gravity

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 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

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

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

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

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