Package com.oracle.bmc.http.internal

Class BaseSyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

AccessGovernanceCPClient, AccessRequestsClient, AccountClient, AddressRuleServiceClient, AddressServiceClient, AIServiceDocumentClient, AIServiceLanguageClient, AIServiceSpeechClient, AIServiceVisionClient, AnalyticsClient, AnnouncementClient, AnnouncementsPreferencesClient, AnnouncementSubscriptionClient, AnomalyDetectionClient, ApiGatewayClient, ApmDomainClient, ApmSyntheticClient, ApplianceExportJobClient, ApplicationDependencyManagementClient, AppmgmtControlClient, ArtifactsClient, AttachmentClient, AttachmentClient, AttributesClient, AuditClient, AutoScalingClient, BastionClient, BdsClient, BillingScheduleClient, BillingScheduleClient, BlockchainPlatformClient, BlockstorageClient, BudgetClient, CapacityManagementClient, CertificatesClient, CertificatesManagementClient, ChannelsClient, CloudGuardClient, ClusterClient, ClusterPlacementGroupsCPClient, CommitmentClient, CommitmentClient, CommonClient, ComputeClient, ComputeCloudAtCustomerClient, ComputedUsageClient, ComputedUsageClient, ComputeInstanceAgentClient, ComputeManagementClient, ConfigClient, ConnectorPluginsClient, ContainerEngineClient, ContainerInstanceClient, DashboardClient, DashboardGroupClient, DashxApisClient, DatabaseClient, DatabaseMigrationClient, DatabaseRecoveryClient, DatabaseToolsClient, DataCatalogClient, DataFlowClient, DataIntegrationClient, DataLabelingClient, DataLabelingManagementClient, DataplaneClient, DataSafeClient, DataScienceClient, DbBackupsClient, DbLifeCycleManagementClient, DbManagementClient, DbSystemClient, DelegateAccessControlClient, DeploymentClient, DesktopServiceClient, DevopsClient, DiagnosabilityClient, DisasterRecoveryClient, DiscoveryClient, DnsClient, DomainClient, DomainGovernanceClient, EkmClient, EmailClient, EmailDPClient, EmWarehouseClient, EsxiHostClient, EventClient, EventClient, EventsClient, FileStorageClient, FleetAppsManagementAdminClient, FleetAppsManagementClient, FleetAppsManagementMaintenanceWindowClient, FleetAppsManagementOperationsClient, FleetAppsManagementRunbooksClient, FleetSoftwareUpdateClient, FunctionsInvokeClient, FunctionsManagementClient, FusionApplicationsClient, GatewayClient, GenerativeAiAgentClient, GenerativeAiAgentRuntimeClient, GenerativeAiClient, GenerativeAiInferenceClient, GenericArtifactsContentClient, GoldenGateClient, GovernanceClient, GovernanceRuleClient, HealthChecksClient, IdentityClient, IdentityDomainsClient, IncidentClient, IntegrationInstanceClient, InventoryClient, InvoiceServiceClient, InvoiceSummaryClient, JavaDownloadClient, JavaManagementServiceClient, KmsCryptoClient, KmsHsmClusterClient, KmsManagementClient, KmsVaultClient, LicenseManagerClient, LifecycleEnvironmentClient, LimitsClient, LinkClient, LoadBalancerClient, LockboxClient, LogAnalyticsClient, LoggingClient, LoggingManagementClient, LogSearchClient, LustreFileStorageClient, MacDeviceClient, MacOrderClient, ManagedInstanceClient, ManagedInstanceGroupClient, ManagedMySqlDatabasesClient, ManagementAgentClient, ManagementClient, ManagementStationClient, MarketplaceClient, MarketplacePublisherClient, MediaServicesClient, MediaStreamClient, MigrationClient, MonitoringClient, MysqlaasClient, NetworkFirewallClient, NetworkLoadBalancerClient, NosqlClient, NotificationControlPlaneClient, NotificationDataPlaneClient, ObjectStorageClient, OcbAgentSvcClient, OccDemandSignalClient, OccMetricsClient, OceInstanceClient, OdaClient, OdapackageClient, OfferClient, OfferClient, OnboardingClient, OpensearchClusterBackupClient, OpensearchClusterClient, OpensearchClusterPipelineClient, OperationsInsightsClient, OperatorActionsClient, OperatorControlAssignmentClient, OperatorControlClient, OptimizerClient, OrdersClient, OrganizationClient, OrganizationSubscriptionClient, OrganizationSubscriptionClient, OsManagementClient, PerfhubClient, PluginClient, PluginconfigClient, PostgresqlClient, QueryClient, QueueAdminClient, QueueClient, QuotasClient, RatecardClient, RatecardClient, RecipientInvitationClient, RedirectClient, RedisClusterClient, ReplicasClient, ReportingManagedInstanceClient, ResourceManagerClient, ResourcesClient, ResourceSearchClient, RewardsClient, RoverBundleClient, RoverClusterClient, RoverEntitlementClient, RoverNodeClient, ScheduleClient, ScheduledJobClient, SddcClient, SecretsClient, SecurityAttributeClient, SenderInvitationClient, ServiceCatalogClient, ServiceClient, ServiceConnectorClient, ServiceManagerProxyClient, ServiceMeshClient, ShapeClient, ShardedDatabaseServiceClient, ShippingVendorsClient, SoftwareSourceClient, SqlTuningClient, StackMonitoringClient, StreamAdminClient, StreamClient, SubscribedServiceClient, SubscribersClient, SubscriptionClient, SubscriptionClient, SubscriptionClient, SubscriptionServiceClient, ThreatintelClient, TraceClient, TransferApplianceClient, TransferApplianceEntitlementClient, TransferDeviceClient, TransferJobClient, TransferPackageClient, UsageapiClient, UsagelimitsClient, UsagePlansClient, VaultsClient, VbInstanceClient, VbsInstanceClient, VirtualNetworkClient, VnMonitoringClient, VulnerabilityScanningClient, WaaClient, WaasClient, WafClient, WorkRequestClient, WorkRequestClient, WorkRequestClient, WorkRequestClient, WorkRequestClient, WorkRequestClient, WorkRequestClient, WorkRequestsClient, WorkRequestsClient, WorkRequestsClient, ZprClient

public class BaseSyncClient
extends Object

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.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseSyncClient(ClientBuilderBase<?,?> builder, AbstractAuthenticationDetailsProvider authenticationDetailsProvider, CircuitBreakerConfiguration defaultCircuitBreaker)

Method Summary

Modifier and Type	Method	Description
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()
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
void	setEndpoint(String endpoint)
protected void	setRegion(Region region)
protected void	setRegion(String regionId)
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
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

Field Detail

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

BaseSyncClient

protected BaseSyncClient(ClientBuilderBase<?,?> builder,
                         AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         CircuitBreakerConfiguration defaultCircuitBreaker)

Method Detail

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)

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.

setRegion

protected void setRegion(Region region)

setRegion

protected void setRegion(String regionId)

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()