Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.server.service
Interface ErraiService<S>

Type Parameters:
S - The type of user session managed by this Errai
All Superinterfaces:
ServiceComposite<S>
All Known Implementing Classes:
ErraiServiceImpl

public interface ErraiService<S>
extends ServiceComposite<S>

The ErraiService is a minimal template for what is needed. It facilitates the ability to store a message, obtain the server bus and configuration


Field Summary
static String AUTHORIZATION_SERVICE
           
static String AUTHORIZATION_SVC_SUBJECT
           
static String ERRAI_DEFAULT_JNDI
           
static String SERVER_ECHO_SERVICE
           
static String SESSION_AUTH_DATA
           
 
Method Summary
 void addShutdownHook(Runnable runnable)
           
 ServerMessageBus getBus()
          Retrieves the server message bus employed by this service
 ErraiServiceConfigurator getConfiguration()
          Gets the configuration used to initalize the service
 void stopService()
          Shut down the entire Errai service.
 void store(Collection<Message> messages)
          Stores a collection of messages/
 void store(Message message)
          Stores the specified message
 
Methods inherited from interface org.jboss.errai.bus.server.service.ServiceComposite
getDispatcher, getSessionProvider, setDispatcher, setSessionProvider
 

Field Detail

AUTHORIZATION_SVC_SUBJECT

static final String AUTHORIZATION_SVC_SUBJECT
See Also:
Constant Field Values

SERVER_ECHO_SERVICE

static final String SERVER_ECHO_SERVICE
See Also:
Constant Field Values

AUTHORIZATION_SERVICE

static final String AUTHORIZATION_SERVICE
See Also:
Constant Field Values

SESSION_AUTH_DATA

static final String SESSION_AUTH_DATA
See Also:
Constant Field Values

ERRAI_DEFAULT_JNDI

static final String ERRAI_DEFAULT_JNDI
See Also:
Constant Field Values
Method Detail

store

void store(Message message)
Stores the specified message

Parameters:
message - - the message to store

store

void store(Collection<Message> messages)
Stores a collection of messages/

Parameters:
messages -

getBus

ServerMessageBus getBus()
Retrieves the server message bus employed by this service

Returns:
the server message bus

getConfiguration

ErraiServiceConfigurator getConfiguration()
Gets the configuration used to initalize the service

Returns:
the errai service configurator

addShutdownHook

void addShutdownHook(Runnable runnable)

stopService

void stopService()
Shut down the entire Errai service.


Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.