A B C D E F G H I L M N O P R S T

A

addInputMapping(String, String, MessageBoxKey) - Method in interface message.MessageCentre

Set a portlet message key => message box mapping.

addInputMapping(MessageBoxKey, MessageBoxKey) - Method in interface message.MessageCentre

addInputMapping(String, String, MessageBoxKey) - Method in class message.MessageCentreImpl

Set a portlet message key => message box mapping.

addInputMapping(MessageBoxKey, MessageBoxKey) - Method in class message.MessageCentreImpl

addOutputMapping(String, String, MessageBoxKey) - Method in interface message.MessageCentre

Add a portlet message key => message box mapping.

addOutputMapping(MessageBoxKey, MessageBoxKey) - Method in interface message.MessageCentre

addOutputMapping(String, String, MessageBoxKey) - Method in class message.MessageCentreImpl

Add a portlet message key => message box mapping.

addOutputMapping(MessageBoxKey, MessageBoxKey) - Method in class message.MessageCentreImpl

B

BasicMessageStore - class message.store.BasicMessageStore.

Storage and retrieval of portlet message mappings, and the messages.

BasicMessageStore() - Constructor for class message.store.BasicMessageStore

C

COOKIE_NAME - Static variable in class message.portlets.CookieSetterPortlet

CookieSessionIDRetriever - class message.retriever.CookieSessionIDRetriever.

Implementation allowing access to the user's cross-context session id from a cookie ("cookie_msg_session_id").

CookieSessionIDRetriever() - Constructor for class message.retriever.CookieSessionIDRetriever

CookieSetterPortlet - class message.portlets.CookieSetterPortlet.

This portlet sets a cookie with a session id that should be visible to all portlet applications on that portal.

CookieSetterPortlet() - Constructor for class message.portlets.CookieSetterPortlet

classes - Static variable in class message.MessagingFactory

clearAllOutputMappings(MessageBoxKey) - Method in interface message.MessageCentre

Remove any existing output mappings for this key.

clearAllOutputMappings(MessageBoxKey) - Method in class message.MessageCentreImpl

Remove any existing output mappings for this key.

clearAllOutputMappings(MessageBoxKey) - Method in interface message.MessageStore

clearAllOutputMappings(MessageBoxKey) - Method in class message.store.BasicMessageStore

clearInputMapping(MessageBoxKey) - Method in interface message.MessageCentre

Remove a message key => message box mapping.

clearInputMapping(MessageBoxKey) - Method in class message.MessageCentreImpl

Remove a message key => message box mapping.

clearPrefs(PortletPreferences) - Static method in class message.MessageHelper

compareTo(Object) - Method in class message.MessageBoxKey

D

default_properties - Static variable in class message.MessageConfig

deleteInput(MessageBoxKey) - Method in interface message.MessageCentre

Remove all trace of the specified input message box.

deleteInput(MessageBoxKey) - Method in class message.MessageCentreImpl

Remove all trace of the specified input message box.

deleteInput(MessageBoxKey) - Method in interface message.MessageStore

deleteInput(MessageBoxKey) - Method in class message.store.BasicMessageStore

deleteOutput(MessageBoxKey) - Method in interface message.MessageCentre

Remove all trace of the specified output message box.

deleteOutput(MessageBoxKey) - Method in class message.MessageCentreImpl

Remove all trace of the specified output message box.

deleteOutput(MessageBoxKey) - Method in interface message.MessageStore

deleteOutput(MessageBoxKey) - Method in class message.store.BasicMessageStore

doEdit(RenderRequest, RenderResponse) - Method in class message.portlets.MessageReaderPortlet

doHelp(RenderRequest, RenderResponse) - Method in class message.portlets.MessageReaderPortlet

doView(RenderRequest, RenderResponse) - Method in class message.portlets.CookieSetterPortlet

doView(RenderRequest, RenderResponse) - Method in class message.portlets.MessageReaderPortlet

E

equals(Object) - Method in class message.MessageBoxKey

F

findInputSource(String, String) - Method in interface message.MessageCentre

Get the key of the source message box for this portletID+name combination.

findInputSource(MessageBoxKey) - Method in interface message.MessageCentre

findInputSource(String, String) - Method in class message.MessageCentreImpl

Get the key of the source message box for this portletID+name combination.

findInputSource(MessageBoxKey) - Method in class message.MessageCentreImpl

findOutputTargets(String, String) - Method in interface message.MessageCentre

