com.oracle.bmc.osmanagementhub

Class SoftwareSourceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osmanagementhub.SoftwareSourceClient

All Implemented Interfaces:

SoftwareSource, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class SoftwareSourceClient
extends BaseSyncClient
implements SoftwareSource

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for SoftwareSource.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SoftwareSourceClient.Builder	builder() Create a builder for this client.
ChangeAvailabilityOfSoftwareSourcesResponse	changeAvailabilityOfSoftwareSources(ChangeAvailabilityOfSoftwareSourcesRequest request) Updates the availability for a list of specified software sources.
void	close()
CreateEntitlementResponse	createEntitlement(CreateEntitlementRequest request) Registers the necessary entitlement credentials for OS vendor software sources.
CreateSoftwareSourceResponse	createSoftwareSource(CreateSoftwareSourceRequest request) Creates a new versioned or custom software source.
DeleteSoftwareSourceResponse	deleteSoftwareSource(DeleteSoftwareSourceRequest request) Deletes the specified software source.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetErratumResponse	getErratum(GetErratumRequest request) Gets information about the specified erratum by its advisory name.
GetModuleStreamResponse	getModuleStream(GetModuleStreamRequest request) Gets information about the specified module stream in a software source.
GetModuleStreamProfileResponse	getModuleStreamProfile(GetModuleStreamProfileRequest request) Gets information about the specified module stream profile in a software source.
GetPackageGroupResponse	getPackageGroup(GetPackageGroupRequest request) Gets information about the specified package group from a software source.
SoftwareSourcePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetSoftwarePackageResponse	getSoftwarePackage(GetSoftwarePackageRequest request) Gets information about the specified software package.
GetSoftwareSourceResponse	getSoftwareSource(GetSoftwareSourceRequest request) Gets information about the specified software source.
SoftwareSourceWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListEntitlementsResponse	listEntitlements(ListEntitlementsRequest request) Lists entitlements in the specified tenancy OCID.
ListErrataResponse	listErrata(ListErrataRequest request) Lists all of the currently available errata.
ListModuleStreamProfilesResponse	listModuleStreamProfiles(ListModuleStreamProfilesRequest request) Lists module stream profiles from the specified software source OCID.
ListModuleStreamsResponse	listModuleStreams(ListModuleStreamsRequest request) Lists module streams from the specified software source OCID.
ListPackageGroupsResponse	listPackageGroups(ListPackageGroupsRequest request) Lists package groups that associate with the specified software source OCID.
ListSoftwarePackagesResponse	listSoftwarePackages(ListSoftwarePackagesRequest request) Lists software packages in the specified software source.
ListSoftwareSourcesResponse	listSoftwareSources(ListSoftwareSourcesRequest request) Lists software sources that match the specified tenancy or software source OCID.
ListSoftwareSourceVendorsResponse	listSoftwareSourceVendors(ListSoftwareSourceVendorsRequest request) Lists available software source vendors.
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.
SearchSoftwareSourceModulesResponse	searchSoftwareSourceModules(SearchSoftwareSourceModulesRequest request) Lists modules from a list of software sources.
SearchSoftwareSourceModuleStreamsResponse	searchSoftwareSourceModuleStreams(SearchSoftwareSourceModuleStreamsRequest request) Lists modules from a list of software sources.
SearchSoftwareSourcePackageGroupsResponse	searchSoftwareSourcePackageGroups(SearchSoftwareSourcePackageGroupsRequest request) Searches the package groups from the specified list of software sources.
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateSoftwareSourceResponse	updateSoftwareSource(UpdateSoftwareSourceRequest request) Updates the specified software source’s details, including but not limited to name, description, and tags.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

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

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for SoftwareSource.

Constructor Detail

SoftwareSourceClient

@Deprecated
public SoftwareSourceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

SoftwareSourceClient

@Deprecated
public SoftwareSourceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

SoftwareSourceClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

SoftwareSourceClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

SoftwareSourceClient

