Package org.wso2.am.integration.clients.publisher.api.v1

Class McpServerLifecycleApi

  • public class McpServerLifecycleApi
extends Object

    • Constructor Detail

      • McpServerLifecycleApi

        public McpServerLifecycleApi()

      • McpServerLifecycleApi

        public McpServerLifecycleApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • changeMCPServerLifecycleCall

        public okhttp3.Call changeMCPServerLifecycleCall​(String action,
                                                 String mcpServerId,
                                                 String lifecycleChecklist,
                                                 String ifMatch,
                                                 ApiCallback _callback)
                                          throws ApiException
        Build call for changeMCPServerLifecycle
        Parameters:
        action - The action to demote or promote the state of the MCP server. Supported actions are [ **Publish**, **Deploy as a Prototype**, **Demote to Created**, **Block**, **Deprecate**, **Re-Publish**, **Retire** ] (required)
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server**. (required)
        lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate old versions after publishing the MCP server**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Requires re-subscription when publishing the MCP server**: If you set this to true, users need to re subscribe to the MCP server although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate old versions after publishing the MCP server:true\" will deprecate older versions of a particular MCP server when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. **Sample CURL :** curl -k -H \"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\" -X POST \"https://localhost:9443/api/am/publisher/v4/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse\" (optional)
        ifMatch - Validator for conditional requests; based on ETag. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • changeMCPServerLifecycle

        public WorkflowResponseDTO changeMCPServerLifecycle​(String action,
                                                    String mcpServerId,
                                                    String lifecycleChecklist,
                                                    String ifMatch)
                                             throws ApiException
        Change MCP Server Status This operation is used to change the lifecycle of a MCP server. Eg: Publish a MCP server which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an MCP server, `action` should be `Publish`. Note that the `Re-publish` action is available only after calling `Block`. Some actions supports providing additional parameters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.
        Parameters:
        action - The action to demote or promote the state of the MCP server. Supported actions are [ **Publish**, **Deploy as a Prototype**, **Demote to Created**, **Block**, **Deprecate**, **Re-Publish**, **Retire** ] (required)
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server**. (required)
        lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate old versions after publishing the MCP server**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Requires re-subscription when publishing the MCP server**: If you set this to true, users need to re subscribe to the MCP server although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate old versions after publishing the MCP server:true\" will deprecate older versions of a particular MCP server when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. **Sample CURL :** curl -k -H \"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\" -X POST \"https://localhost:9443/api/am/publisher/v4/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse\" (optional)
        ifMatch - Validator for conditional requests; based on ETag. (optional)
        Returns:
        WorkflowResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • changeMCPServerLifecycleWithHttpInfo

        public ApiResponse<WorkflowResponseDTO> changeMCPServerLifecycleWithHttpInfo​(String action,
                                                                             String mcpServerId,
                                                                             String lifecycleChecklist,
                                                                             String ifMatch)
                                                                      throws ApiException
        Change MCP Server Status This operation is used to change the lifecycle of a MCP server. Eg: Publish a MCP server which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an MCP server, `action` should be `Publish`. Note that the `Re-publish` action is available only after calling `Block`. Some actions supports providing additional parameters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.
        Parameters:
        action - The action to demote or promote the state of the MCP server. Supported actions are [ **Publish**, **Deploy as a Prototype**, **Demote to Created**, **Block**, **Deprecate**, **Re-Publish**, **Retire** ] (required)
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server**. (required)
        lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate old versions after publishing the MCP server**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Requires re-subscription when publishing the MCP server**: If you set this to true, users need to re subscribe to the MCP server although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate old versions after publishing the MCP server:true\" will deprecate older versions of a particular MCP server when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. **Sample CURL :** curl -k -H \"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\" -X POST \"https://localhost:9443/api/am/publisher/v4/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse\" (optional)
        ifMatch - Validator for conditional requests; based on ETag. (optional)
        Returns:
        ApiResponse<WorkflowResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • changeMCPServerLifecycleAsync

        public okhttp3.Call changeMCPServerLifecycleAsync​(String action,
                                                  String mcpServerId,
                                                  String lifecycleChecklist,
                                                  String ifMatch,
                                                  ApiCallback<WorkflowResponseDTO> _callback)
                                           throws ApiException
        Change MCP Server Status (asynchronously) This operation is used to change the lifecycle of a MCP server. Eg: Publish a MCP server which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an MCP server, `action` should be `Publish`. Note that the `Re-publish` action is available only after calling `Block`. Some actions supports providing additional parameters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.
        Parameters:
        action - The action to demote or promote the state of the MCP server. Supported actions are [ **Publish**, **Deploy as a Prototype**, **Demote to Created**, **Block**, **Deprecate**, **Re-Publish**, **Retire** ] (required)
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server**. (required)
        lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate old versions after publishing the MCP server**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Requires re-subscription when publishing the MCP server**: If you set this to true, users need to re subscribe to the MCP server although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate old versions after publishing the MCP server:true\" will deprecate older versions of a particular MCP server when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. **Sample CURL :** curl -k -H \"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\" -X POST \"https://localhost:9443/api/am/publisher/v4/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse\" (optional)
        ifMatch - Validator for conditional requests; based on ETag. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • deleteMCPServerLifecycleStatePendingTasksCall

        public okhttp3.Call deleteMCPServerLifecycleStatePendingTasksCall​(String mcpServerId,
                                                                  ApiCallback _callback)
                                                           throws ApiException
        Build call for deleteMCPServerLifecycleStatePendingTasks
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteMCPServerLifecycleStatePendingTasks

        public void deleteMCPServerLifecycleStatePendingTasks​(String mcpServerId)
                                               throws ApiException
        Delete Pending Lifecycle State Change Tasks This operation can be used to remove pending lifecycle state change requests that are in pending state
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteMCPServerLifecycleStatePendingTasksWithHttpInfo

        public ApiResponse<Void> deleteMCPServerLifecycleStatePendingTasksWithHttpInfo​(String mcpServerId)
                                                                        throws ApiException
        Delete Pending Lifecycle State Change Tasks This operation can be used to remove pending lifecycle state change requests that are in pending state
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteMCPServerLifecycleStatePendingTasksAsync

        public okhttp3.Call deleteMCPServerLifecycleStatePendingTasksAsync​(String mcpServerId,
                                                                   ApiCallback<Void> _callback)
                                                            throws ApiException
        Delete Pending Lifecycle State Change Tasks (asynchronously) This operation can be used to remove pending lifecycle state change requests that are in pending state
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getMCPServerLifecycleHistoryCall

        public okhttp3.Call getMCPServerLifecycleHistoryCall​(String mcpServerId,
                                                     String ifNoneMatch,
                                                     ApiCallback _callback)
                                              throws ApiException
        Build call for getMCPServerLifecycleHistory
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getMCPServerLifecycleHistory

        public LifecycleHistoryDTO getMCPServerLifecycleHistory​(String mcpServerId,
                                                        String ifNoneMatch)
                                                 throws ApiException
        Get Lifecycle State Change History of a MCP Server This operation can be used to retrieve Lifecycle state change history of a MCP server.
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
        Returns:
        LifecycleHistoryDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMCPServerLifecycleHistoryWithHttpInfo

        public ApiResponse<LifecycleHistoryDTO> getMCPServerLifecycleHistoryWithHttpInfo​(String mcpServerId,
                                                                                 String ifNoneMatch)
                                                                          throws ApiException
        Get Lifecycle State Change History of a MCP Server This operation can be used to retrieve Lifecycle state change history of a MCP server.
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
        Returns:
        ApiResponse<LifecycleHistoryDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMCPServerLifecycleHistoryAsync

        public okhttp3.Call getMCPServerLifecycleHistoryAsync​(String mcpServerId,
                                                      String ifNoneMatch,
                                                      ApiCallback<LifecycleHistoryDTO> _callback)
                                               throws ApiException
        Get Lifecycle State Change History of a MCP Server (asynchronously) This operation can be used to retrieve Lifecycle state change history of a MCP server.
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getMCPServerLifecycleStateCall

        public okhttp3.Call getMCPServerLifecycleStateCall​(String mcpServerId,
                                                   String ifNoneMatch,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for getMCPServerLifecycleState
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getMCPServerLifecycleState

        public LifecycleStateDTO getMCPServerLifecycleState​(String mcpServerId,
                                                    String ifNoneMatch)
                                             throws ApiException
        Get Lifecycle State Data of a MCP server. This operation can be used to retrieve Lifecycle state data of a MCP server.
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
        Returns:
        LifecycleStateDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMCPServerLifecycleStateWithHttpInfo

        public ApiResponse<LifecycleStateDTO> getMCPServerLifecycleStateWithHttpInfo​(String mcpServerId,
                                                                             String ifNoneMatch)
                                                                      throws ApiException
        Get Lifecycle State Data of a MCP server. This operation can be used to retrieve Lifecycle state data of a MCP server.
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
        Returns:
        ApiResponse<LifecycleStateDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMCPServerLifecycleStateAsync

        public okhttp3.Call getMCPServerLifecycleStateAsync​(String mcpServerId,
                                                    String ifNoneMatch,
                                                    ApiCallback<LifecycleStateDTO> _callback)
                                             throws ApiException
        Get Lifecycle State Data of a MCP server. (asynchronously) This operation can be used to retrieve Lifecycle state data of a MCP server.
        Parameters:
        mcpServerId - **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object