This will always return a Set which contains at least a key for a message box corresponding to the provided portletID+name (it always outputs to itself as well as any other registered mappings)

findOutputTargets(MessageBoxKey) - Method in interface message.MessageCentre

findOutputTargets(String, String) - Method in class message.MessageCentreImpl

This will always return a Set which contains at least a key for a message box corresponding to the provided portletID+name (it always outputs to itself as well as any other registered mappings)

findOutputTargets(MessageBoxKey) - Method in class message.MessageCentreImpl

findOutputTargets(MessageBoxKey) - Method in interface message.MessageStore

findOutputTargets(MessageBoxKey) - Method in class message.store.BasicMessageStore

formString() - Method in class message.MessageBoxKey

G

get(String, String) - Method in interface message.MessageCentre

Get message for this portletID+name combination.

get(MessageBoxKey) - Method in interface message.MessageCentre

Get message from this message box.

get(String, String) - Method in class message.MessageCentreImpl

Get message for this portletID+name combination.

get(MessageBoxKey) - Method in class message.MessageCentreImpl

Get message from this message box.

get(String) - Method in class message.MessageHelper

Get message.

getAllInputKeys() - Method in interface message.MessageCentre

getAllInputKeys() - Method in class message.MessageCentreImpl

getAllInputKeys() - Method in interface message.MessageStore

getAllInputKeys() - Method in class message.store.BasicMessageStore

getAllOutputKeys() - Method in interface message.MessageCentre

getAllOutputKeys() - Method in class message.MessageCentreImpl

getAllOutputKeys() - Method in interface message.MessageStore

getAllOutputKeys() - Method in class message.store.BasicMessageStore

getAsString(String) - Method in class message.MessageHelper

Get message as String.

getBoxes() - Method in interface message.MessageCentre

getBoxes() - Method in class message.MessageCentreImpl

getBoxes() - Method in interface message.MessageStore

getBoxes() - Method in class message.store.BasicMessageStore

getConfigProperty(String) - Static method in class message.MessageConfig

getInputKeys(String) - Method in interface message.MessageCentre

getInputKeys(String) - Method in class message.MessageCentreImpl

getInputKeys(String) - Method in interface message.MessageStore

getInputKeys(String) - Method in class message.store.BasicMessageStore

getInputSource(MessageBoxKey) - Method in interface message.MessageStore

getInputSource(MessageBoxKey) - Method in class message.store.BasicMessageStore

getKeysWithNamespace(Collection, String) - Method in class message.store.BasicMessageStore

getLoadedPrefs(PortletSession) - Static method in class message.MessageHelper

getMessage(MessageBoxKey) - Method in interface message.MessageStore

getMessage(MessageBoxKey) - Method in class message.store.BasicMessageStore

getMessageCentre(PortletSession, String) - Static method in class message.MessageHelper

Retrieve MessageCentre for messaging between portlets in one or more webapps.

getMessageCentre(String) - Static method in class message.MessagingFactory

Get a message centre for the given browser session ID.

getName() - Method in class message.MessageBoxKey

getNamespace() - Method in class message.MessageBoxKey

getNewInstance(String) - Static method in class message.MessagingFactory

getOutputKeys(String) - Method in interface message.MessageCentre

getOutputKeys(String) - Method in class message.MessageCentreImpl

getOutputKeys(String) - Method in interface message.MessageStore

getOutputKeys(String) - Method in class message.store.BasicMessageStore

getPortletID(PortletRequest) - Static method in class message.MessageHelper

Utility: get (and set, if not yet present) a unique ID for this portlet instance, cached in the session.

getPortletID(PortletRequest, boolean) - Static method in class message.MessageHelper

Utility: get (and set, if not yet present) a unique ID for this portlet instance, cached in the session.

getPortletWindowID(PortletRequest) - Static method in class message.MessageHelper

Utility: Try to find the real portlet window ID, by setting a temporary attribute in the local portlet session.

getPublicBoxKeys() - Method in interface message.MessageCentre

getPublicBoxKeys() - Method in class message.MessageCentreImpl

getPublicBoxKeys() - Method in interface message.MessageStore

getPublicBoxKeys() - Method in class message.store.BasicMessageStore

getSessionID(PortletRequest) - Static method in class message.MessageHelper

Utility: get a browser session ID.

getSessionID(PortletRequest) - Method in interface message.SessionIDRetriever

