UMOProviderDescriptor

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> mule >> [ umo overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.mule.umo.UMOProviderDescriptor

SOURCE |

Download org.mule.umo.UMOProviderDescriptor

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.mule.umo
Interface UMOProviderDescriptor

All Superinterfaces:: java.lang.Cloneable, java.io.Serializable

public interface UMOProviderDescriptor
extends java.io.Serializable, java.lang.Cloneable

UMOProviderDescriptor describes a Provider in the Mule Server. A provider is a grouping of a connector, an endpoint and a transformer.

Version:: $Revision: 1.5 $

Method Summary

java.lang.Object doTransformation(java.lang.Object message)
          Transforms the payload message using the transformation for this Provider if there is no inbound transformation set the original payload is returned

org.mule.umo.provider.UMOConnector getConnector()
          The connector that will be used to send the message on.

java.lang.String getEndpoint()
          This specifes the communication endpoint.

java.lang.String getName()
          The name is the identifier for the provider

java.util.HashMap getProperties()


java.lang.String getProtocol()
          The transport protocol name that the message provider communicates over.

org.mule.umo.transformer.UMOTransformer getTransformer()
          The transformer is responsible for transforming data when it is received or sent by the UMO (depending on whether this provider is a receiver or not).

boolean isDefault()
          A list of providers is maintained by a UMODescriptor.

boolean isReadOnly()


boolean isReceiver()
          Determines whether the message provider is a sender or receiver.

void setConnector(org.mule.umo.provider.UMOConnector connector)
          The connector that will be used to send the message on.

void setDefault(boolean b)
          A list of providers is maintained by a UMODescriptor.

void setEndpoint(java.lang.String endpoint)
          This specifes the communication endpoint.

void setName(java.lang.String name)


void setProperties(java.util.HashMap map)


void setReceiver(boolean receiver)
          Determines whether the message provider is a sender or receiver.

void setTransformer(org.mule.umo.transformer.UMOTransformer trans)
          The transformer is responsible for transforming data when it is received or sent by the UMO (depending on whether this provider is a receiver or not).

Method Detail

getEndpoint

public java.lang.String getEndpoint()

This specifes the communication endpoint. This will have a different format depending on the transport protocol being used i.e.

smtp -> admin@mycompany.com
jms -> shipping.orders.topic
sms -> +447910010010

if an endpoint is not specifed it will be assumed that it will be determined at run-time by the calling application. The endpoint can be aliteral endpoint such as an email address or it can be a logical name for an endpoint as long as it is declared in a message-endpoint block. When the message-provider is created the endpoint is first lookup in the endpoint registry and if nothing is returned the endpoint value itself is used.

setEndpoint

public void setEndpoint(java.lang.String endpoint)

This specifes the communication endpoint. This will have a different format depending on the transport protocol being used i.e.

smtp -> admin@mycompany.com
jms -> shipping.orders.topic
sms -> +447910010010

isReceiver

public boolean isReceiver()

Determines whether the message provider is a sender or receiver. The default is 'false'.

setReceiver

public void setReceiver(boolean receiver)

Determines whether the message provider is a sender or receiver.

getConnector

public org.mule.umo.provider.UMOConnector getConnector()

The connector that will be used to send the message on. It is important that the endpoint and the connection correlate i.e. if your endpoint is a jms queue your connection must be a JMS connector.

setConnector

public void setConnector(org.mule.umo.provider.UMOConnector connector)

The connector that will be used to send the message on. It is important that the endpoint and the connection correlate i.e. if your endpoint is a jms queue your connection must be a JMS connector.

getName

public java.lang.String getName()

The name is the identifier for the provider

setName

public void setName(java.lang.String name)

setTransformer

public void setTransformer(org.mule.umo.transformer.UMOTransformer trans)

The transformer is responsible for transforming data when it is received or sent by the UMO (depending on whether this provider is a receiver or not). A tranformation for an inbound event can be forced by the user by calling the inbound event.getTransformedMessage(). A tranformation for an outbound event is called or when the UMO dispatchEvent() or sendEvent() methods are called.

This attribute represents the name of the transformer to use as declared in the transformers section of the configuration file. IF a name for the transformer is not set on the configuration element, it will default to the name of the className attribute minus the package name.

getTransformer

public org.mule.umo.transformer.UMOTransformer getTransformer()

doTransformation

public java.lang.Object doTransformation(java.lang.Object message)
                                  throws org.mule.umo.transformer.TransformerException

Transforms the payload message using the transformation for this Provider if there is no inbound transformation set the original payload is returned

isDefault

public boolean isDefault()

A list of providers is maintained by a UMODescriptor. For send providers and receive providers a default for each type can be set in the list.

setDefault

public void setDefault(boolean b)