org.granite.gravity

Interface Gravity

All Known Subinterfaces:

Gravity

All Known Implementing Classes:

DefaultGravity, GAEGravity, GravityBean, GravityProxy

public interface Gravity

Author:

Franck WOLFF

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Gravity.Listener

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

Method Detail

getGravityConfig

GravityConfig getGravityConfig()

Current Gravity configuration

Returns:

config

getServicesConfig

ServicesConfig getServicesConfig()

Current services configuration

Returns:

config

getGraniteConfig

GraniteConfig getGraniteConfig()

Current Granite configuration

Returns:

config

isStarted

boolean isStarted()

State of the Gravity component

Returns:

true if started

start

void start()
           throws java.lang.Exception

Start the Gravity component

Throws:

java.lang.Exception

reconfigure

void reconfigure(GravityConfig gravityConfig,
               GraniteConfig graniteConfig)

Update the current configuration and restarts

Parameters:

gravityConfig - Gravity config

graniteConfig - Granite config

stop

void stop()
          throws java.lang.Exception

Stop the Gravity component

Throws:

java.lang.Exception

stop

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

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

Throws:

java.lang.Exception

registerListener

void registerListener(Gravity.Listener listener)

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

Parameters:

listener -

unregisterListener

void unregisterListener(Gravity.Listener listener)

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

Parameters:

listener -

getConnectedChannels

java.util.List<Channel> getConnectedChannels()

Currently connected channels

Returns:

list of channels

getConnectedUsers

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

Currently connected authenticated users

Returns:

set of users

getConnectedChannelsByDestination

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

Channels currently connected for a specified destination

Parameters:

destination - a destination

Returns:

list of channels

getConnectedUsersByDestination

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

Authenticated users currently connected for a specified destination

Parameters:

destination - a destination

Returns:

set of users

findConnectedChannelsByUser

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

Find all channels for an authenticated user name

Parameters:

name - user name

Returns:

list of channels

findChannelByClientId

Channel findChannelByClientId(java.lang.String clientId)

Find the channel for a specified clientId

Parameters:

clientId - client id

Returns:

channel

findCurrentChannel

Channel findCurrentChannel(java.lang.String destination)

Current channel for the specified destination

Parameters:

destination - destination

Returns:

channel

handleMessage

Message handleMessage(Message message)

Handle a message using the configured service adapter

Parameters:

message - message

Returns:

acknowledge or error

handleMessage

Message handleMessage(Message message,
                    boolean skipInterceptor)

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

Parameters:

message - message

skipInterceptor - skip interceptors

Returns:

acknowledge or error

publishMessage

Message publishMessage(AsyncMessage message)

Publish a message to connected users from the default server channel

Parameters:

message - message to publish

Returns:

acknowledge or error

publishMessage

Message publishMessage(Channel fromChannel,
                     AsyncMessage message)

Publish a message to connected users from the specified user channel

Parameters:

fromChannel - originating channel

message - message to publish

Returns:

acknowledge or error

sendRequest

Message sendRequest(Channel fromChannel,
                  AsyncMessage message)

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

Parameters:

fromChannel - originating channel

message - request

Returns:

response