Package com.devonfw.module.service.common.api.client.context

Interface ServiceContext<S>

Type Parameters:

S - type of the service API.

All Known Subinterfaces:

ServiceDiscoveryContext<S>, ServiceHeaderContext<S>

All Known Implementing Classes:

AbstractServiceContext, ServiceContextImpl

public interface ServiceContext<S>

This interface gives read access to contextual information of a Service.

Since:

3.0.0

Method Summary

Modifier and Type	Method	Description
Class<S>	getApi()
ConfigProperties	getConfig()
String	getHeader(String name)
Collection<String>	getHeaderNames()
default String	getServiceDescription(String operation)
default String	getServiceDescription(String operation, String url)
String	getUrl()

Method Detail

getApi

Class<S> getApi()

Returns:

the Class reflecting the API of the externally provided Service. E.g. a JAR-RS annotated interface. For flexibility and being not invasive the generic type is not bound to Service (S extends Service).

getUrl

String getUrl()

Returns:

the URL (or URI) of the remote service.

getHeaderNames

Collection<String> getHeaderNames()

Returns:

a Collection with the available header names (keys).

getHeader

String getHeader(String name)

Parameters:

name - the name (key) of the header to get.

Returns:

the value of the requested header or null if undefined.

getConfig

ConfigProperties getConfig()

Returns:

the ConfigProperties with configuration metadata.

See Also:

ServiceClientFactory.create(Class, java.util.Map)

getServiceDescription

default String getServiceDescription(String operation)

Parameters:

operation - the invoked service operation (Java method called on API or URL path detail called via REST).

Returns:

a String describing the invoked Service with available details as provided.

getServiceDescription

default String getServiceDescription(String operation,
                                     String url)

Parameters:

operation - the invoked service operation (Java method called on API or URL path detail called via REST).

url - the URL of the invoked service.

Returns:

a String describing the invoked Service with available details as provided.