|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.mule.impl.ImmutableMuleEndpoint
org.mule.impl.endpoint.MuleEndpoint
MuleEndpoint describes a Provider in the Mule Server. A endpoint is
a grouping of an endpoint, an endpointUri and a transformer.
| Field Summary | |
static String |
ALWAYS_CREATE_STRING
|
static String |
NEVER_CREATE_STRING
|
| Fields inherited from class org.mule.impl.ImmutableMuleEndpoint |
connector, createConnector, deleteUnacceptedMessages, endpointEncoding, endpointUri, filter, initialised, initialState, logger, name, properties, remoteSync, remoteSyncTimeout, responseTransformer, securityFilter, streaming, synchronous, transactionConfig, transformer, type |
| Fields inherited from interface org.mule.umo.endpoint.UMOImmutableEndpoint |
ENDPOINT_TYPE_RECEIVER, ENDPOINT_TYPE_RESPONSE, ENDPOINT_TYPE_SENDER, ENDPOINT_TYPE_SENDER_AND_RECEIVER, INITIAL_STATE_STARTED, INITIAL_STATE_STOPPED |
| Constructor Summary | |
MuleEndpoint()
Default constructor This is required right now for the Mule digester to set the properties through the classes mutators |
|
MuleEndpoint(String uri,
boolean receiver)
|
|
MuleEndpoint(String name,
UMOEndpointURI endpointUri,
UMOConnector connector,
UMOTransformer transformer,
String type,
int createConnector,
String endpointEncoding,
Map props)
|
|
MuleEndpoint(UMOImmutableEndpoint endpoint)
|
|
| Method Summary | |
Object |
clone()
Make a deep copy of this endpoint |
boolean |
isReadOnly()
|
void |
setConnector(UMOConnector connector)
The endpoint that will be used to send the message on. |
void |
setCreateConnector(int action)
This attribute determines how a connector is obtained for the endpoint. |
void |
setCreateConnectorAsString(String action)
|
void |
setDeleteUnacceptedMessages(boolean delete)
If a filter is configured on this endpoint, this property will determine if message that are not excepted by the filter are deleted |
void |
setEncoding(String endpointEncoding)
Sets the encoding to be used for events received by this endpoint |
void |
setEndpointURI(UMOEndpointURI endpointUri)
This specifes the communication endpointUri. |
void |
setFilter(UMOFilter filter)
The filter to apply to incoming messages |
void |
setInitialState(String state)
Sets the state the endpoint will be loaded in. |
void |
setName(String name)
|
void |
setProperties(Map props)
|
void |
setProperty(String key,
Object value)
Sets a property on the endpoint |
void |
setRemoteSync(boolean value)
For certain providers that support the notion of a backchannel such as sockets (outputStream) or Jms (ReplyTo) Mule can automatically wait for a response from a backchannel when dispatching over these protocols. |
void |
setRemoteSyncTimeout(int timeout)
The timeout value for remoteSync invocations |
void |
setResponseTransformer(UMOTransformer trans)
Sets tyhe transformer used when a response is sent back from the endpoint invocation |
void |
setSecurityFilter(UMOEndpointSecurityFilter filter)
Sets an UMOEndpointSecurityFilter for this endpoint. |
void |
setStreaming(boolean stream)
Determines whether the endpoint should deal with requests as streams |
void |
setSynchronous(boolean synchronous)
Determines if requests originating from this endpoint should be synchronous i.e. |
void |
setTransactionConfig(UMOTransactionConfig config)
Sets the Transaction configuration for the endpoint |
void |
setTransformer(UMOTransformer trans)
The transformer is responsible for transforming data when it is received or sent by the UMO (depending on whether this endpoint is a receiver or not). |
void |
setType(String type)
Determines whether the message endpoint is a sender or receiver or both. |
| Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.mule.umo.endpoint.UMOEndpoint |
getTransactionConfig |
| Methods inherited from interface org.mule.umo.endpoint.UMOImmutableEndpoint |
canReceive, canSend, getConnector, getCreateConnector, getEncoding, getEndpointURI, getFilter, getInitialState, getName, getProperties, getProperty, getProtocol, getRemoteSyncTimeout, getResponseTransformer, getSecurityFilter, getTransformer, getType, isDeleteUnacceptedMessages, isRemoteSync, isStreaming, isSynchronous, isSynchronousSet |
| Methods inherited from interface org.mule.umo.lifecycle.Initialisable |
initialise |
| Field Detail |
public static final String ALWAYS_CREATE_STRING
public static final String NEVER_CREATE_STRING
| Constructor Detail |
public MuleEndpoint()
public MuleEndpoint(String name,
UMOEndpointURI endpointUri,
UMOConnector connector,
UMOTransformer transformer,
String type,
int createConnector,
String endpointEncoding,
Map props)
public MuleEndpoint(UMOImmutableEndpoint endpoint)
public MuleEndpoint(String uri,
boolean receiver)
throws UMOException
| Method Detail |
public Object clone()
UMOImmutableEndpoint
clone in interface UMOImmutableEndpointclone in class ImmutableMuleEndpoint
public void setEndpointURI(UMOEndpointURI endpointUri)
throws EndpointException
UMOEndpoint
setEndpointURI in interface UMOEndpointendpointUri - the endpointUri on which the Endpoint sends or receives
data
EndpointException - thrown if the EndpointUri cannot be processed by the
Endpointpublic void setEncoding(String endpointEncoding)
UMOEndpoint
setEncoding in interface UMOEndpointendpointEncoding - the encoding set on the endpoint. If not set the
encoding will be taken from the manager configpublic void setType(String type)
UMOEndpoint
setType in interface UMOEndpointtype - the endpoint typepublic void setConnector(UMOConnector connector)
UMOEndpoint
setConnector in interface UMOEndpointconnector - the endpoint to associate with the endpointpublic void setName(String name)
setName in interface UMOEndpointname - the name to identify the endpointpublic void setTransformer(UMOTransformer trans)
UMOEndpoint
setTransformer in interface UMOEndpointtrans - the transformer to use when receiving or sending datapublic void setProperties(Map props)
setProperties in interface UMOEndpointprops - properties for this endpointpublic boolean isReadOnly()
isReadOnly in interface UMOImmutableEndpointisReadOnly in class ImmutableMuleEndpointpublic void setTransactionConfig(UMOTransactionConfig config)
UMOEndpoint
setTransactionConfig in interface UMOEndpointconfig - the transaction config to use by this endpointpublic void setFilter(UMOFilter filter)
UMOEndpoint
setFilter in interface UMOEndpointfilter - the filter to usepublic void setDeleteUnacceptedMessages(boolean delete)
setDeleteUnacceptedMessages in interface UMOEndpointdelete - if message should be deleted, false otherwisepublic void setSecurityFilter(UMOEndpointSecurityFilter filter)
setSecurityFilter in interface UMOEndpointfilter - the UMOSecurityFilter responsible for authenticating message
flow via this endpoint.UMOEndpointSecurityFilterpublic void setSynchronous(boolean synchronous)
setSynchronous in interface UMOEndpointsynchronous - whether requests on this endpoint should execute in a
single thread. This property is only used when the endpoint is of
type 'receiver'public void setCreateConnector(int action)
UMOEndpoint
setCreateConnector in interface UMOEndpointaction - public void setCreateConnectorAsString(String action)
public void setRemoteSync(boolean value)
setRemoteSync in interface UMOEndpointvalue - whether the endpoint should perfrom sync receivespublic void setRemoteSyncTimeout(int timeout)
setRemoteSyncTimeout in interface UMOEndpointtimeout - the timeout in millisecondspublic void setInitialState(String state)
setInitialState in interface UMOEndpointstate - public void setResponseTransformer(UMOTransformer trans)
UMOEndpoint
setResponseTransformer in interface UMOEndpointtrans - the transformer to usepublic void setStreaming(boolean stream)
setStreaming in interface UMOEndpointstream - true if the request should be streamed
public void setProperty(String key,
Object value)
setProperty in interface UMOEndpointkey - the property keyvalue - the value of the property
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||