getSessionID(PortletRequest) - Method in class message.retriever.CookieSessionIDRetriever

getSessionID(PortletRequest) - Method in class message.retriever.LocalSessionIDRetriever

getSessionID(PortletRequest) - Method in class message.retriever.NamespacedLocalSessionIDRetriever

getSessionID(PortletRequest) - Method in class message.retriever.PortletRequestSessionIDRetriever

getSessionID(PortletRequest) - Method in class message.retriever.RequestAttributeSessionIDRetriever

getSessionIDRetriever() - Static method in class message.MessagingFactory

Get an object to retrieve the user-session-id.

H

hashCode() - Method in class message.MessageBoxKey

I

INPUT - Static variable in interface message.MessageConstants

initialise(String) - Method in interface message.MessageStore

initialise(String) - Method in class message.store.BasicMessageStore

inputKeyMap - Variable in class message.store.BasicMessageStore

isLocal() - Method in class message.MessageBoxKey

isValid() - Method in interface message.MessageCentre

isValid() - Method in class message.MessageCentreImpl

isValid() - Method in interface message.MessageStore

isValid() - Method in class message.store.BasicMessageStore

L

LocalSessionIDRetriever - class message.retriever.LocalSessionIDRetriever.

Implementation for use when you only want portlets in one webapp to communicate: it just uses the local portlet session id.

LocalSessionIDRetriever() - Constructor for class message.retriever.LocalSessionIDRetriever

loadPrefs(PortletRequest) - Static method in class message.MessageHelper

Loads portlet preferences for message mappings into the session, if this has not already been done (checked using loadedPrefs).

loadPrefs(PortletRequest, String, String) - Static method in class message.MessageHelper

Loads portlet preferences for message mappings into the session, if this has not already been done (checked using loadedPrefs).

loadedPrefs(PortletSession, String) - Static method in class message.MessageHelper

local - Variable in class message.MessageBoxKey

M

MESSAGE_STORE - Static variable in class message.MessageConfig

MSG - Static variable in class message.MessageUtils

MSG_CENTRE_KEY - Static variable in interface message.MessageConstants

MSG_LOADED - Static variable in interface message.MessageConstants

MSG_PORTLET_ID - Static variable in interface message.MessageConstants

MSG_SESSION_ID_RETRIEVER - Static variable in interface message.MessageConstants

MessageBoxKey - class message.MessageBoxKey.

This is the identifier for a message box.

MessageBoxKey(String) - Constructor for class message.MessageBoxKey

MessageBoxKey(String, String) - Constructor for class message.MessageBoxKey

MessageBoxKey(String, String, boolean) - Constructor for class message.MessageBoxKey

MessageCentre - interface message.MessageCentre.

Storage and retrieval of portlet message mappings, and the messages.

MessageCentreImpl - class message.MessageCentreImpl.

Storage and retrieval of portlet message mappings, and the messages.

MessageCentreImpl() - Constructor for class message.MessageCentreImpl

MessageConfig - class message.MessageConfig.

Access to messaging configuration: message.PortletMessaging.properties You can define classes to use for the MessageStore ("message.store"), and SessionIDRetriever ("session.id.retriever").

MessageConfig() - Constructor for class message.MessageConfig

MessageConstants - interface message.MessageConstants.

MessageHelper - class message.MessageHelper.

This is intended as the main interface between portlet code and the messaging system.

MessageHelper(PortletSession, String, String) - Constructor for class message.MessageHelper

Retrieve MessageHelper for messaging between portlets in one or more webapps.

MessageHelper(PortletRequest) - Constructor for class message.MessageHelper

Retrieve MessageHelper.

MessageReaderPortlet - class message.portlets.MessageReaderPortlet.

A message snooper portlet for debugging.

MessageReaderPortlet() - Constructor for class message.portlets.MessageReaderPortlet

MessageStore - interface message.MessageStore.

Storage and retrieval of portlet message mappings, and the messages.

MessageUtils - class message.MessageUtils.

Some functions for use with the dynamic mapping form.

MessageUtils() - Constructor for class message.MessageUtils

MessagingFactory - class message.MessagingFactory.

Generates objects based on configuration settings in MessageConfig

MessagingFactory() - Constructor for class message.MessagingFactory

makeLocalKey(String, String) - Method in class message.MessageCentreImpl

message - package message

message.portlets - package message.portlets

message.retriever - package message.retriever

message.store - package message.store

