public interface Endpoint extends ManagedLifecycle, SynapseArtifact, Nameable
Modifier and Type | Method and Description |
---|---|
String |
getArtifactContainerName()
Get the Car File Name which this endpoint deployed from
|
List<Endpoint> |
getChildren()
Get the children of this endpoint
|
EndpointContext |
getContext()
Get the EndpointContext that has the run-time state of this endpoint
|
String |
getErrorHandler()
Get the MessageStore name associated with the Endpoint
|
String |
getFileName()
Get the filename from which this endpoint is loaded,
null if it is an anonymous endpoint |
boolean |
getIsEdited()
Get the edit state of the endpoint
|
org.json.JSONObject |
getJsonRepresentation()
Get the json representation of the endpoint.
|
EndpointView |
getMetricsMBean()
Get a reference to the metrics MBean for this endpoint
|
boolean |
isInitialized()
Has this Endpoint initialized?
|
void |
onChildEndpointFail(Endpoint endpoint,
MessageContext synMessageContext)
Endpoints that contain other endpoints should implement this method.
|
void |
onSuccess()
An event notification whenever endpoint invocation is successful
Can be used to clear a timeout status etc
|
boolean |
readyToSend()
Returns true to indicate that the endpoint is ready to service requests
|
void |
send(MessageContext synMessageContext)
Sends the message context according to an endpoint specific behavior.
|
void |
setArtifactContainerName(String name)
Set the name of the car file which this endpoint deployed from
|
void |
setComponentStatisticsId(ArtifactHolder holder) |
void |
setErrorHandler(String onFaultMessageStore)
Set the Message Store name associated with the Endpoint
|
void |
setFileName(String fileName)
Set the filename from which the endpoint is loaded
|
void |
setIsEdited(boolean isEdited)
Set the edit state of the endpoint
|
void |
setParentEndpoint(Endpoint parentEndpoint)
Sets the parent endpoint for the current endpoint.
|
destroy, init
getDescription, setDescription
void send(MessageContext synMessageContext)
synMessageContext
- MessageContext to be sent.void onChildEndpointFail(Endpoint endpoint, MessageContext synMessageContext)
endpoint
- The child endpoint which caused the exception.synMessageContext
- MessageContext that was used in the failed attempt.void setParentEndpoint(Endpoint parentEndpoint)
parentEndpoint
- parent endpoint containing this endpoint. It should handle the onChildEndpointFail(...)
callback.void onSuccess()
boolean readyToSend()
boolean isInitialized()
EndpointContext getContext()
List<Endpoint> getChildren()
EndpointView getMetricsMBean()
String getFileName()
null
if it is an anonymous endpointvoid setFileName(String fileName)
fileName
- from which the endpoint is loadedString getErrorHandler()
void setErrorHandler(String onFaultMessageStore)
onFaultMessageStore,
- name of the message storevoid setArtifactContainerName(String name)
String getArtifactContainerName()
boolean getIsEdited()
void setIsEdited(boolean isEdited)
isEdited
- void setComponentStatisticsId(ArtifactHolder holder)
org.json.JSONObject getJsonRepresentation()
Copyright © 2005–2019 Apache Software Foundation. All rights reserved.