Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> umo >> [ impl overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mule.umo.impl
Class MuleProviderDescriptor  

java.lang.Object
  org.mule.umo.impl.MuleProviderDescriptor

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, org.mule.umo.UMOProviderDescriptor

---

public class MuleProviderDescriptor

extends java.lang.Object

implements org.mule.umo.UMOProviderDescriptor

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

Version:

$Revision: 1.11 $

---

Field Summary
private  org.mule.umo.provider.UMOConnector	connector           The connector used to communicate with the external system
private  boolean	defaultProvider           Determines whether the provider is the default provider in a list of providers
private  java.lang.String	endpoint           The endpoint on which to send or receive information
private  java.lang.String	name           The name for the provider
private  java.util.HashMap	properties           Any additional properties for the provider
private  boolean	readOnly           determines whether the provider is read-only
private  boolean	receiver           Determines whether the provider is a receiver or sender
private  org.mule.umo.transformer.UMOTransformer	transformer           The transformer used to transform the incoming or outgoing data

 

Constructor Summary

MuleProviderDescriptor()           Default constructor

 

Method Summary
private  void	checkReadOnly(java.lang.String propName)           Determines with the property specified is read-only Right now all properties on the provider are read-only if the read-only flag is set
java.lang.Object	clone()           This method may be called to create a new copy of the Object.
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)
(package private)  void	setReadOnly(boolean b)
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).
java.lang.String	toString()           Convert this Object to a human-readable String.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

connector

private org.mule.umo.provider.UMOConnector connector

The connector used to communicate with the external system

---

endpoint

private java.lang.String endpoint

The endpoint on which to send or receive information

---

transformer

private org.mule.umo.transformer.UMOTransformer transformer

The transformer used to transform the incoming or outgoing data

---

name

private java.lang.String name

The name for the provider

---

receiver

private boolean receiver

Determines whether the provider is a receiver or sender

---

defaultProvider

private boolean defaultProvider

Determines whether the provider is the default provider in a list of providers

---

properties

private java.util.HashMap properties

Any additional properties for the provider

---

readOnly

private boolean readOnly

determines whether the provider is read-only

Constructor Detail

MuleProviderDescriptor

public MuleProviderDescriptor()

Default constructor

Method Detail

getEndpoint

public java.lang.String getEndpoint()

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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.

Specified by:

getEndpoint in interface org.mule.umo.UMOProviderDescriptor

---

setEndpoint

public void setEndpoint(java.lang.String endpoint)

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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.

Specified by:

setEndpoint in interface org.mule.umo.UMOProviderDescriptor

---

isReceiver

public boolean isReceiver()

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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

Specified by:

isReceiver in interface org.mule.umo.UMOProviderDescriptor

---

setReceiver

public void setReceiver(boolean receiver)

Description copied from interface: org.mule.umo.UMOProviderDescriptor

Determines whether the message provider is a sender or receiver.

Specified by:

setReceiver in interface org.mule.umo.UMOProviderDescriptor

---

getConnector

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

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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.

Specified by:

getConnector in interface org.mule.umo.UMOProviderDescriptor

---

setConnector

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

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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.

Specified by:

setConnector in interface org.mule.umo.UMOProviderDescriptor

---

getName

public java.lang.String getName()

Description copied from interface: org.mule.umo.UMOProviderDescriptor

The name is the identifier for the provider

Specified by:

getName in interface org.mule.umo.UMOProviderDescriptor

---

setName

public void setName(java.lang.String name)

Specified by:

setName in interface org.mule.umo.UMOProviderDescriptor

---

setTransformer

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

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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.

Specified by:

setTransformer in interface org.mule.umo.UMOProviderDescriptor

---

getTransformer

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

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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.

Specified by:

getTransformer in interface org.mule.umo.UMOProviderDescriptor

---

doTransformation

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

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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

Specified by:

doTransformation in interface org.mule.umo.UMOProviderDescriptor

---

isDefault

public boolean isDefault()

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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.

Specified by:

isDefault in interface org.mule.umo.UMOProviderDescriptor

---

setDefault

public void setDefault(boolean b)

Description copied from interface: org.mule.umo.UMOProviderDescriptor

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.

Specified by:

setDefault in interface org.mule.umo.UMOProviderDescriptor

---

getProperties

public java.util.HashMap getProperties()

Specified by:

getProperties in interface org.mule.umo.UMOProviderDescriptor

---

setProperties

public void setProperties(java.util.HashMap map)

Specified by:

setProperties in interface org.mule.umo.UMOProviderDescriptor

---

getProtocol

public java.lang.String getProtocol()

Description copied from interface: org.mule.umo.UMOProviderDescriptor

The transport protocol name that the message provider communicates over. i.e. jms, sms, smtp etc. The protocol must match that of the associated connector

Specified by:

getProtocol in interface org.mule.umo.UMOProviderDescriptor

---

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from class: java.lang.Object

This method may be called to create a new copy of the Object. The typical behavior is as follows:

• o == o.clone() is false
• o.getClass() == o.clone().getClass() is true
• o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object)>Object.equals(Object) 55 .

If the Object you call clone() on does not implement java.lang.Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 

---

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface org.mule.umo.UMOProviderDescriptor

---

setReadOnly

void setReadOnly(boolean b)

---

checkReadOnly

private void checkReadOnly(java.lang.String propName)

Determines with the property specified is read-only Right now all properties on the provider are read-only if the read-only flag is set

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> umo >> [ impl overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---