@Deprecated
public SoftwareSourceClient(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 SoftwareSourceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

SoftwareSourceClient

@Deprecated
public SoftwareSourceClient(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 SoftwareSourceClient.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)

SoftwareSourceClient

@Deprecated
public SoftwareSourceClient(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 SoftwareSourceClient.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

SoftwareSourceClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see SoftwareSourceClient.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

executorService - SoftwareSourceClient.Builder.executorService

Method Detail

builder

public static SoftwareSourceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: SoftwareSource

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 SoftwareSource

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: SoftwareSource

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 SoftwareSource

Parameters:

regionId - The public region ID.

changeAvailabilityOfSoftwareSources

public ChangeAvailabilityOfSoftwareSourcesResponse changeAvailabilityOfSoftwareSources(ChangeAvailabilityOfSoftwareSourcesRequest request)

Description copied from interface: SoftwareSource

Updates the availability for a list of specified software sources.

Specified by:

changeAvailabilityOfSoftwareSources in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createEntitlement

public CreateEntitlementResponse createEntitlement(CreateEntitlementRequest request)

Description copied from interface: SoftwareSource

Registers the necessary entitlement credentials for OS vendor software sources.

Specified by:

createEntitlement in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createSoftwareSource

public CreateSoftwareSourceResponse createSoftwareSource(CreateSoftwareSourceRequest request)

Description copied from interface: SoftwareSource

Creates a new versioned or custom software source.

Specified by:

createSoftwareSource in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteSoftwareSource

public DeleteSoftwareSourceResponse deleteSoftwareSource(DeleteSoftwareSourceRequest request)

Description copied from interface: SoftwareSource

Deletes the specified software source.

Specified by:

deleteSoftwareSource in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getErratum

public GetErratumResponse getErratum(GetErratumRequest request)

Description copied from interface: SoftwareSource

Gets information about the specified erratum by its advisory name.

Specified by:

getErratum in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getModuleStream

public GetModuleStreamResponse getModuleStream(GetModuleStreamRequest request)

Description copied from interface: SoftwareSource

Gets information about the specified module stream in a software source.

Specified by:

getModuleStream in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getModuleStreamProfile

public GetModuleStreamProfileResponse getModuleStreamProfile(GetModuleStreamProfileRequest request)

Description copied from interface: SoftwareSource

Gets information about the specified module stream profile in a software source.

Specified by:

getModuleStreamProfile in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPackageGroup

public GetPackageGroupResponse getPackageGroup(GetPackageGroupRequest request)

Description copied from interface: SoftwareSource

Gets information about the specified package group from a software source.

Specified by:

getPackageGroup in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSoftwarePackage

public GetSoftwarePackageResponse getSoftwarePackage(GetSoftwarePackageRequest request)

Description copied from interface: SoftwareSource

Gets information about the specified software package.

Specified by:

getSoftwarePackage in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSoftwareSource

public GetSoftwareSourceResponse getSoftwareSource(GetSoftwareSourceRequest request)

Description copied from interface: SoftwareSource

Gets information about the specified software source.

Specified by:

getSoftwareSource in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listEntitlements

public ListEntitlementsResponse listEntitlements(ListEntitlementsRequest request)

Description copied from interface: SoftwareSource

Lists entitlements in the specified tenancy OCID. Filter the list against a variety of criteria including but not limited to its CSI, and vendor name.

Specified by:

listEntitlements in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listErrata

public ListErrataResponse listErrata(ListErrataRequest request)

Description copied from interface: SoftwareSource

Lists all of the currently available errata. Filter the list against a variety of criteria including but not limited to its name, classification type, advisory severity, and OS family.

Specified by:

listErrata in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listModuleStreamProfiles

public ListModuleStreamProfilesResponse listModuleStreamProfiles(ListModuleStreamProfilesRequest request)

Description copied from interface: SoftwareSource

Lists module stream profiles from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name, stream name, and (profile) name.

Specified by:

listModuleStreamProfiles in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listModuleStreams

public ListModuleStreamsResponse listModuleStreams(ListModuleStreamsRequest request)

Description copied from interface: SoftwareSource

Lists module streams from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name and (stream) name.

Specified by:

listModuleStreams in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPackageGroups

public ListPackageGroupsResponse listPackageGroups(ListPackageGroupsRequest request)

Description copied from interface: SoftwareSource

Lists package groups that associate with the specified software source OCID. Filter the list against a variety of criteria including but not limited to its name, and package group type.

Specified by:

listPackageGroups in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSoftwarePackages

public ListSoftwarePackagesResponse listSoftwarePackages(ListSoftwarePackagesRequest request)

Description copied from interface: SoftwareSource

Lists software packages in the specified software source. Filter the list against a variety of criteria including but not limited to its name.

Specified by:

listSoftwarePackages in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSoftwareSourceVendors

public ListSoftwareSourceVendorsResponse listSoftwareSourceVendors(ListSoftwareSourceVendorsRequest request)

Description copied from interface: SoftwareSource

Lists available software source vendors. Filter the list against a variety of criteria including but not limited to its name.

Specified by:

listSoftwareSourceVendors in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSoftwareSources

public ListSoftwareSourcesResponse listSoftwareSources(ListSoftwareSourcesRequest request)

Description copied from interface: SoftwareSource

Lists software sources that match the specified tenancy or software source OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

Specified by:

listSoftwareSources in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

searchSoftwareSourceModuleStreams

public SearchSoftwareSourceModuleStreamsResponse searchSoftwareSourceModuleStreams(SearchSoftwareSourceModuleStreamsRequest request)

Description copied from interface: SoftwareSource

Lists modules from a list of software sources. Filter the list against a variety of criteria including the module name.

Specified by:

searchSoftwareSourceModuleStreams in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

searchSoftwareSourceModules

public SearchSoftwareSourceModulesResponse searchSoftwareSourceModules(SearchSoftwareSourceModulesRequest request)

Description copied from interface: SoftwareSource

Lists modules from a list of software sources. Filter the list against a variety of criteria including the (module) name.

Specified by:

searchSoftwareSourceModules in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

searchSoftwareSourcePackageGroups

public SearchSoftwareSourcePackageGroupsResponse searchSoftwareSourcePackageGroups(SearchSoftwareSourcePackageGroupsRequest request)

Description copied from interface: SoftwareSource

Searches the package groups from the specified list of software sources. Filter the list against a variety of criteria including but not limited to its name, and group type.

Specified by:

searchSoftwareSourcePackageGroups in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateSoftwareSource

public UpdateSoftwareSourceResponse updateSoftwareSource(UpdateSoftwareSourceRequest request)

Description copied from interface: SoftwareSource

Updates the specified software source’s details, including but not limited to name, description, and tags.

Specified by:

updateSoftwareSource in interface SoftwareSource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public SoftwareSourceWaiters getWaiters()

Description copied from interface: SoftwareSource

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface SoftwareSource

Returns:

The service waiters.

getPaginators

public SoftwareSourcePaginators getPaginators()

Description copied from interface: SoftwareSource

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface SoftwareSource

Returns:

The service paginators.

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