msgBoxes - Variable in class message.store.BasicMessageStore

msgCentre - Variable in class message.MessageHelper

N

NS_LOCAL - Static variable in interface message.MessageConstants

NamespacedLocalSessionIDRetriever - class message.retriever.NamespacedLocalSessionIDRetriever.

Implementation for use when you really only want portlets to communicate within their own webapp (no interference).

NamespacedLocalSessionIDRetriever() - Constructor for class message.retriever.NamespacedLocalSessionIDRetriever

name - Variable in class message.MessageBoxKey

namespace - Variable in class message.MessageBoxKey

O

OUTPUT - Static variable in interface message.MessageConstants

outputKeyMap - Variable in class message.store.BasicMessageStore

P

PREF_IN_PREFIX - Static variable in interface message.MessageConstants

PREF_NAME - Static variable in interface message.MessageConstants

PREF_OUT_PREFIX - Static variable in interface message.MessageConstants

PREF_PUBLISHNAME - Static variable in interface message.MessageConstants

PREF_PUBLISHNS - Static variable in interface message.MessageConstants

PREF_SOURCENAME - Static variable in interface message.MessageConstants

PREF_SOURCENS - Static variable in interface message.MessageConstants

PortletRequestSessionIDRetriever - class message.retriever.PortletRequestSessionIDRetriever.

Implementation allowing access to the user's cross-context session id from PortletRequest.getRequestedSessionId().

PortletRequestSessionIDRetriever() - Constructor for class message.retriever.PortletRequestSessionIDRetriever

parseFormString(String) - Static method in class message.MessageBoxKey

portletID - Variable in class message.MessageHelper

prepareMappingForm(PortletRequest, String, String) - Static method in class message.MessageUtils

To be called in doEdit.

processAction(ActionRequest, ActionResponse) - Method in class message.portlets.MessageReaderPortlet

processMappingForm(ActionRequest, ActionResponse, String, String) - Static method in class message.MessageUtils

To be called in processAction when the edit_mappings.jsp form has been submitted.

props - Static variable in class message.MessageConfig

R

RequestAttributeSessionIDRetriever - class message.retriever.RequestAttributeSessionIDRetriever.

Implementation allowing access to the user's cross-context session id from a request attribute ("message.portal_session_id").

RequestAttributeSessionIDRetriever() - Constructor for class message.retriever.RequestAttributeSessionIDRetriever

S

SESSION_ID_RETRIEVER - Static variable in class message.MessageConfig

SET_COOKIE - Static variable in class message.portlets.CookieSetterPortlet

SessionIDRetriever - interface message.SessionIDRetriever.

Interface allowing access to the user's cross-context session id.

saveInputMapping(MessageBoxKey, MessageBoxKey) - Method in interface message.MessageStore

saveInputMapping(MessageBoxKey, MessageBoxKey) - Method in class message.store.BasicMessageStore

saveOutputMapping(MessageBoxKey, MessageBoxKey) - Method in interface message.MessageStore

saveOutputMapping(MessageBoxKey, MessageBoxKey) - Method in class message.store.BasicMessageStore

savePrefs(PortletRequest, String, String) - Static method in class message.MessageHelper

send(String, String, Object) - Method in interface message.MessageCentre

Send message to this portletID+name combination.

send(Set, Object) - Method in interface message.MessageCentre

Send message to these message boxes.

send(String, String, Object) - Method in class message.MessageCentreImpl

Send message to this portletID+name combination.

send(Set, Object) - Method in class message.MessageCentreImpl

Send message to these message boxes.

send(String, Object) - Method in class message.MessageHelper

Send message.

sendMessage(Set, Object) - Method in interface message.MessageStore

sendMessage(Set, Object) - Method in class message.store.BasicMessageStore

sessionID - Variable in class message.MessageHelper

setLoadedPrefs(PortletSession, String, boolean) - Static method in class message.MessageHelper

Sets a marker for whether or not the message mappings in the specified portlet's preferences have been loaded into the session.

setLocalNamespace(String) - Method in class message.MessageBoxKey

setName(String) - Method in class message.MessageBoxKey

setNamespace(String) - Method in class message.MessageBoxKey

setStore(MessageStore) - Method in interface message.MessageCentre

setStore(MessageStore) - Method in class message.MessageCentreImpl

store - Variable in class message.MessageCentreImpl

T

toString() - Method in class message.MessageBoxKey

A B C D E F G H I L M N O P R S T