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 Summary
Nested Classes Modifier and Type Class Description static class
JmsUtilsClient.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 JmsUtils.
-
Constructor Summary
Constructors Constructor Description JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
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 java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.jmsutils.JmsUtils
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJmsUtilsClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJmsUtilsClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJmsUtilsClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJmsUtilsClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJmsUtilsClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJmsUtilsClient.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
-
builder
public static JmsUtilsClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:JmsUtils
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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:JmsUtils
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 callsetEndpoint
.
-
cancelWorkRequest
public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Description copied from interface:JmsUtils
Cancels a work request.- Specified by:
cancelWorkRequest
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteJavaMigrationAnalysis
public DeleteJavaMigrationAnalysisResponse deleteJavaMigrationAnalysis(DeleteJavaMigrationAnalysisRequest request)
Description copied from interface:JmsUtils
Deletes a Java Migration Analysis.- Specified by:
deleteJavaMigrationAnalysis
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePerformanceTuningAnalysis
public DeletePerformanceTuningAnalysisResponse deletePerformanceTuningAnalysis(DeletePerformanceTuningAnalysisRequest request)
Description copied from interface:JmsUtils
Deletes a Performance Tuning Analysis.- Specified by:
deletePerformanceTuningAnalysis
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAnalyzeApplicationsConfiguration
public GetAnalyzeApplicationsConfigurationResponse getAnalyzeApplicationsConfiguration(GetAnalyzeApplicationsConfigurationRequest request)
Description copied from interface:JmsUtils
Returns the configuration for analyzing applications.- Specified by:
getAnalyzeApplicationsConfiguration
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJavaMigrationAnalysis
public GetJavaMigrationAnalysisResponse getJavaMigrationAnalysis(GetJavaMigrationAnalysisRequest request)
Description copied from interface:JmsUtils
Gets information about a Java Migration Analysis.- Specified by:
getJavaMigrationAnalysis
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPerformanceTuningAnalysis
public GetPerformanceTuningAnalysisResponse getPerformanceTuningAnalysis(GetPerformanceTuningAnalysisRequest request)
Description copied from interface:JmsUtils
Gets information about a Performance Tuning Analysis.- Specified by:
getPerformanceTuningAnalysis
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSubscriptionAcknowledgmentConfiguration
public GetSubscriptionAcknowledgmentConfigurationResponse getSubscriptionAcknowledgmentConfiguration(GetSubscriptionAcknowledgmentConfigurationRequest request)
Description copied from interface:JmsUtils
Returns the configuration for subscription acknowledgment.- Specified by:
getSubscriptionAcknowledgmentConfiguration
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:JmsUtils
Gets the details of a work request.- Specified by:
getWorkRequest
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJavaMigrationAnalysis
public ListJavaMigrationAnalysisResponse listJavaMigrationAnalysis(ListJavaMigrationAnalysisRequest request)
Description copied from interface:JmsUtils
Gets a list of Java Migration Analysis.- Specified by:
listJavaMigrationAnalysis
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPerformanceTuningAnalysis
public ListPerformanceTuningAnalysisResponse listPerformanceTuningAnalysis(ListPerformanceTuningAnalysisRequest request)
Description copied from interface:JmsUtils
Gets a list of Performance tuning Analysis.- Specified by:
listPerformanceTuningAnalysis
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkItems
public ListWorkItemsResponse listWorkItems(ListWorkItemsRequest request)
Description copied from interface:JmsUtils
Retrieve a paginated list of work items for a specified work request.- Specified by:
listWorkItems
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:JmsUtils
Lists the errors for a work request.- Specified by:
listWorkRequestErrors
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:JmsUtils
Lists the logs for a work request.- Specified by:
listWorkRequestLogs
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:JmsUtils
Lists the work requests in a compartment.- Specified by:
listWorkRequests
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestJavaMigrationAnalysis
public RequestJavaMigrationAnalysisResponse requestJavaMigrationAnalysis(RequestJavaMigrationAnalysisRequest request)
Description copied from interface:JmsUtils
Requests Java Migration Analysis.- Specified by:
requestJavaMigrationAnalysis
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestPerformanceTuningAnalysis
public RequestPerformanceTuningAnalysisResponse requestPerformanceTuningAnalysis(RequestPerformanceTuningAnalysisRequest request)
Description copied from interface:JmsUtils
Requests Performance Tuning Analysis.- Specified by:
requestPerformanceTuningAnalysis
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAnalyzeApplicationsConfiguration
public UpdateAnalyzeApplicationsConfigurationResponse updateAnalyzeApplicationsConfiguration(UpdateAnalyzeApplicationsConfigurationRequest request)
Description copied from interface:JmsUtils
Updates the configuration for analyze application.- Specified by:
updateAnalyzeApplicationsConfiguration
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSubscriptionAcknowledgmentConfiguration
public UpdateSubscriptionAcknowledgmentConfigurationResponse updateSubscriptionAcknowledgmentConfiguration(UpdateSubscriptionAcknowledgmentConfigurationRequest request)
Description copied from interface:JmsUtils
Updates the configuration for subscription acknowledgment.- Specified by:
updateSubscriptionAcknowledgmentConfiguration
in interfaceJmsUtils
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public JmsUtilsWaiters getWaiters()
Description copied from interface:JmsUtils
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceJmsUtils
- Returns:
- The service waiters.
-
getPaginators
public JmsUtilsPaginators getPaginators()
Description copied from interface:JmsUtils
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 interfaceJmsUtils
- 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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-