Package com.oracle.bmc.jmsutils

Interface JmsUtils

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    JmsUtilsClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250521")
public interface JmsUtils
extends AutoCloseable
    The APIs for Analyze Applications and other utilities of Java Management Service.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        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.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        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.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • cancelWorkRequest

        CancelWorkRequestResponse cancelWorkRequest​(CancelWorkRequestRequest request)
        Cancels a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/CancelWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelWorkRequest API.

      • deleteJavaMigrationAnalysis

        DeleteJavaMigrationAnalysisResponse deleteJavaMigrationAnalysis​(DeleteJavaMigrationAnalysisRequest request)
        Deletes a Java Migration Analysis.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/DeleteJavaMigrationAnalysisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteJavaMigrationAnalysis API.

      • deletePerformanceTuningAnalysis

        DeletePerformanceTuningAnalysisResponse deletePerformanceTuningAnalysis​(DeletePerformanceTuningAnalysisRequest request)
        Deletes a Performance Tuning Analysis.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/DeletePerformanceTuningAnalysisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePerformanceTuningAnalysis API.

      • getAnalyzeApplicationsConfiguration

        GetAnalyzeApplicationsConfigurationResponse getAnalyzeApplicationsConfiguration​(GetAnalyzeApplicationsConfigurationRequest request)
        Returns the configuration for analyzing applications.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/GetAnalyzeApplicationsConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAnalyzeApplicationsConfiguration API.

      • getJavaMigrationAnalysis

        GetJavaMigrationAnalysisResponse getJavaMigrationAnalysis​(GetJavaMigrationAnalysisRequest request)
        Gets information about a Java Migration Analysis.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/GetJavaMigrationAnalysisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetJavaMigrationAnalysis API.

      • getPerformanceTuningAnalysis

        GetPerformanceTuningAnalysisResponse getPerformanceTuningAnalysis​(GetPerformanceTuningAnalysisRequest request)
        Gets information about a Performance Tuning Analysis.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/GetPerformanceTuningAnalysisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPerformanceTuningAnalysis API.

      • getSubscriptionAcknowledgmentConfiguration

        GetSubscriptionAcknowledgmentConfigurationResponse getSubscriptionAcknowledgmentConfiguration​(GetSubscriptionAcknowledgmentConfigurationRequest request)
        Returns the configuration for subscription acknowledgment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/GetSubscriptionAcknowledgmentConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSubscriptionAcknowledgmentConfiguration API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets the details of a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listJavaMigrationAnalysis

        ListJavaMigrationAnalysisResponse listJavaMigrationAnalysis​(ListJavaMigrationAnalysisRequest request)
        Gets a list of Java Migration Analysis.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/ListJavaMigrationAnalysisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListJavaMigrationAnalysis API.

      • listPerformanceTuningAnalysis

        ListPerformanceTuningAnalysisResponse listPerformanceTuningAnalysis​(ListPerformanceTuningAnalysisRequest request)
        Gets a list of Performance tuning Analysis.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/ListPerformanceTuningAnalysisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPerformanceTuningAnalysis API.

      • listWorkItems

        ListWorkItemsResponse listWorkItems​(ListWorkItemsRequest request)
        Retrieve a paginated list of work items for a specified work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/ListWorkItemsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkItems API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Lists the errors for a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.

      • listWorkRequestLogs

        ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Lists the logs for a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • requestJavaMigrationAnalysis

        RequestJavaMigrationAnalysisResponse requestJavaMigrationAnalysis​(RequestJavaMigrationAnalysisRequest request)
        Requests Java Migration Analysis.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/RequestJavaMigrationAnalysisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RequestJavaMigrationAnalysis API.

      • requestPerformanceTuningAnalysis

        RequestPerformanceTuningAnalysisResponse requestPerformanceTuningAnalysis​(RequestPerformanceTuningAnalysisRequest request)
        Requests Performance Tuning Analysis.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/RequestPerformanceTuningAnalysisExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RequestPerformanceTuningAnalysis API.

      • updateAnalyzeApplicationsConfiguration

        UpdateAnalyzeApplicationsConfigurationResponse updateAnalyzeApplicationsConfiguration​(UpdateAnalyzeApplicationsConfigurationRequest request)
        Updates the configuration for analyze application.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/UpdateAnalyzeApplicationsConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAnalyzeApplicationsConfiguration API.

      • updateSubscriptionAcknowledgmentConfiguration

        UpdateSubscriptionAcknowledgmentConfigurationResponse updateSubscriptionAcknowledgmentConfiguration​(UpdateSubscriptionAcknowledgmentConfigurationRequest request)
        Updates the configuration for subscription acknowledgment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.74.0/jmsutils/UpdateSubscriptionAcknowledgmentConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSubscriptionAcknowledgmentConfiguration API.

      • getWaiters

        JmsUtilsWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        JmsUtilsPaginators getPaginators()
        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.

        Returns:
        The service paginators.