Package com.oracle.bmc.wlms

Interface WeblogicManagementServiceAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    WeblogicManagementServiceAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20241101")
public interface WeblogicManagementServiceAsync
extends AutoCloseable
    WebLogic Management Service is an OCI service that enables a unified view and management of WebLogic domains in Oracle Cloud Infrastructure.

    Features include on-demand patching of WebLogic domains, rollback of the last applied patch, discovery and management of WebLogic instances on a compute host.

    • 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 serice.

      • 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

      • createAgreementRecord

        Future<CreateAgreementRecordResponse> createAgreementRecord​(CreateAgreementRecordRequest request,
                                                            AsyncHandler<CreateAgreementRecordRequest,​CreateAgreementRecordResponse> handler)
        Creates a terms of use agreement record for a WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteWlsDomain

        Future<DeleteWlsDomainResponse> deleteWlsDomain​(DeleteWlsDomainRequest request,
                                                AsyncHandler<DeleteWlsDomainRequest,​DeleteWlsDomainResponse> handler)
        Delete the WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getAgreement

        Future<GetAgreementResponse> getAgreement​(GetAgreementRequest request,
                                          AsyncHandler<GetAgreementRequest,​GetAgreementResponse> handler)
        Returns the terms and conditions of use agreement.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getManagedInstance

        Future<GetManagedInstanceResponse> getManagedInstance​(GetManagedInstanceRequest request,
                                                      AsyncHandler<GetManagedInstanceRequest,​GetManagedInstanceResponse> handler)
        Gets information about the specified managed instance.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getManagedInstanceServer

        Future<GetManagedInstanceServerResponse> getManagedInstanceServer​(GetManagedInstanceServerRequest request,
                                                                  AsyncHandler<GetManagedInstanceServerRequest,​GetManagedInstanceServerResponse> handler)
        Gets information about the specified server in a managed instance.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getWlsDomain

        Future<GetWlsDomainResponse> getWlsDomain​(GetWlsDomainRequest request,
                                          AsyncHandler<GetWlsDomainRequest,​GetWlsDomainResponse> handler)
        Gets a specific WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getWlsDomainCredential

        Future<GetWlsDomainCredentialResponse> getWlsDomainCredential​(GetWlsDomainCredentialRequest request,
                                                              AsyncHandler<GetWlsDomainCredentialRequest,​GetWlsDomainCredentialResponse> handler)
        Gets WebLogic and Node Manager credentials of a specific WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getWlsDomainServer

        Future<GetWlsDomainServerResponse> getWlsDomainServer​(GetWlsDomainServerRequest request,
                                                      AsyncHandler<GetWlsDomainServerRequest,​GetWlsDomainServerResponse> handler)
        Gets information about the specified server in a WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Gets the details of a work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listAgreementRecords

        Future<ListAgreementRecordsResponse> listAgreementRecords​(ListAgreementRecordsRequest request,
                                                          AsyncHandler<ListAgreementRecordsRequest,​ListAgreementRecordsResponse> handler)
        List the terms of use agreement record for the WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listApplicablePatches

        Future<ListApplicablePatchesResponse> listApplicablePatches​(ListApplicablePatchesRequest request,
                                                            AsyncHandler<ListApplicablePatchesRequest,​ListApplicablePatchesResponse> handler)
        Gets the latest patches that can be installed to the WebLogic domains.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listManagedInstances

        Future<ListManagedInstancesResponse> listManagedInstances​(ListManagedInstancesRequest request,
                                                          AsyncHandler<ListManagedInstancesRequest,​ListManagedInstancesResponse> handler)
        Lists managed instances that match the specified compartment or managed instance OCID.

        Filter the list against a variety of criteria including but not limited to its name, status and compartment.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listRequiredPolicies

        Future<ListRequiredPoliciesResponse> listRequiredPolicies​(ListRequiredPoliciesRequest request,
                                                          AsyncHandler<ListRequiredPoliciesRequest,​ListRequiredPoliciesResponse> handler)
        Gets all the required policies for the WebLogic Management Service.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWlsDomainScanResults

        Future<ListWlsDomainScanResultsResponse> listWlsDomainScanResults​(ListWlsDomainScanResultsRequest request,
                                                                  AsyncHandler<ListWlsDomainScanResultsRequest,​ListWlsDomainScanResultsResponse> handler)
        Get all scan results for a server in a specific WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWlsDomainServers

        Future<ListWlsDomainServersResponse> listWlsDomainServers​(ListWlsDomainServersRequest request,
                                                          AsyncHandler<ListWlsDomainServersRequest,​ListWlsDomainServersResponse> handler)
        Gets list of servers in a specific WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWlsDomains

        Future<ListWlsDomainsResponse> listWlsDomains​(ListWlsDomainsRequest request,
                                              AsyncHandler<ListWlsDomainsRequest,​ListWlsDomainsResponse> handler)
        Gets all WebLogic domains in a given compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Lists the errors for a work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Lists the logs for a work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • restartWlsDomain

        Future<RestartWlsDomainResponse> restartWlsDomain​(RestartWlsDomainRequest request,
                                                  AsyncHandler<RestartWlsDomainRequest,​RestartWlsDomainResponse> handler)
        Restarts all the servers in the WebLogic domains.

        Servers that are already stopped are ignored.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • restoreWlsDomain

        Future<RestoreWlsDomainResponse> restoreWlsDomain​(RestoreWlsDomainRequest request,
                                                  AsyncHandler<RestoreWlsDomainRequest,​RestoreWlsDomainResponse> handler)
        Restore a domain from backup.

        If the backup contains a MIDDLEWARE asset, then the middleware of the domain, including patches, will be restored.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • scanManagedInstance

        Future<ScanManagedInstanceResponse> scanManagedInstance​(ScanManagedInstanceRequest request,
                                                        AsyncHandler<ScanManagedInstanceRequest,​ScanManagedInstanceResponse> handler)
        Scans a managed instance for WebLogic domains.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • scanWlsDomain

        Future<ScanWlsDomainResponse> scanWlsDomain​(ScanWlsDomainRequest request,
                                            AsyncHandler<ScanWlsDomainRequest,​ScanWlsDomainResponse> handler)
        Runs a series of checks in the WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • setRestartOrder

        Future<SetRestartOrderResponse> setRestartOrder​(SetRestartOrderRequest request,
                                                AsyncHandler<SetRestartOrderRequest,​SetRestartOrderResponse> handler)
        Sets restart order of servers in specific WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • startWlsDomain

        Future<StartWlsDomainResponse> startWlsDomain​(StartWlsDomainRequest request,
                                              AsyncHandler<StartWlsDomainRequest,​StartWlsDomainResponse> handler)
        Starts all the servers in the WebLogic domain.

        Servers that are already started are ignored.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • stopWlsDomain

        Future<StopWlsDomainResponse> stopWlsDomain​(StopWlsDomainRequest request,
                                            AsyncHandler<StopWlsDomainRequest,​StopWlsDomainResponse> handler)
        Stops all the servers in the WebLogic domain.

        Servers that are already stopped are ignored.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • summarizeResourceInventory

        Future<SummarizeResourceInventoryResponse> summarizeResourceInventory​(SummarizeResourceInventoryRequest request,
                                                                      AsyncHandler<SummarizeResourceInventoryRequest,​SummarizeResourceInventoryResponse> handler)
        Gets the data to be shown in the Overview page of the service in a given compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateManagedInstance

        Future<UpdateManagedInstanceResponse> updateManagedInstance​(UpdateManagedInstanceRequest request,
                                                            AsyncHandler<UpdateManagedInstanceRequest,​UpdateManagedInstanceResponse> handler)
        Updates the specified managed instance information, such as discovery interval and domain search path.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateWlsDomain

        Future<UpdateWlsDomainResponse> updateWlsDomain​(UpdateWlsDomainRequest request,
                                                AsyncHandler<UpdateWlsDomainRequest,​UpdateWlsDomainResponse> handler)
        Updates a specific WebLogic domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.