com.oracle.bmc.ospgateway

Interface SubscriptionServiceAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SubscriptionServiceAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20191001")
public interface SubscriptionServiceAsync
extends AutoCloseable

This site describes all the Rest endpoints of OSP Gateway.

Method Summary

Modifier and Type	Method and Description
Future<AuthorizeSubscriptionPaymentResponse>	authorizeSubscriptionPayment(AuthorizeSubscriptionPaymentRequest request, AsyncHandler<AuthorizeSubscriptionPaymentRequest,AuthorizeSubscriptionPaymentResponse> handler) PSD2 authorization for subscription payment
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetSubscriptionResponse>	getSubscription(GetSubscriptionRequest request, AsyncHandler<GetSubscriptionRequest,GetSubscriptionResponse> handler) Get the subscription plan.
Future<ListSubscriptionsResponse>	listSubscriptions(ListSubscriptionsRequest request, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResponse> handler) Get the subscription data for the compartment
Future<PaySubscriptionResponse>	paySubscription(PaySubscriptionRequest request, AsyncHandler<PaySubscriptionRequest,PaySubscriptionResponse> handler) Pay a subscription
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateSubscriptionResponse>	updateSubscription(UpdateSubscriptionRequest request, AsyncHandler<UpdateSubscriptionRequest,UpdateSubscriptionResponse> handler) Update plan of the subscription.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

authorizeSubscriptionPayment

Future<AuthorizeSubscriptionPaymentResponse> authorizeSubscriptionPayment(AuthorizeSubscriptionPaymentRequest request,
                                                                          AsyncHandler<AuthorizeSubscriptionPaymentRequest,AuthorizeSubscriptionPaymentResponse> handler)

PSD2 authorization for subscription payment

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSubscription

Future<GetSubscriptionResponse> getSubscription(GetSubscriptionRequest request,
                                                AsyncHandler<GetSubscriptionRequest,GetSubscriptionResponse> handler)

Get the subscription plan.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSubscriptions

Future<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest request,
                                                    AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResponse> handler)

Get the subscription data for the compartment

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

paySubscription

Future<PaySubscriptionResponse> paySubscription(PaySubscriptionRequest request,
                                                AsyncHandler<PaySubscriptionRequest,PaySubscriptionResponse> handler)

Pay a subscription

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSubscription

Future<UpdateSubscriptionResponse> updateSubscription(UpdateSubscriptionRequest request,
                                                      AsyncHandler<UpdateSubscriptionRequest,UpdateSubscriptionResponse> handler)

Update plan of the subscription.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.