cgl.narada.service.client
Interface ClientService

All Known Implementing Classes:
ClientServiceImpl

public interface ClientService

This class provides a set of core functions that are utilized by applications


Method Summary
 void closeBrokerConnection()
          Signoff.
 EventConsumer createEventConsumer(NBEventListener listener)
           
 EventConsumer createEventConsumer(NBEventListener listener, NBNotificationListener notificationListener)
           
 EventProducer createEventProducer()
          Create an event producer
 EventProducer createEventProducer(NBNotificationListener notificationListener)
          Create an event producer with the specified NotificationListener
 Profile createProfile(int type, Object subscription)
          Creates a profile
 Profile createProfile(int type, String profileId, Object subscription)
          Creates a profile
 ReplayRequest createReplayRequest(int templateId, long[] sequencesToReplay)
          Create a repleay request based on the sequences that need to be replayed
 ReplayRequest createReplayRequest(int templateId, long sequenceStart, long sequenceEnd)
          Create a replay request based on the specified range
 ReplayRequest createReplayRequest(int templateId, long sequenceStart, long sequenceEnd, Profile[] specifiedConstraints)
          Create a replay request based on the specified constraints
 TemplateInfo createTemplateInfo(int templateId, int templateType, Object template)
          Creates a template info
 TemplateInfo createTemplateInfo(int templateId, int templateType, Object template, Object allEncompassingConstraint)
          Creates a template info
 int getEntityId()
           
 QosServiceImpl getQosServiceImpl()
           
 boolean hasPendingTransfers()
           
 void initializeBrokerCommunications(Properties props, String commType)
           
 boolean isInitialized()
           
 void setCommunicationLossListener(ConnectionLossListener connLossListener)
           
 void terminateServices()
          Terminate services that are currently running within the JVM
 

Method Detail

getEntityId

int getEntityId()

initializeBrokerCommunications

void initializeBrokerCommunications(Properties props,
                                    String commType)
                                    throws ServiceException
Throws:
ServiceException

setCommunicationLossListener

void setCommunicationLossListener(ConnectionLossListener connLossListener)

isInitialized

boolean isInitialized()

createProfile

Profile createProfile(int type,
                      Object subscription)
                      throws ServiceException
Creates a profile

Throws:
ServiceException

createProfile

Profile createProfile(int type,
                      String profileId,
                      Object subscription)
                      throws ServiceException
Creates a profile

Throws:
ServiceException

getQosServiceImpl

QosServiceImpl getQosServiceImpl()

createTemplateInfo

TemplateInfo createTemplateInfo(int templateId,
                                int templateType,
                                Object template)
                                throws ServiceException
Creates a template info

Throws:
ServiceException

createTemplateInfo

TemplateInfo createTemplateInfo(int templateId,
                                int templateType,
                                Object template,
                                Object allEncompassingConstraint)
                                throws ServiceException
Creates a template info

Throws:
ServiceException

createEventConsumer

EventConsumer createEventConsumer(NBEventListener listener)
                                  throws ServiceException
Throws:
ServiceException

createEventConsumer

EventConsumer createEventConsumer(NBEventListener listener,
                                  NBNotificationListener notificationListener)
                                  throws ServiceException
Throws:
ServiceException

createEventProducer

EventProducer createEventProducer()
                                  throws ServiceException
Create an event producer

Throws:
ServiceException

createEventProducer

EventProducer createEventProducer(NBNotificationListener notificationListener)
                                  throws ServiceException
Create an event producer with the specified NotificationListener

Throws:
ServiceException

createReplayRequest

ReplayRequest createReplayRequest(int templateId,
                                  long[] sequencesToReplay)
                                  throws ServiceException
Create a repleay request based on the sequences that need to be replayed

Throws:
ServiceException

createReplayRequest

ReplayRequest createReplayRequest(int templateId,
                                  long sequenceStart,
                                  long sequenceEnd)
                                  throws ServiceException
Create a replay request based on the specified range

Throws:
ServiceException

createReplayRequest

ReplayRequest createReplayRequest(int templateId,
                                  long sequenceStart,
                                  long sequenceEnd,
                                  Profile[] specifiedConstraints)
                                  throws ServiceException
Create a replay request based on the specified constraints

Throws:
ServiceException

closeBrokerConnection

void closeBrokerConnection()
                           throws ServiceException
Signoff. All communications resources including the connection to the broker are released

Throws:
ServiceException

hasPendingTransfers

boolean hasPendingTransfers()
                            throws ServiceException
Throws:
ServiceException

terminateServices

void terminateServices()
                       throws ServiceException
Terminate services that are currently running within the JVM

Throws:
ServiceException


For comments and suggestions please send e-mail to The NaradaBrokering Project