org.figure8.join.services.remoting
Interface MessagingService

All Superinterfaces:

AuthenticatedService, java.rmi.Remote

All Known Implementing Classes:

MessagingServiceImpl

public interface MessagingService
extends AuthenticatedService

Remote service interface definition. This service allows to interact with server-side JMS consumers : retrieving them, saving them (thus activation / deactivation) and removing them. All this services require authentication through the usage of the login() method. The security token returned by this method should then be used as a parameter of every service call.

Version:

$Revision: 1.1 $

Author:

Laurent Broudoux

Method Summary

RemoteJMSConsumerBeanInfo	getConsumerBeanInfo(java.lang.String token, java.lang.String name) Retrieve the info object having the specified name (or null if none).
RemoteJMSConsumerBeanInfo[]	getConsumerBeanInfos(java.lang.String token) Retrieve the info object corresponding to available JMSConsumerBeans.
void	removeConsumerBeanInfo(java.lang.String token, java.lang.String name) Remove a JMSConsumerBean infos from datastore.
void	saveConsumerBeanInfo(java.lang.String token, RemoteJMSConsumerBeanInfo info) Save a JMSConsumerBean infos within datastore.

Methods inherited from interface org.figure8.join.services.remoting.AuthenticatedService

login, logout

Method Detail

saveConsumerBeanInfo

void saveConsumerBeanInfo(java.lang.String token,
                          RemoteJMSConsumerBeanInfo info)
                          throws InvalidSessionException,
                                 InvalidParameterException,
                                 DuplicateEntityException,
                                 InfrastructureException,
                                 java.rmi.RemoteException

Save a JMSConsumerBean infos within datastore. This method should also control the status of eventually existing consumers, depending on active attribute of the info bean.

Parameters:

token - Authentication token provided earlier by login() method

info - The info on a JMSConsumerBean to save

Throws:

InvalidSessionException - if user has no valid session on server-side

InvalidParameterException - if consumer bean java class is not valid

DuplicateEntityException - if another consumer with same name already exists.

InfrastructureException - if wrapped JCA container cannot activate consumer.

java.rmi.RemoteException - if an exception occurs during the remote conversation

removeConsumerBeanInfo

void removeConsumerBeanInfo(java.lang.String token,
                            java.lang.String name)
                            throws InvalidSessionException,
                                   java.rmi.RemoteException

Remove a JMSConsumerBean infos from datastore. This method should also stop existing consumer instances before removing the related informations.

Parameters:

token - Authentication token provided earlier by login() method

name - The name of the JMSConsumerBean to remove

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

getConsumerBeanInfo

RemoteJMSConsumerBeanInfo getConsumerBeanInfo(java.lang.String token,
                                              java.lang.String name)
                                              throws InvalidSessionException,
                                                     java.rmi.RemoteException

Retrieve the info object having the specified name (or null if none).

Parameters:

token - Authentication token provided earlier by login() method

name - The name of consumer bean information to retrieve

Returns:

The corresponding RemoteJMSConsumerBeanInfo object, or null if none

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

getConsumerBeanInfos

RemoteJMSConsumerBeanInfo[] getConsumerBeanInfos(java.lang.String token)
                                                 throws InvalidSessionException,
                                                        java.rmi.RemoteException

Retrieve the info object corresponding to available JMSConsumerBeans.

Parameters:

token - Authentication token provided earlier by login() method

Returns:

An array of RemoteJMSConsumerBeanInfo objects.

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation