com.sap.netweaver.rtmf.messagingimpl.services

Class RTMFSyncService

java.lang.Object
  com.sap.netweaver.rtmf.messagingimpl.services.RTMFService
      com.sap.netweaver.rtmf.messagingimpl.services.RTMFSyncService

Deprecated.

public abstract class RTMFSyncService
extends RTMFService

The class that represents an RTMF sync service.

Unlike RTMFTopicService and RTMFQueueService, the business logic in an RTMFSyncService is executed synchronously, meaning the sending entity waits for a reply from the service.

In a cluster environment, an instance of the RTMFSyncService exists on each of the server nodes. The instance on the same node as the sending entity handles the message.

Nested Class Summary

Nested classes/interfaces inherited from class com.sap.netweaver.rtmf.messagingimpl.services.RTMFService

RTMFService.RTMFClusterMessage

Constructor Summary

RTMFSyncService(String serviceName)
Deprecated. Constructs a sync service with the specified name, and adds it to the service list.

Method Summary

abstract List<RTMFMessage>	onMessageArrived(RTMFMessage message) Deprecated. Handles messages sent from server applications.
abstract List<RTMFMessage>	onUserMessageArrived(RTMFMessage message, String user) Deprecated. Handles messages sent from a client.

Methods inherited from class com.sap.netweaver.rtmf.messagingimpl.services.RTMFService

destroy, getMonitoringInformationAsHTMLString, getServiceName, onClusterMessageArrived, registerToMessages, registerToMessages, unregisterToMessages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RTMFSyncService

public RTMFSyncService(String serviceName)

Deprecated.

Constructs a sync service with the specified name, and adds it to the service list.
When extending this class to create a sync service, always call this method in the superclass from within the constructors.

Parameters:

serviceName - the name of the service

Method Detail

onMessageArrived

public abstract List<RTMFMessage> onMessageArrived(RTMFMessage message)

Deprecated.

Handles messages sent from server applications. In this method, you should implement the service's business logic for handling server application messages.

Returns a list of messages to the sending entity, based on your business logic.

Unlike for RTMFTopicService and RTMFQueueService, for RTMFSyncService this method is called explicitly, for example:
RMFService myService = RTMFServices.getRTMFServicesInstance().getService("MyService");

Specified by:

onMessageArrived in class RTMFService

Parameters:

message - the message that is sent to the service

Returns:

a list of messages

onUserMessageArrived

public abstract List<RTMFMessage> onUserMessageArrived(RTMFMessage message,
                                                       String user)

Deprecated.

Handles messages sent from a client. In this method, you should implement the service's business logic for handling client messages.

SECURITY WARNING: The message might be from an unknown or malicious source and even from an altogether un-authenticated source (in which case the user parameter would be null). The received message might contain malicious data or script in its properties and parameters.
Any call to this function should be treated as a potential security risk.

Returns a list of messages to the sending entity, based on your business logic.

Specified by:

onUserMessageArrived in class RTMFService

Parameters:

message - the message

user - the user's Unique Id (UME)

Returns:

a list of RTMF messages

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/rtmf/messaging/apideprecated	api	EP-PIN