Class JmsUtilsClient
- java.lang.Object
- 
- com.oracle.bmc.http.internal.BaseSyncClient
- 
- com.oracle.bmc.jmsutils.JmsUtilsClient
 
 
- 
- All Implemented Interfaces:
- JmsUtils,- AutoCloseable
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20250521") public class JmsUtilsClient extends BaseSyncClient implements JmsUtils
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classJmsUtilsClient.BuilderBuilder class for this client.
 - 
Field SummaryFields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for JmsUtils.
 - 
Constructor SummaryConstructors Constructor Description JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method Summary- 
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClientclientCall
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.jmsutils.JmsUtilsgetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
JmsUtilsClient@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- JmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
 
 - 
JmsUtilsClient@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- JmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
 
 - 
JmsUtilsClient@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- JmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
 
 - 
JmsUtilsClient@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- JmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
 
 - 
JmsUtilsClient@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- JmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
 
 - 
JmsUtilsClient@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- JmsUtilsClient.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)
 
 - 
JmsUtilsClient@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- JmsUtilsClient.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
 
 - 
JmsUtilsClient@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- JmsUtilsClient.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-- JmsUtilsClient.Builder.executorService
 
 
- 
 - 
Method Detail- 
builderpublic static JmsUtilsClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:JmsUtilsSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:JmsUtilsSets 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 callsetEndpoint.
 - 
cancelWorkRequestpublic CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request) Description copied from interface:JmsUtilsCancels a work request.- Specified by:
- cancelWorkRequestin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteJavaMigrationAnalysispublic DeleteJavaMigrationAnalysisResponse deleteJavaMigrationAnalysis(DeleteJavaMigrationAnalysisRequest request) Description copied from interface:JmsUtilsDeletes a Java Migration Analysis.- Specified by:
- deleteJavaMigrationAnalysisin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deletePerformanceTuningAnalysispublic DeletePerformanceTuningAnalysisResponse deletePerformanceTuningAnalysis(DeletePerformanceTuningAnalysisRequest request) Description copied from interface:JmsUtilsDeletes a Performance Tuning Analysis.- Specified by:
- deletePerformanceTuningAnalysisin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getAnalyzeApplicationsConfigurationpublic GetAnalyzeApplicationsConfigurationResponse getAnalyzeApplicationsConfiguration(GetAnalyzeApplicationsConfigurationRequest request) Description copied from interface:JmsUtilsReturns the configuration for analyzing applications.- Specified by:
- getAnalyzeApplicationsConfigurationin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getJavaMigrationAnalysispublic GetJavaMigrationAnalysisResponse getJavaMigrationAnalysis(GetJavaMigrationAnalysisRequest request) Description copied from interface:JmsUtilsGets information about a Java Migration Analysis.- Specified by:
- getJavaMigrationAnalysisin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getPerformanceTuningAnalysispublic GetPerformanceTuningAnalysisResponse getPerformanceTuningAnalysis(GetPerformanceTuningAnalysisRequest request) Description copied from interface:JmsUtilsGets information about a Performance Tuning Analysis.- Specified by:
- getPerformanceTuningAnalysisin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getSubscriptionAcknowledgmentConfigurationpublic GetSubscriptionAcknowledgmentConfigurationResponse getSubscriptionAcknowledgmentConfiguration(GetSubscriptionAcknowledgmentConfigurationRequest request) Description copied from interface:JmsUtilsReturns the configuration for subscription acknowledgment.- Specified by:
- getSubscriptionAcknowledgmentConfigurationin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWorkRequestpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request) Description copied from interface:JmsUtilsGets the details of a work request.- Specified by:
- getWorkRequestin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listJavaMigrationAnalysispublic ListJavaMigrationAnalysisResponse listJavaMigrationAnalysis(ListJavaMigrationAnalysisRequest request) Description copied from interface:JmsUtilsGets a list of Java Migration Analysis.- Specified by:
- listJavaMigrationAnalysisin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listPerformanceTuningAnalysispublic ListPerformanceTuningAnalysisResponse listPerformanceTuningAnalysis(ListPerformanceTuningAnalysisRequest request) Description copied from interface:JmsUtilsGets a list of Performance tuning Analysis.- Specified by:
- listPerformanceTuningAnalysisin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkItemspublic ListWorkItemsResponse listWorkItems(ListWorkItemsRequest request) Description copied from interface:JmsUtilsRetrieve a paginated list of work items for a specified work request.- Specified by:
- listWorkItemsin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestErrorspublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request) Description copied from interface:JmsUtilsLists the errors for a work request.- Specified by:
- listWorkRequestErrorsin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestLogspublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request) Description copied from interface:JmsUtilsLists the logs for a work request.- Specified by:
- listWorkRequestLogsin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestspublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request) Description copied from interface:JmsUtilsLists the work requests in a compartment.- Specified by:
- listWorkRequestsin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
requestJavaMigrationAnalysispublic RequestJavaMigrationAnalysisResponse requestJavaMigrationAnalysis(RequestJavaMigrationAnalysisRequest request) Description copied from interface:JmsUtilsRequests Java Migration Analysis.- Specified by:
- requestJavaMigrationAnalysisin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
requestPerformanceTuningAnalysispublic RequestPerformanceTuningAnalysisResponse requestPerformanceTuningAnalysis(RequestPerformanceTuningAnalysisRequest request) Description copied from interface:JmsUtilsRequests Performance Tuning Analysis.- Specified by:
- requestPerformanceTuningAnalysisin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateAnalyzeApplicationsConfigurationpublic UpdateAnalyzeApplicationsConfigurationResponse updateAnalyzeApplicationsConfiguration(UpdateAnalyzeApplicationsConfigurationRequest request) Description copied from interface:JmsUtilsUpdates the configuration for analyze application.- Specified by:
- updateAnalyzeApplicationsConfigurationin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateSubscriptionAcknowledgmentConfigurationpublic UpdateSubscriptionAcknowledgmentConfigurationResponse updateSubscriptionAcknowledgmentConfiguration(UpdateSubscriptionAcknowledgmentConfigurationRequest request) Description copied from interface:JmsUtilsUpdates the configuration for subscription acknowledgment.- Specified by:
- updateSubscriptionAcknowledgmentConfigurationin interface- JmsUtils
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWaiterspublic JmsUtilsWaiters getWaiters() Description copied from interface:JmsUtilsGets the pre-configured waiters available for resources for this service.- Specified by:
- getWaitersin interface- JmsUtils
- Returns:
- The service waiters.
 
 - 
getPaginatorspublic JmsUtilsPaginators getPaginators() Description copied from interface:JmsUtilsGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
- getPaginatorsin interface- JmsUtils
- Returns:
- The service paginators.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic 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
 
 - 
populateServiceParametersInEndpointpublic 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
 
 - 
updateBaseEndpointpublic 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
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 
- 
 
-