org.apache.myfaces.extensions.cdi.message.api
Interface MessageHandler

All Superinterfaces:
Serializable
All Known Subinterfaces:
CompositeMessageHandler, MessageContext
All Known Implementing Classes:
AbstractMessageHandler

public interface MessageHandler
extends Serializable

an implementation is allowed to store messages directly or to forward messages


Method Summary
 void addMessage(MessageContext messageContext, Message message)
          called to add a message to a special target (known by the implementations)
 void addMessageFilter(MessageFilter... messageFilters)
           
 Set<MessageFilter> getMessageFilters()
           
 List<Message> getMessages()
           
 void removeAllMessages()
          removes all added messages (if possible)
 void removeMessage(Message message)
          removes an added message (if possible)
 

Method Detail

addMessage

void addMessage(MessageContext messageContext,
                Message message)
called to add a message to a special target (known by the implementations)

Parameters:
messageContext - current message context
message - the new message to add

addMessageFilter

void addMessageFilter(MessageFilter... messageFilters)
Parameters:
messageFilters - message filters which should be added to the current message handler

getMessageFilters

Set<MessageFilter> getMessageFilters()
Returns:
the registered message filter(s)

removeMessage

void removeMessage(Message message)
removes an added message (if possible)

Parameters:
message - to be removed

removeAllMessages

void removeAllMessages()
removes all added messages (if possible)


getMessages

List<Message> getMessages()
Returns:
all added messages (if they are available)


Copyright © 2010-2012 The Apache Software Foundation. All Rights Reserved.