http-rpc-client

alltypes

interface AuthenticationConfig

abstract fun createScheme(): AuthenticationScheme
abstract fun getCredentialsProvider(): CredentialsProvider

interface AuthenticationScheme

abstract fun authenticate(credentials: Any, request: HttpRequest<*>, context: RequestContext): Unit

data class BasicAuthCredentials : CredentialsProvider

BasicAuthCredentials(username: String, password: String)
fun getCredentials(): Any
val password: String
val username: String

class BasicAuthenticationScheme : AuthenticationScheme

BasicAuthenticationScheme()
fun authenticate(credentials: Any, request: HttpRequest<*>, context: RequestContext): Unit

data class BearerTokenCredentials

BearerTokenCredentials(token: String)
val token: String

data class BearerTokenCredentialsProvider : CredentialsProvider

BearerTokenCredentialsProvider(tokenProvider: BearerTokenProvider)
fun getCredentials(): Any
val tokenProvider: BearerTokenProvider

interface BearerTokenProvider

@NotNull abstract fun getToken(): String

interface CredentialsProvider

abstract fun getCredentials(): Any

class DurableCursorTransferObject<T> : FiniteDurableCursorBuilder<T>, Supplier<PollResult<T>>

DurableCursorTransferObject(pollResult: PollResult<T>)
fun build(): FiniteDurableCursor<T>
fun get(): PollResult<T>
data class PollResultImpl<T> : PollResult<T>

PollResultImpl(positionedValues: List<PositionedValue<T>>, remainingElementsCountEstimate: Long?, isLastResult: Boolean)
val isLastResult: Boolean
val positionedValues: List<PositionedValue<T>>
val remainingElementsCountEstimate: Long?

data class PositionedValueImpl<T> : PositionedValue<T>

PositionedValueImpl(value: T, position: Long)
val position: Long
val value: T

var positionManager: PositionManager

data class DurableStreamContext

DurableStreamContext(currentPosition: Long, maxCount: Int, awaitForResultTimeout: Duration)
val awaitForResultTimeout: Duration
val currentPosition: Long
val maxCount: Int

class HttpRpcClient<I : RPCOps> : AutoCloseable

HttpRpcClient(baseAddress: String, rpcOpsClass: Class<I>, clientConfig: HttpRpcClientConfig)
HttpRpcClient(baseAddress: String, rpcOpsClass: Class<I>, clientConfig: HttpRpcClientConfig, healthCheckInterval: Long)
fun addConnectionListener(listener: HttpRpcConnectionListener<I>): Boolean
fun close(): Unit
fun removeConnectionListener(listener: HttpRpcConnectionListener<I>): Boolean
fun start(): HttpRpcConnection<I>

data class HttpRpcClientConfig

HttpRpcClientConfig()
val authenticationConfig: AuthenticationConfig
fun bearerToken(tokenProvider: BearerTokenProvider): HttpRpcClientConfig
fun enableSSL(enableSSL: Boolean): HttpRpcClientConfig
val enableSSL: Boolean
fun minimumServerProtocolVersion(minimumServerProtocolVersion: Int): HttpRpcClientConfig
val minimumServerProtocolVersion: Int
fun password(password: String): HttpRpcClientConfig
fun username(username: String): HttpRpcClientConfig

data class HttpRpcClientDurableStreamContext

HttpRpcClientDurableStreamContext(currentPosition: Long, maxCount: Int, awaitForResultTimeout: Duration)
val awaitForResultTimeout: Duration
val currentPosition: Long
val maxCount: Int

@DoNotImplement interface HttpRpcConnection<out I : RPCOps>

abstract val proxy: I
abstract val serverProtocolVersion: Int

interface HttpRpcConnectionListener<I : RPCOps>

interface HttpRpcConnectionContext<I : RPCOps>

abstract val connectionOpt: HttpRpcConnection<I>?
abstract val credentialsProvider: CredentialsProvider
abstract val throwableOpt: Throwable?

abstract fun onConnect(context: HttpRpcConnectionContext<I>): Unit
abstract fun onDisconnect(context: HttpRpcConnectionContext<I>): Unit
abstract fun onPermanentFailure(context: HttpRpcConnectionContext<I>): Unit

class HttpRpcConnectionListenerDistributor<I : RPCOps>

HttpRpcConnectionListenerDistributor(listeners: Iterable<HttpRpcConnectionListener<I>>, credentialsProvider: CredentialsProvider)

enum class HttpVerb

GET
POST

class InMemoryPositionManager : PositionManager

