|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UMOEndpoint
UMOEndpoint
describes a Provider in the Mule Server. An endpoint is
a grouping of an endpoint, an endpointUri and a transformer.
Field Summary |
---|
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 |
Fields inherited from interface org.mule.umo.provider.UMOMessageDispatching |
---|
RECEIVE_NO_WAIT, RECEIVE_WAIT_INDEFINITELY |
Method Summary | |
---|---|
UMOTransactionConfig |
getTransactionConfig()
Returns the transaction configuration for this endpoint |
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 |
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 interface org.mule.umo.endpoint.UMOImmutableEndpoint |
---|
canReceive, canSend, clone, getConnector, getCreateConnector, getEncoding, getEndpointURI, getFilter, getInitialState, getName, getProperties, getProperty, getProtocol, getRemoteSyncTimeout, getResponseTransformer, getSecurityFilter, getTransformer, getType, isDeleteUnacceptedMessages, isReadOnly, isRemoteSync, isStreaming, isSynchronous, isSynchronousSet |
Methods inherited from interface org.mule.umo.lifecycle.Initialisable |
---|
initialise |
Methods inherited from interface org.mule.umo.provider.UMOMessageDispatching |
---|
dispatch, receive, send |
Method Detail |
---|
void setEndpointURI(UMOEndpointURI endpointUri) throws EndpointException
endpointUri
- the endpointUri on which the Endpoint sends or receives
data
EndpointException
- thrown if the EndpointUri cannot be processed by the
Endpointvoid setEncoding(String endpointEncoding)
endpointEncoding
- the encoding set on the endpoint. If not set the
encoding will be taken from the manager configvoid setType(String type)
type
- the endpoint typevoid setConnector(UMOConnector connector)
connector
- the endpoint to associate with the endpointvoid setName(String name)
name
- the name to identify the endpointvoid setTransformer(UMOTransformer trans)
trans
- the transformer to use when receiving or sending datavoid setResponseTransformer(UMOTransformer trans)
trans
- the transformer to usevoid setProperties(Map props)
props
- properties for this endpointUMOTransactionConfig getTransactionConfig()
getTransactionConfig
in interface UMOImmutableEndpoint
void setTransactionConfig(UMOTransactionConfig config)
config
- the transaction config to use by this endpointvoid setFilter(UMOFilter filter)
filter
- the filter to usevoid setDeleteUnacceptedMessages(boolean delete)
delete
- if message should be deleted, false otherwisevoid setSecurityFilter(UMOEndpointSecurityFilter filter)
filter
- the UMOSecurityFilter responsible for authenticating message
flow via this endpoint.UMOEndpointSecurityFilter
void setSynchronous(boolean synchronous)
synchronous
- whether requests on this endpoint should execute in a
single thread. This property is only used when the endpoint is of
type 'receiver'void setProperty(String key, Object value)
key
- the property keyvalue
- the value of the propertyvoid setCreateConnector(int action)
action
- void setRemoteSync(boolean value)
value
- whether the endpoint should perfrom sync receivesvoid setRemoteSyncTimeout(int timeout)
timeout
- the timeout in millisecondsvoid setInitialState(String state)
state
- void setStreaming(boolean stream)
stream
- true if the request should be streamed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |