Package org.apache.camel.spi

Interface EndpointServiceRegistry.EndpointService

Enclosing interface:
EndpointServiceRegistry
public static interface EndpointServiceRegistry.EndpointService
Details about the endpoint service

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getComponent()
    The Camel component for this endpoint service (such as jms, kafka, aws-s3).
    String
    getDirection()
    Direction of the service.
    String
    getEndpointUri()
    The endpoint uri of this endpoint service.
    long
    getHits()
    Usage of the endpoint service, such as how many messages it has received / sent to
    String
    getRouteId()
    The route id where this service is used as route consumer, or used in the route by a send processor.
    default Map<String,String>
    getServiceMetadata()
    Optional metadata that is relevant to the service as key value pairs.
    String
    getServiceProtocol()
    Get the protocol the service is using such as http, amqp, tcp.
    String
    getServiceUrl()
    Gets the remote address such as URL, hostname, or connection-string that are component specific
    boolean
    isHostedService()
    Is this service hosted (in this Camel application).

  • Method Details

    • getComponent

      String getComponent()
      The Camel component for this endpoint service (such as jms, kafka, aws-s3).

    • getEndpointUri

      String getEndpointUri()
      The endpoint uri of this endpoint service.

    • getServiceUrl

      String getServiceUrl()
      Gets the remote address such as URL, hostname, or connection-string that are component specific
      Returns:
      the address or null if no address can be determined.

    • getServiceProtocol

      String getServiceProtocol()
      Get the protocol the service is using such as http, amqp, tcp.

    • getServiceMetadata

      default Map<String,String> getServiceMetadata()
      Optional metadata that is relevant to the service as key value pairs. Notice that the metadata is not supposed to contain sensitive security details such as access token, api keys, or passwords. Only share information that can be safely accessed and written to logs.
      Returns:
      optional metadata or null if no data

    • isHostedService

      boolean isHostedService()
      Is this service hosted (in this Camel application). For example an embedded HTTP server.

    • getDirection

      String getDirection()
      Direction of the service. IN = Camel (consumer) receives events from the external system. OUT = Camel (producer) sending messages to the external system.

    • getHits

      long getHits()
      Usage of the endpoint service, such as how many messages it has received / sent to

      This information is only available if ManagementStatisticsLevel is configured as ManagementStatisticsLevel.Extended.

    • getRouteId

      String getRouteId()
      The route id where this service is used as route consumer, or used in the route by a send processor.