OpenServiceBroker for .NET 0.4.3
client and a server .NET library for the Open Service Broker API specification
OpenServiceBroker.OpenServiceBrokerClient Class Reference

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

Inheritance diagram for OpenServiceBroker.OpenServiceBrokerClient:
TypedRest::Endpoints::EntryEndpoint OpenServiceBroker.IOpenServiceBrokerClient TypedRest::Endpoints::EndpointBase TypedRest::Endpoints::IEndpoint

Public Member Functions

 OpenServiceBrokerClient (HttpClient httpClient, Uri uri)
 Creates a new Open Service Broker Client using a custom HttpClient. This is usually used for custom authentication schemes, e.g. client certificates. More...
 
 OpenServiceBrokerClient (Uri uri, NetworkCredential? credentials=null)
 Creates a new Open Service Broker Client. More...
 
 OpenServiceBrokerClient (Uri uri, string token)
 Creates a new Open Service Broker Client. More...
 
void SetApiVersion (ApiVersion version)
 Sets the Open Service Broker API version to a custom value. Only use this if you know what you are doing!
 
void SetOriginatingIdentity (OriginatingIdentity identity)
 Sets the identity of the user that initiated the request from the Platform.
 
- Public Member Functions inherited from TypedRest::Endpoints::EntryEndpoint
 EntryEndpoint (HttpClient httpClient, Uri? uri=null, MediaTypeFormatter? serializer=null, IErrorHandler? errorHandler=null, ILinkExtractor? linkExtractor=null)
 
 EntryEndpoint (Uri uri, NetworkCredential? credentials=null, MediaTypeFormatter? serializer=null, IErrorHandler? errorHandler=null, ILinkExtractor? linkExtractor=null)
 
async Task ReadMetaAsync (CancellationToken cancellationToken=default)
 
- Public Member Functions inherited from TypedRest::Endpoints::EndpointBase
void SetDefaultLink (string rel, string? href)
 
void SetDefaultLinkTemplate (string rel, string? href)
 
IReadOnlyList<(Uri uri, string? title)> GetLinks (string rel)
 
Uri Link (string rel)
 
UriTemplate GetLinkTemplate (string rel)
 
Uri LinkTemplate (string rel, IDictionary< string, object > variables)
 
Uri LinkTemplate (string rel, object variables)
 

Properties

static ApiVersion DefaultApiVersion [get]
 The default Open Service Broker API version to set for requests.
 
IElementEndpoint< CatalogCatalog [get]
 Exposes a list of all services available on the Service Broker.
 
IIndexerEndpoint< IServiceInstanceEndpointServiceInstancesBlocking [get]
 Exposes Service Instances with blocking operations. If the Service Broker can only handle a request deferred (asynchronously) Errors.AsyncRequiredException is thrown.
 
IIndexerEndpoint< IServiceInstanceDeferredEndpointServiceInstancesDeferred [get]
 Exposes Service Instances with potentially deferred (asynchronous) operations.
 
IIndexerEndpoint< IServiceInstanceEndpointServiceInstancesPolling [get]
 Exposes Service Instances. Uses potentially deferred (asynchronous) operations and automatically handles polling to make them appear blocking.
 
- Properties inherited from TypedRest::Endpoints::IEndpoint
Uri Uri
 
HttpClient HttpClient
 
MediaTypeFormatter Serializer
 
IErrorHandler ErrorHandler
 
ILinkExtractor LinkExtractor
 
- Properties inherited from OpenServiceBroker.IOpenServiceBrokerClient
IElementEndpoint< CatalogCatalog [get]
 Exposes a list of all services available on the Service Broker.
 
IIndexerEndpoint< IServiceInstanceEndpointServiceInstancesBlocking [get]
 Exposes Service Instances with blocking operations. If the Service Broker can only handle a request deferred (asynchronously) Errors.AsyncRequiredException is thrown.
 
IIndexerEndpoint< IServiceInstanceDeferredEndpointServiceInstancesDeferred [get]
 Exposes Service Instances with potentially deferred (asynchronous) operations.
 
IIndexerEndpoint< IServiceInstanceEndpointServiceInstancesPolling [get]
 Exposes Service Instances. Uses potentially deferred (asynchronous) operations and automatically handles polling to make them appear blocking.
 

Additional Inherited Members

- Protected Member Functions inherited from TypedRest::Endpoints::EndpointBase
 EndpointBase (Uri uri, HttpClient httpClient, MediaTypeFormatter serializer, IErrorHandler errorHandler, ILinkExtractor linkExtractor)
 
 EndpointBase (IEndpoint referrer, Uri relativeUri)
 
 EndpointBase (IEndpoint referrer, string relativeUri)
 
virtual async Task< HttpResponseMessage > HandleAsync (Func< Task< HttpResponseMessage > > request,[CallerMemberName] string caller="unknown")
 
Activity? StartActivity ([CallerMemberName] string caller="unknown")
 
virtual void HandleCapabilities (HttpResponseMessage response)
 
bool? IsMethodAllowed (HttpMethod method)
 
- Static Protected Member Functions inherited from TypedRest::Endpoints::EndpointBase
static Func< IEndpoint, Uri, TEndpoint > GetConstructor ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ OpenServiceBrokerClient() [1/3]

OpenServiceBroker.OpenServiceBrokerClient.OpenServiceBrokerClient ( HttpClient  httpClient,
Uri  uri 
)
inline

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

Parameters
uriThe base URI of the Open Service Broker API instance (without the version number).
httpClientThe HttpClient to use for communication with My Service.

◆ OpenServiceBrokerClient() [2/3]

OpenServiceBroker.OpenServiceBrokerClient.OpenServiceBrokerClient ( Uri  uri,
NetworkCredential?  credentials = null 
)
inline

Creates a new Open Service Broker Client.

Parameters
uriThe base URI of the Open Service Broker API instance (without the version number).
credentialsOptional HTTP Basic Auth credentials used to authenticate against the REST interface.

◆ OpenServiceBrokerClient() [3/3]

OpenServiceBroker.OpenServiceBrokerClient.OpenServiceBrokerClient ( Uri  uri,
string  token 
)
inline

Creates a new Open Service Broker Client.

Parameters
uriThe base URI of the Open Service Broker API instance (without the version number).
tokenThe OAuth token to present as a "Bearer" to the REST interface.

The documentation for this class was generated from the following file: