message
Interface MessageStore

All Known Implementing Classes:

BasicMessageStore

public interface MessageStore

Storage and retrieval of portlet message mappings, and the messages. Implement this interface if you want to create a custom Message Store.

See Also:

MessageCentre

Method Summary

void	clearAllOutputMappings(MessageBoxKey key)
void	deleteInput(MessageBoxKey key)
void	deleteOutput(MessageBoxKey key)
java.util.Set	findOutputTargets(MessageBoxKey key)
java.util.Set	getAllInputKeys()
java.util.Set	getAllOutputKeys()
java.util.Map	getBoxes()
java.util.Set	getInputKeys(java.lang.String portletID)
MessageBoxKey	getInputSource(MessageBoxKey key)
java.lang.Object	getMessage(MessageBoxKey key)
java.util.Set	getOutputKeys(java.lang.String portletID)
java.util.Set	getPublicBoxKeys()
void	initialise(java.lang.String sessionID)
boolean	isValid()
void	saveInputMapping(MessageBoxKey key, MessageBoxKey source)
void	saveOutputMapping(MessageBoxKey key, MessageBoxKey target)
void	sendMessage(java.util.Set targetKeys, java.lang.Object message)

Method Detail

initialise

public void initialise(java.lang.String sessionID)

saveInputMapping

public void saveInputMapping(MessageBoxKey key,
                             MessageBoxKey source)

deleteInput

public void deleteInput(MessageBoxKey key)

saveOutputMapping

public void saveOutputMapping(MessageBoxKey key,
                              MessageBoxKey target)

clearAllOutputMappings

public void clearAllOutputMappings(MessageBoxKey key)

deleteOutput

public void deleteOutput(MessageBoxKey key)

findOutputTargets

public java.util.Set findOutputTargets(MessageBoxKey key)

getInputSource

public MessageBoxKey getInputSource(MessageBoxKey key)

getMessage

public java.lang.Object getMessage(MessageBoxKey key)

sendMessage

public void sendMessage(java.util.Set targetKeys,
                        java.lang.Object message)

getInputKeys

public java.util.Set getInputKeys(java.lang.String portletID)

getOutputKeys

public java.util.Set getOutputKeys(java.lang.String portletID)

getPublicBoxKeys

public java.util.Set getPublicBoxKeys()

getBoxes

public java.util.Map getBoxes()

getAllInputKeys

public java.util.Set getAllInputKeys()

getAllOutputKeys

public java.util.Set getAllOutputKeys()

isValid

public boolean isValid()