***  This interface provides Binary Compatibility only, not Source Compatibility  ***

com.sas.services.events.broker
Interface EventBrokerServiceInterface

All Superinterfaces:
com.sas.entities.EntityKeyInterface, ListenerRegisterInterface, java.rmi.Remote, RemoteServiceInterface, ServiceNotificationBroadcasterInterface
All Known Implementing Classes:
EventBrokerService

Deprecated. As of release 9.3, replaced by SAS Midtier Eventing Architecture.

public interface EventBrokerServiceInterface
extends ListenerRegisterInterface, RemoteServiceInterface

Interface to the EventBroker Service for firing events.

Usage

This interface is used by clients that want to send events to the EventBrokerService and to aquire information about the service.

Since:
1.0

Field Summary
static int EVENT_TYPE_BROADCAST
          Deprecated. A Broadcast type of event is forwarded to all possible handlers.
static int EVENT_TYPE_REQUEST_RESPONSE
          Deprecated. A Request/Response type of event is forwarded to a single handler and a response is always generated.
 
Fields inherited from interface com.sas.services.RemoteServiceInterface
CLASS_IDENTIFIER, CLASS_IDENTIFIER_1_1, CLASS_IDENTIFIER_1_2, CLASS_IDENTIFIER_SERVICE_TYPE, CLASS_IDENTIFIER_SERVICE_TYPE_1_1, CLASS_IDENTIFIER_SERVICE_TYPE_1_2
 
Method Summary
 boolean canProcess(java.lang.String eventName, int eventType)
          Deprecated. Determine if the EventBrokerService can process a particular named event.
 java.lang.String getConfiguration()
          Deprecated. Get transport configuration of this EventBrokerService.
 java.lang.String getDescription()
          Deprecated. Get description of this EventBrokerService.
 java.lang.String getHost()
          Deprecated. Get the host name where we are executing.
 void sendAsyncEvent(java.lang.String event, EventResponseHandlerInterface responseHandler)
          Deprecated. Send an asynchronous event to this EventBrokerService for processing.
 java.lang.String sendSyncEvent(java.lang.String event)
          Deprecated. Send a synchronous event to this EventBrokerService for processing.
 
Methods inherited from interface com.sas.services.events.broker.ListenerRegisterInterface
addEventListener, removeEventListener
 
Methods inherited from interface com.sas.services.RemoteServiceInterface
configure, destroy, getCreationTime, getServiceConfiguration, getServiceConfiguration, getServiceProxy, getServiceState, isAccessibleToRemoteClients, isExported, reconfigure, setServiceState
 
Methods inherited from interface com.sas.services.mgmt.ServiceNotificationBroadcasterInterface
addServiceObserver, notifyServiceObservers, removeAllServiceObservers, removeServiceObserver
 

Field Detail

EVENT_TYPE_BROADCAST

static final int EVENT_TYPE_BROADCAST
Deprecated. 
A Broadcast type of event is forwarded to all possible handlers. A response is never generated.

See Also:
Constant Field Values

EVENT_TYPE_REQUEST_RESPONSE

static final int EVENT_TYPE_REQUEST_RESPONSE
Deprecated. 
A Request/Response type of event is forwarded to a single handler and a response is always generated.

See Also:
Constant Field Values
Method Detail

getHost

java.lang.String getHost()
                         throws java.rmi.RemoteException
Deprecated. 
Get the host name where we are executing.

Returns:
Name of host where we are executing.
Throws:
java.rmi.RemoteException - if a network anomaly occurs.

getDescription

java.lang.String getDescription()
                                throws java.rmi.RemoteException
Deprecated. 
Get description of this EventBrokerService.

Returns:
Description of this EventBrokerService.
Throws:
java.rmi.RemoteException - if a network anomaly occurs.

getConfiguration

java.lang.String getConfiguration()
                                  throws java.rmi.RemoteException
Deprecated. 
Get transport configuration of this EventBrokerService.

Returns:
XML formatted string representation of transport configuration.
Throws:
java.rmi.RemoteException - if a network anomaly occurs.

canProcess

boolean canProcess(java.lang.String eventName,
                   int eventType)
                   throws java.rmi.RemoteException
Deprecated. 
Determine if the EventBrokerService can process a particular named event.

Valid event types are as follows:

Parameters:
eventName - Name of event.
eventType - Type of event.
Returns:
true if broker can process; otherwise false.
Throws:
java.rmi.RemoteException - if a network anomaly occurs.

sendSyncEvent

java.lang.String sendSyncEvent(java.lang.String event)
                               throws java.rmi.RemoteException
Deprecated. 
Send a synchronous event to this EventBrokerService for processing.

Parameters:
event - Event to send (See Event Message Specification).
Returns:
A response string if a response is requested in the event specification; otherwise return an empty string.
Throws:
java.rmi.RemoteException - if a network anomaly occurs.

sendAsyncEvent

void sendAsyncEvent(java.lang.String event,
                    EventResponseHandlerInterface responseHandler)
                    throws java.rmi.RemoteException
Deprecated. 
Send an asynchronous event to this EventBrokerService for processing.

Parameters:
event - Event to send (See Event Message Specification).
responseHandler - Event response handler.
Throws:
java.rmi.RemoteException - if a network anomaly occurs.

***  This interface provides Binary Compatibility only, not Source Compatibility  ***




Copyright © 2009 SAS Institute Inc. All Rights Reserved.