com.sapportals.portal.prt.service.notification

Class TopicDataContainer

java.lang.Object
  com.sapportals.portal.prt.service.notification.TopicDataContainer

public class TopicDataContainer
extends Object

TopicDataContainer is used to build Topic messages that can be exchanged between PRTs. it is not THREAD SAFE Created: Wed 16 Jan 2002 Copyright (c) SAP Portals Europe GmbH 2002 Last modified on $Date$ by $Author$ using $Change$

Field Summary

static String	BOUNDARY
static String	BOUNDARY_LINE
static TopicType	FILE
static TopicType	INT
static TopicType	STREAM
static TopicType	STRING
static String	TOPIC_NAME

Constructor Summary

TopicDataContainer(String topicName)

Method Summary

void	addTopicData(String key, String data) Adds a String data to this Topic message.
void	addTopicData(String key, TopicData data) Adds a TopicData object to this Topic message.
void	convertContainer(ByteArrayOutputStream outPut2)
Enumeration	getTopicDataKeys() Returns an enumeration of the name of all the data of this Topic Message.
TopicData	getTopicDataValue(String key)
Enumeration	getTopicDataValues() Returns an enumeration of the values of all the data of this Topic Message.
String	getTopicName() Returns the Topic name of this Topic message.
void	removeTopicData(String key)
byte[]	toByteArray()
String	toString() Describes this container.
void	updateTopicName(String topicName)

Methods inherited from class java.lang.Object

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

Field Detail

STRING

public static final TopicType STRING

INT

public static final TopicType INT

STREAM

public static final TopicType STREAM

FILE

public static final TopicType FILE

BOUNDARY

public static final String BOUNDARY

See Also:

Constant Field Values

TOPIC_NAME

public static final String TOPIC_NAME

See Also:

Constant Field Values

BOUNDARY_LINE

public static final String BOUNDARY_LINE

See Also:

Constant Field Values

Constructor Detail

TopicDataContainer

public TopicDataContainer(String topicName)

Method Detail

addTopicData

public void addTopicData(String key,
                         String data)

Adds a String data to this Topic message.

Parameters:

key - - name of the data

data - - value of the data

addTopicData

public void addTopicData(String key,
                         TopicData data)

Adds a TopicData object to this Topic message.

Parameters:

key - - name of the data

data - - TopicData

removeTopicData

public void removeTopicData(String key)

updateTopicName

public void updateTopicName(String topicName)

toByteArray

public byte[] toByteArray()

getTopicName

public String getTopicName()

Returns the Topic name of this Topic message.

getTopicDataKeys

public Enumeration getTopicDataKeys()

Returns an enumeration of the name of all the data of this Topic Message.

getTopicDataValues

public Enumeration getTopicDataValues()

Returns an enumeration of the values of all the data of this Topic Message.

getTopicDataValue

public TopicData getTopicDataValue(String key)

convertContainer

public void convertContainer(ByteArrayOutputStream outPut2)
                      throws IOException

Throws:

IOException

toString

public String toString()

Describes this container.

Overrides:

toString in class Object

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._coreservicedeprecated	default	EP-PIN-PRT