Package com.oracle.bmc.osmanagementhub

Class ManagementStationAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.osmanagementhub.ManagementStationAsyncClient

All Implemented Interfaces:

ManagementStationAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class ManagementStationAsyncClient
extends BaseAsyncClient
implements ManagementStationAsync

Async client implementation for ManagementStation service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagementStationAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for ManagementStation.

Constructor Summary

Constructors

Constructor	Description
ManagementStationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
ManagementStationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
ManagementStationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ManagementStationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ManagementStationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
ManagementStationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
ManagementStationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static ManagementStationAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeManagementStationCompartmentResponse>	changeManagementStationCompartment(ChangeManagementStationCompartmentRequest request, AsyncHandler<ChangeManagementStationCompartmentRequest,ChangeManagementStationCompartmentResponse> handler)	Moves a managment station to a different compartment.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateManagementStationResponse>	createManagementStation(CreateManagementStationRequest request, AsyncHandler<CreateManagementStationRequest,CreateManagementStationResponse> handler)	Creates a management station using the proxy and mirror configuration information provided.
Future<DeleteManagementStationResponse>	deleteManagementStation(DeleteManagementStationRequest request, AsyncHandler<DeleteManagementStationRequest,DeleteManagementStationResponse> handler)	Deletes a management station.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetManagementStationResponse>	getManagementStation(GetManagementStationRequest request, AsyncHandler<GetManagementStationRequest,GetManagementStationResponse> handler)	Returns information about the specified management station.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<ListManagementStationsResponse>	listManagementStations(ListManagementStationsRequest request, AsyncHandler<ListManagementStationsRequest,ListManagementStationsResponse> handler)	Lists management stations within the specified compartment.
Future<ListMirrorsResponse>	listMirrors(ListMirrorsRequest request, AsyncHandler<ListMirrorsRequest,ListMirrorsResponse> handler)	Lists all software source mirrors associated with a specified management station.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
Future<RefreshManagementStationConfigResponse>	refreshManagementStationConfig(RefreshManagementStationConfigRequest request, AsyncHandler<RefreshManagementStationConfigRequest,RefreshManagementStationConfigResponse> handler)	Refreshes the list of software sources mirrored by the management station.
void	setEndpoint(String endpoint)
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<SynchronizeMirrorsResponse>	synchronizeMirrors(SynchronizeMirrorsRequest request, AsyncHandler<SynchronizeMirrorsRequest,SynchronizeMirrorsResponse> handler)	Synchronize the specified software sources mirrored on the management station.
Future<SynchronizeSingleMirrorsResponse>	synchronizeSingleMirrors(SynchronizeSingleMirrorsRequest request, AsyncHandler<SynchronizeSingleMirrorsRequest,SynchronizeSingleMirrorsResponse> handler)	Synchronize the specified software source mirrors on the management station.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateManagementStationResponse>	updateManagementStation(UpdateManagementStationRequest request, AsyncHandler<UpdateManagementStationRequest,UpdateManagementStationResponse> handler)	Updates the configuration of the specified management station.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.osmanagementhub.ManagementStationAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ManagementStation.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ManagementStationAsyncClient

@Deprecated
public ManagementStationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagementStationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ManagementStationAsyncClient

@Deprecated
public ManagementStationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagementStationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ManagementStationAsyncClient

@Deprecated
public ManagementStationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagementStationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ManagementStationAsyncClient

@Deprecated
public ManagementStationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagementStationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagementStationAsyncClient

@Deprecated
public ManagementStationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagementStationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagementStationAsyncClient

@Deprecated
public ManagementStationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagementStationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ManagementStationAsyncClient

@Deprecated
public ManagementStationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagementStationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static ManagementStationAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ManagementStationAsync

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.

Specified by:

setRegion in interface ManagementStationAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ManagementStationAsync

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.

Specified by:

setRegion in interface ManagementStationAsync

Parameters:

regionId - The public region ID.

changeManagementStationCompartment

public Future<ChangeManagementStationCompartmentResponse> changeManagementStationCompartment(ChangeManagementStationCompartmentRequest request,
                                                                                             AsyncHandler<ChangeManagementStationCompartmentRequest,ChangeManagementStationCompartmentResponse> handler)

