raccoon.api.eai.endpoint
Interface IPublisher

All Known Implementing Classes:

TibrvPublisher

public interface IPublisher

Common interface for all implementations of a Publisher.

Since:

Raccoon v0.4

Version:

$Id: IPublisher.java,v 1.1 2004/08/08 20:25:56 crouvrais Exp $

Author:

Cedric ROUVRAIS

Field Summary

static java.lang.String	EVENT_SUBJECT The constant representing the property for the event subject.
static java.lang.String	NATIVE_PUBLISHER The constant representing the property for the native publisher.

Method Summary

java.lang.String	getEventSubject() Indicates the topic/subject on which the event will be fired.
java.lang.Object	getNativePub() Extracts the native publisher used.
void	send(java.lang.Object pJavaBeanToSend) Sends over the EAI infrastructure a java bean.
void	send(java.lang.Object pJavaBeanToSend, ITracking pTracking) Sends over the EAI infrastructure a java bean.
void	send(java.lang.String pSubject, java.lang.Object pJavaBeanToSend) Sends over the EAI infrastructure a java bean on a specific subject.
void	send(java.lang.String pSubject, java.lang.Object pJavaBeanToSend, ITracking pTracking) Sends over the EAI infrastructure a java bean.
java.lang.Object	sendRequest(java.lang.Object pRequest) Sends a request over the EAI infrastructure.
void	setNativePub(java.lang.Object pPublisher) Assigns the native publisher to use.

Field Detail

NATIVE_PUBLISHER

static final java.lang.String NATIVE_PUBLISHER

The constant representing the property for the native publisher.

See Also:

Constant Field Values

EVENT_SUBJECT

static final java.lang.String EVENT_SUBJECT

The constant representing the property for the event subject.

See Also:

Constant Field Values

Method Detail

getEventSubject

java.lang.String getEventSubject()

Indicates the topic/subject on which the event will be fired.

Returns:

the embbedded topic/subject used by default.

send

void send(java.lang.Object pJavaBeanToSend)
          throws RaccoonException

Sends over the EAI infrastructure a java bean.

Parameters:

pJavaBeanToSend - the java bean to send.

Throws:

RaccoonException - if the java bean couldn't be sent.

send

void send(java.lang.String pSubject,
          java.lang.Object pJavaBeanToSend)
          throws RaccoonException

Sends over the EAI infrastructure a java bean on a specific subject.

Parameters:

pSubject - a MOM compliant subject/topic.

pJavaBeanToSend - the java bean to send over the MOM

Throws:

RaccoonException - if the message couldn't be sent over the MOM

send

void send(java.lang.Object pJavaBeanToSend,
          ITracking pTracking)
          throws RaccoonException

Sends over the EAI infrastructure a java bean.

Parameters:

pJavaBeanToSend - the java bean to send.

pTracking - the tracking information to attach to the given message

Throws:

RaccoonException - if the java bean couldn't be sent.

send

void send(java.lang.String pSubject,
          java.lang.Object pJavaBeanToSend,
          ITracking pTracking)
          throws RaccoonException

Sends over the EAI infrastructure a java bean.

Parameters:

pSubject - a MOM compliant subject/topic.

pJavaBeanToSend - the java bean to send.

pTracking - the tracking information to attach to the given message

Throws:

RaccoonException - if the java bean couldn't be sent.

sendRequest

java.lang.Object sendRequest(java.lang.Object pRequest)
                             throws RaccoonException

Sends a request over the EAI infrastructure.

Parameters:

pRequest - the java bean to send that represents the request.

Returns:

the reply in form of a java bean.

Throws:

RaccoonException - if something goes wrong

getNativePub

java.lang.Object getNativePub()

Extracts the native publisher used.

Returns:

embedded publisher for a specific MOM.

setNativePub

void setNativePub(java.lang.Object pPublisher)
                  throws RaccoonException,
                         java.lang.IllegalArgumentException

Assigns the native publisher to use.

Parameters:

pPublisher - the native publisher to use for a specific MOM.

Throws:

RaccoonException - if this component is already running: the component can't be changed. Error code is ErrorCodes.COMPONENT_INITIALISED

java.lang.IllegalArgumentException - if the parameter is null, the message is obtained via MsgHelper.formatNullParamter(java.lang.String, java.lang.Class)