Package org.apache.camel.spi

Interface EndpointServiceLocation

public interface EndpointServiceLocation
Used for getting information about location to (hosted or external) network services. An external service such as message brokers, databases, or cloud services. Hosted services are running inside this Camel application such as with embedded HTTP server for Rest DSL, or TCP networking with netty etc.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    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, connection-string, or cloud region, that are component specific.

  • Method Details

    • getServiceUrl

      String getServiceUrl()
      Gets the remote address such as URL, hostname, connection-string, or cloud region, 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