Description copied from interface: ManagementStationAsync

Moves a managment station to a different compartment.

Specified by:

changeManagementStationCompartment in interface ManagementStationAsync

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.

createManagementStation

public Future<CreateManagementStationResponse> createManagementStation(CreateManagementStationRequest request,
                                                                       AsyncHandler<CreateManagementStationRequest,CreateManagementStationResponse> handler)

Description copied from interface: ManagementStationAsync

Creates a management station using the proxy and mirror configuration information provided.

Specified by:

createManagementStation in interface ManagementStationAsync

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.

deleteManagementStation

public Future<DeleteManagementStationResponse> deleteManagementStation(DeleteManagementStationRequest request,
                                                                       AsyncHandler<DeleteManagementStationRequest,DeleteManagementStationResponse> handler)

Description copied from interface: ManagementStationAsync

Deletes a management station.

You can’t delete a station if there are resources associated with the station (such as instances using the station or profiles associated with the station). Switch stations and edit profiles as needed before deleting the station.

Specified by:

deleteManagementStation in interface ManagementStationAsync

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.

getManagementStation

public Future<GetManagementStationResponse> getManagementStation(GetManagementStationRequest request,
                                                                 AsyncHandler<GetManagementStationRequest,GetManagementStationResponse> handler)

Description copied from interface: ManagementStationAsync

Returns information about the specified management station.

Specified by:

getManagementStation in interface ManagementStationAsync

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.

listManagementStations

public Future<ListManagementStationsResponse> listManagementStations(ListManagementStationsRequest request,
                                                                     AsyncHandler<ListManagementStationsRequest,ListManagementStationsResponse> handler)

Description copied from interface: ManagementStationAsync

Lists management stations within the specified compartment.

Filter the list against a variety of criteria including but not limited to name, status, and location.

Specified by:

listManagementStations in interface ManagementStationAsync

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.

listMirrors

public Future<ListMirrorsResponse> listMirrors(ListMirrorsRequest request,
                                               AsyncHandler<ListMirrorsRequest,ListMirrorsResponse> handler)

Description copied from interface: ManagementStationAsync

Lists all software source mirrors associated with a specified management station.

Specified by:

listMirrors in interface ManagementStationAsync

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.

refreshManagementStationConfig

public Future<RefreshManagementStationConfigResponse> refreshManagementStationConfig(RefreshManagementStationConfigRequest request,
                                                                                     AsyncHandler<RefreshManagementStationConfigRequest,RefreshManagementStationConfigResponse> handler)

Description copied from interface: ManagementStationAsync

Refreshes the list of software sources mirrored by the management station.

Specified by:

refreshManagementStationConfig in interface ManagementStationAsync

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.

synchronizeMirrors

public Future<SynchronizeMirrorsResponse> synchronizeMirrors(SynchronizeMirrorsRequest request,
                                                             AsyncHandler<SynchronizeMirrorsRequest,SynchronizeMirrorsResponse> handler)

Description copied from interface: ManagementStationAsync

Synchronize the specified software sources mirrored on the management station.

Specified by:

synchronizeMirrors in interface ManagementStationAsync

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.

synchronizeSingleMirrors

public Future<SynchronizeSingleMirrorsResponse> synchronizeSingleMirrors(SynchronizeSingleMirrorsRequest request,
                                                                         AsyncHandler<SynchronizeSingleMirrorsRequest,SynchronizeSingleMirrorsResponse> handler)

Description copied from interface: ManagementStationAsync

Synchronize the specified software source mirrors on the management station.

Specified by:

synchronizeSingleMirrors in interface ManagementStationAsync

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.

updateManagementStation

public Future<UpdateManagementStationResponse> updateManagementStation(UpdateManagementStationRequest request,
                                                                       AsyncHandler<UpdateManagementStationRequest,UpdateManagementStationResponse> handler)

Description copied from interface: ManagementStationAsync

Updates the configuration of the specified management station.

Specified by:

updateManagementStation in interface ManagementStationAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)