public-api/tools.samt.api.transports.http/SamtHttpTransport

SamtHttpTransport

interface SamtHttpTransport : TransportConfiguration

A transport configuration for HTTP-based services.

Properties

Link copied to clipboard
abstract val name: String

The name of this transport protocol. Can be used to display to a user.

Link copied to clipboard

Functions

Link copied to clipboard
abstract fun getFullPath(serviceName: String, operationName: String): String

Get the full path for the given service and operation, essentially joining getServicePath and getPath with a slash.

Link copied to clipboard
abstract fun getMethod(serviceName: String, operationName: String): HttpMethod

Get the HTTP method for the given service and operation.

Link copied to clipboard
abstract fun getPath(serviceName: String, operationName: String): String

Get the path for the given service and operation. The path might contain URL parameters, which are surrounded by curly braces (e.g. /person/{personId}).

Link copied to clipboard
abstract fun getServicePath(serviceName: String): String

Get the base path for the given service.

Link copied to clipboard
abstract fun getTransportMode(serviceName: String, operationName: String, parameterName: String): TransportMode

Get the transport mode for the given parameter. Defaults to TransportMode.Body for POST operations and TransportMode.QueryParameter for GET operations.