InMemoryPositionManager()
fun accept(inLong: Long): Unit
fun get(): Long

class InternalErrorException : CordaRuntimeException

InternalErrorException(message: String)

kotlin.String

fun String.replacePathParameters(pathParams: Map<String, String>): String

class MissingRequestedResourceException : CordaRuntimeException

MissingRequestedResourceException(message: String)

class PermissionException : CordaRuntimeException

PermissionException(message: String)

interface RemoteClient

abstract val baseAddress: String
abstract fun <T> call(verb: HttpVerb, webRequest: WebRequest<T>, responseType: Type, context: RequestContext): WebResponse<Any>
abstract fun <T> call(verb: HttpVerb, webRequest: WebRequest<T>, context: RequestContext): WebResponse<String>

class RemoteUnirestClient : RemoteClient

RemoteUnirestClient(baseAddress: String, enableSsl: Boolean = false)
val baseAddress: String
fun <T> call(verb: HttpVerb, webRequest: WebRequest<T>, responseType: Type, context: RequestContext): WebResponse<Any>
fun <T> call(verb: HttpVerb, webRequest: WebRequest<T>, context: RequestContext): WebResponse<String>

class RequestContext

val authenticationScheme: AuthenticationScheme
val credentials: Any

class RequestErrorException : CordaRuntimeException

RequestErrorException(message: String)

data class ResolvedParameters

ResolvedParameters(body: String?, pathParams: Map<String, String>, queryParams: Map<String, Any?>)
val body: String?
val pathParams: Map<String, String>
val queryParams: Map<String, Any?>

data class WebRequest<T>

WebRequest(path: String, body: T? = null, queryParameters: Map<String, Any?>? = null)
val body: T?
val path: String
val queryParameters: Map<String, Any?>?

data class WebResponse<T>

WebResponse(body: T?, headers: Map<String, String>, responseStatus: Int, responseStatusText: String?)
val body: T?
val headers: Map<String, String>
val responseStatus: Int
val responseStatusText: String?

package net.corda.v5.httprpc.client

class HttpRpcClient<I : RPCOps> : AutoCloseable

HttpRpcClient(baseAddress: String, rpcOpsClass: Class<I>, clientConfig: HttpRpcClientConfig)
HttpRpcClient(baseAddress: String, rpcOpsClass: Class<I>, clientConfig: HttpRpcClientConfig, healthCheckInterval: Long)
fun addConnectionListener(listener: HttpRpcConnectionListener<I>): Boolean
fun close(): Unit
fun removeConnectionListener(listener: HttpRpcConnectionListener<I>): Boolean
fun start(): HttpRpcConnection<I>

@DoNotImplement interface HttpRpcConnection<out I : RPCOps>

abstract val proxy: I
abstract val serverProtocolVersion: Int

interface HttpRpcConnectionListener<I : RPCOps>

interface HttpRpcConnectionContext<I : RPCOps>

abstract val connectionOpt: HttpRpcConnection<I>?
abstract val credentialsProvider: CredentialsProvider
abstract val throwableOpt: Throwable?

abstract fun onConnect(context: HttpRpcConnectionContext<I>): Unit
abstract fun onDisconnect(context: HttpRpcConnectionContext<I>): Unit
abstract fun onPermanentFailure(context: HttpRpcConnectionContext<I>): Unit

package net.corda.v5.httprpc.client.auth

class RequestContext

val authenticationScheme: AuthenticationScheme
val credentials: Any

package net.corda.v5.httprpc.client.auth.credentials

data class BasicAuthCredentials : CredentialsProvider

BasicAuthCredentials(username: String, password: String)
fun getCredentials(): Any
val password: String
val username: String

data class BearerTokenCredentials

BearerTokenCredentials(token: String)
val token: String

data class BearerTokenCredentialsProvider : CredentialsProvider

BearerTokenCredentialsProvider(tokenProvider: BearerTokenProvider)
fun getCredentials(): Any
val tokenProvider: BearerTokenProvider

interface BearerTokenProvider

@NotNull abstract fun getToken(): String

interface CredentialsProvider

abstract fun getCredentials(): Any

package net.corda.v5.httprpc.client.auth.scheme

interface AuthenticationScheme

abstract fun authenticate(credentials: Any, request: HttpRequest<*>, context: RequestContext): Unit

class BasicAuthenticationScheme : AuthenticationScheme

BasicAuthenticationScheme()
fun authenticate(credentials: Any, request: HttpRequest<*>, context: RequestContext): Unit

