Class OpenServiceBrokerClient

Namespace

OpenServiceBroker

Assembly

OpenServiceBroker.Client.dll

A type-safe client for the Open Service Broker API.

public class OpenServiceBrokerClient : EntryEndpoint, IEndpoint, IOpenServiceBrokerClient

Inheritance

object

EndpointBase

EntryEndpoint

OpenServiceBrokerClient

Implements

IEndpoint

IOpenServiceBrokerClient

Inherited Members

EntryEndpoint.ReadMetaAsync(CancellationToken)

EndpointBase.HandleAsync(Func<Task<HttpResponseMessage>>, string)

EndpointBase.FinalizeAsync(Func<Task<HttpResponseMessage>>, string)

EndpointBase.StartActivity(string)

EndpointBase.SetDefaultLink(string, string)

EndpointBase.SetDefaultLinkTemplate(string, string)

EndpointBase.GetLinks(string)

EndpointBase.Link(string)

EndpointBase.GetLinkTemplate(string)

EndpointBase.LinkTemplate(string, IDictionary<string, object>)

EndpointBase.LinkTemplate(string, object)

EndpointBase.HandleCapabilities(HttpResponseMessage)

EndpointBase.IsMethodAllowed(HttpMethod)

EndpointBase.ToString()

EndpointBase.GetConstructor<TEndpoint>()

EndpointBase.Uri

EndpointBase.HttpClient

EndpointBase.Serializers

EndpointBase.Serializer

EndpointBase.ErrorHandler

EndpointBase.LinkExtractor

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

CompletableWithResult.Complete<TCompletable, TResult>(TCompletable, TResult?)

Constructors

OpenServiceBrokerClient(HttpClient, Uri)

Creates a new Open Service Broker Client using a custom HttpClient. This is usually used for custom authentication schemes, e.g. client certificates.

public OpenServiceBrokerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

The HttpClient to use for communication with My Service.

uri Uri

The base URI of the Open Service Broker API instance (without the version number).

OpenServiceBrokerClient(Uri, NetworkCredential?)

Creates a new Open Service Broker Client.

public OpenServiceBrokerClient(Uri uri, NetworkCredential? credentials = null)

Parameters

uri Uri

The base URI of the Open Service Broker API instance (without the version number).

credentials NetworkCredential

Optional HTTP Basic Auth credentials used to authenticate against the REST interface.

OpenServiceBrokerClient(Uri, string)

Creates a new Open Service Broker Client.

public OpenServiceBrokerClient(Uri uri, string token)

Parameters

uri Uri

The base URI of the Open Service Broker API instance (without the version number).

token string

The OAuth token to present as a "Bearer" to the REST interface.

Properties

Catalog

Exposes a list of all services available on the Service Broker.

public IElementEndpoint<Catalog> Catalog { get; }

Property Value

IElementEndpoint<Catalog>

DefaultApiVersion

The default Open Service Broker API version to set for requests.

public static ApiVersion DefaultApiVersion { get; }

Property Value

ApiVersion

ServiceInstancesBlocking

Exposes Service Instances with blocking operations. If the Service Broker can only handle a request deferred (asynchronously) AsyncRequiredException is thrown.

public IIndexerEndpoint<IServiceInstanceEndpoint> ServiceInstancesBlocking { get; }

Property Value

IIndexerEndpoint<IServiceInstanceEndpoint>

ServiceInstancesDeferred

Exposes Service Instances with potentially deferred (asynchronous) operations.

public IIndexerEndpoint<IServiceInstanceDeferredEndpoint> ServiceInstancesDeferred { get; }

Property Value

IIndexerEndpoint<IServiceInstanceDeferredEndpoint>

ServiceInstancesPolling

Exposes Service Instances. Uses potentially deferred (asynchronous) operations and automatically handles polling to make them appear blocking.

public IIndexerEndpoint<IServiceInstanceEndpoint> ServiceInstancesPolling { get; }

Property Value

IIndexerEndpoint<IServiceInstanceEndpoint>

Methods

SetApiVersion(ApiVersion)

Sets the Open Service Broker API version to a custom value. Only use this if you know what you are doing!

public void SetApiVersion(ApiVersion version)

Parameters

version ApiVersion

SetOriginatingIdentity(OriginatingIdentity)

Sets the identity of the user that initiated the request from the Platform.

public void SetOriginatingIdentity(OriginatingIdentity identity)

Parameters

identity OriginatingIdentity