com.ibm.ecm.event.messages

Class DocumentMessageGenerator

java.lang.Object

com.ibm.ecm.event.messages.DocumentMessageGenerator

All Implemented Interfaces:

MessageGenerator<Document>

public class DocumentMessageGenerator
extends java.lang.Object
implements MessageGenerator<Document>

Since:

3.0.11

Constructor Summary

Constructors

Constructor and Description
DocumentMessageGenerator(ForwardedMessage formattedMessage)

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	extraParameters(java.lang.reflect.Method handlerMethod, boolean synchronous) Generates and returns any extra parameters this generator can generate and the handler method accepts.
Document	message() Generates and returns the message to be passed to the subscribed event handlers as the first parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentMessageGenerator

public DocumentMessageGenerator(ForwardedMessage formattedMessage)
                         throws java.io.IOException

Parameters:

formattedMessage -

Throws:

java.io.IOException

Method Detail

message

public Document message()

Generates and returns the message to be passed to the subscribed event handlers as the first parameter.

Specified by:

message in interface MessageGenerator<Document>

Returns:

the message

extraParameters

public java.lang.Object[] extraParameters(java.lang.reflect.Method handlerMethod,
                                          boolean synchronous)

Generates and returns any extra parameters this generator can generate and the handler method accepts. This method needs to return all the extra parameters the handler method accepts excluding the first parameter.

Specified by:

extraParameters in interface MessageGenerator<Document>

Parameters:

handlerMethod - the event handler method

synchronous - whether the event will be handled synchronously

Returns:

the extra parameters the handler method accepts excluding the first parameter