package net.corda.v5.httprpc.client.config

interface AuthenticationConfig

abstract fun createScheme(): AuthenticationScheme
abstract fun getCredentialsProvider(): CredentialsProvider

data class HttpRpcClientConfig

HttpRpcClientConfig()
val authenticationConfig: AuthenticationConfig
fun bearerToken(tokenProvider: BearerTokenProvider): HttpRpcClientConfig
fun enableSSL(enableSSL: Boolean): HttpRpcClientConfig
val enableSSL: Boolean
fun minimumServerProtocolVersion(minimumServerProtocolVersion: Int): HttpRpcClientConfig
val minimumServerProtocolVersion: Int
fun password(password: String): HttpRpcClientConfig
fun username(username: String): HttpRpcClientConfig

package net.corda.v5.httprpc.client.exceptions

class InternalErrorException : CordaRuntimeException

InternalErrorException(message: String)

class MissingRequestedResourceException : CordaRuntimeException

MissingRequestedResourceException(message: String)

class PermissionException : CordaRuntimeException

PermissionException(message: String)

class RequestErrorException : CordaRuntimeException

RequestErrorException(message: String)

package net.corda.v5.httprpc.client.internal

class HttpRpcConnectionListenerDistributor<I : RPCOps>

HttpRpcConnectionListenerDistributor(listeners: Iterable<HttpRpcConnectionListener<I>>, credentialsProvider: CredentialsProvider)

package net.corda.v5.httprpc.client.internal.processing

kotlin.String

fun String.replacePathParameters(pathParams: Map<String, String>): String

data class ResolvedParameters

ResolvedParameters(body: String?, pathParams: Map<String, String>, queryParams: Map<String, Any?>)
val body: String?
val pathParams: Map<String, String>
val queryParams: Map<String, Any?>

package net.corda.v5.httprpc.client.internal.remote

enum class HttpVerb

GET
POST

interface RemoteClient

abstract val baseAddress: String
abstract fun <T> call(verb: HttpVerb, webRequest: WebRequest<T>, responseType: Type, context: RequestContext): WebResponse<Any>
abstract fun <T> call(verb: HttpVerb, webRequest: WebRequest<T>, context: RequestContext): WebResponse<String>

class RemoteUnirestClient : RemoteClient

RemoteUnirestClient(baseAddress: String, enableSsl: Boolean = false)
val baseAddress: String
fun <T> call(verb: HttpVerb, webRequest: WebRequest<T>, responseType: Type, context: RequestContext): WebResponse<Any>
fun <T> call(verb: HttpVerb, webRequest: WebRequest<T>, context: RequestContext): WebResponse<String>

data class WebRequest<T>

WebRequest(path: String, body: T? = null, queryParameters: Map<String, Any?>? = null)
val body: T?
val path: String
val queryParameters: Map<String, Any?>?

data class WebResponse<T>

WebResponse(body: T?, headers: Map<String, String>, responseStatus: Int, responseStatusText: String?)
val body: T?
val headers: Map<String, String>
val responseStatus: Int
val responseStatusText: String?

package net.corda.v5.httprpc.client.internal.stream

class DurableCursorTransferObject<T> : FiniteDurableCursorBuilder<T>, Supplier<PollResult<T>>

DurableCursorTransferObject(pollResult: PollResult<T>)
fun build(): FiniteDurableCursor<T>
fun get(): PollResult<T>
data class PollResultImpl<T> : PollResult<T>

PollResultImpl(positionedValues: List<PositionedValue<T>>, remainingElementsCountEstimate: Long?, isLastResult: Boolean)
val isLastResult: Boolean
val positionedValues: List<PositionedValue<T>>
val remainingElementsCountEstimate: Long?

data class PositionedValueImpl<T> : PositionedValue<T>

PositionedValueImpl(value: T, position: Long)
val position: Long
val value: T

var positionManager: PositionManager

data class DurableStreamContext

DurableStreamContext(currentPosition: Long, maxCount: Int, awaitForResultTimeout: Duration)
val awaitForResultTimeout: Duration
val currentPosition: Long
val maxCount: Int

data class HttpRpcClientDurableStreamContext

HttpRpcClientDurableStreamContext(currentPosition: Long, maxCount: Int, awaitForResultTimeout: Duration)
val awaitForResultTimeout: Duration
val currentPosition: Long
val maxCount: Int

class InMemoryPositionManager : PositionManager

InMemoryPositionManager()
fun accept(inLong: Long): Unit
fun get(): Long