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

Class EndpointCertificatesApi

  • public class EndpointCertificatesApi
extends Object

    • Constructor Detail

      • EndpointCertificatesApi

        public EndpointCertificatesApi()

      • EndpointCertificatesApi

        public EndpointCertificatesApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • addEndpointCertificateCall

        public okhttp3.Call addEndpointCertificateCall​(File certificate,
                                               String alias,
                                               String endpoint,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for addEndpointCertificate
        Parameters:
        certificate - The certificate that needs to be uploaded. (required)
        alias - Alias for the certificate (required)
        endpoint - Endpoint to which the certificate should be applied. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • addEndpointCertificate

        public CertMetadataDTO addEndpointCertificate​(File certificate,
                                              String alias,
                                              String endpoint)
                                       throws ApiException
        Upload a new Certificate. This operation can be used to upload a new certificate for an endpoint.
        Parameters:
        certificate - The certificate that needs to be uploaded. (required)
        alias - Alias for the certificate (required)
        endpoint - Endpoint to which the certificate should be applied. (required)
        Returns:
        CertMetadataDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • addEndpointCertificateWithHttpInfo

        public ApiResponse<CertMetadataDTO> addEndpointCertificateWithHttpInfo​(File certificate,
                                                                       String alias,
                                                                       String endpoint)
                                                                throws ApiException
        Upload a new Certificate. This operation can be used to upload a new certificate for an endpoint.
        Parameters:
        certificate - The certificate that needs to be uploaded. (required)
        alias - Alias for the certificate (required)
        endpoint - Endpoint to which the certificate should be applied. (required)
        Returns:
        ApiResponse<CertMetadataDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • addEndpointCertificateAsync

        public okhttp3.Call addEndpointCertificateAsync​(File certificate,
                                                String alias,
                                                String endpoint,
                                                ApiCallback<CertMetadataDTO> _callback)
                                         throws ApiException
        Upload a new Certificate. (asynchronously) This operation can be used to upload a new certificate for an endpoint.
        Parameters:
        certificate - The certificate that needs to be uploaded. (required)
        alias - Alias for the certificate (required)
        endpoint - Endpoint to which the certificate should be applied. (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

      • deleteEndpointCertificateByAliasCall

        public okhttp3.Call deleteEndpointCertificateByAliasCall​(String alias,
                                                         ApiCallback _callback)
                                                  throws ApiException
        Build call for deleteEndpointCertificateByAlias
        Parameters:
        alias - The alias of the certificate that should be deleted. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteEndpointCertificateByAlias

        public void deleteEndpointCertificateByAlias​(String alias)
                                      throws ApiException
        Delete a certificate. This operation can be used to delete an uploaded certificate.
        Parameters:
        alias - The alias of the certificate that should be deleted. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteEndpointCertificateByAliasWithHttpInfo

        public ApiResponse<Void> deleteEndpointCertificateByAliasWithHttpInfo​(String alias)
                                                               throws ApiException
        Delete a certificate. This operation can be used to delete an uploaded certificate.
        Parameters:
        alias - The alias of the certificate that should be deleted. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteEndpointCertificateByAliasAsync

        public okhttp3.Call deleteEndpointCertificateByAliasAsync​(String alias,
                                                          ApiCallback<Void> _callback)
                                                   throws ApiException
        Delete a certificate. (asynchronously) This operation can be used to delete an uploaded certificate.
        Parameters:
        alias - The alias of the certificate that should be deleted. (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

      • getCertificateUsageByAliasCall

        public okhttp3.Call getCertificateUsageByAliasCall​(String alias,
                                                   Integer limit,
                                                   Integer offset,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for getCertificateUsageByAlias
        Parameters:
        alias - (required)
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getCertificateUsageByAlias

        public APIMetadataListDTO getCertificateUsageByAlias​(String alias,
                                                     Integer limit,
                                                     Integer offset)
                                              throws ApiException
        Retrieve all the APIs that use a given certificate by the alias This operation can be used to retrieve/identify apis that use a known certificate.
        Parameters:
        alias - (required)
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        Returns:
        APIMetadataListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCertificateUsageByAliasWithHttpInfo

        public ApiResponse<APIMetadataListDTO> getCertificateUsageByAliasWithHttpInfo​(String alias,
                                                                              Integer limit,
                                                                              Integer offset)
                                                                       throws ApiException
        Retrieve all the APIs that use a given certificate by the alias This operation can be used to retrieve/identify apis that use a known certificate.
        Parameters:
        alias - (required)
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        Returns:
        ApiResponse<APIMetadataListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCertificateUsageByAliasAsync

        public okhttp3.Call getCertificateUsageByAliasAsync​(String alias,
                                                    Integer limit,
                                                    Integer offset,
                                                    ApiCallback<APIMetadataListDTO> _callback)
                                             throws ApiException
        Retrieve all the APIs that use a given certificate by the alias (asynchronously) This operation can be used to retrieve/identify apis that use a known certificate.
        Parameters:
        alias - (required)
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        _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

      • getEndpointCertificateByAliasCall

        public okhttp3.Call getEndpointCertificateByAliasCall​(String alias,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for getEndpointCertificateByAlias
        Parameters:
        alias - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getEndpointCertificateByAlias

        public CertificateInfoDTO getEndpointCertificateByAlias​(String alias)
                                                 throws ApiException
        Get the Certificate Information This operation can be used to get the information about a certificate.
        Parameters:
        alias - (required)
        Returns:
        CertificateInfoDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEndpointCertificateByAliasWithHttpInfo

        public ApiResponse<CertificateInfoDTO> getEndpointCertificateByAliasWithHttpInfo​(String alias)
                                                                          throws ApiException
        Get the Certificate Information This operation can be used to get the information about a certificate.
        Parameters:
        alias - (required)
        Returns:
        ApiResponse<CertificateInfoDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEndpointCertificateByAliasAsync

        public okhttp3.Call getEndpointCertificateByAliasAsync​(String alias,
                                                       ApiCallback<CertificateInfoDTO> _callback)
                                                throws ApiException
        Get the Certificate Information (asynchronously) This operation can be used to get the information about a certificate.
        Parameters:
        alias - (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

      • getEndpointCertificateContentByAliasCall

        public okhttp3.Call getEndpointCertificateContentByAliasCall​(String alias,
                                                             ApiCallback _callback)
                                                      throws ApiException
        Build call for getEndpointCertificateContentByAlias
        Parameters:
        alias - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getEndpointCertificateContentByAlias

        public void getEndpointCertificateContentByAlias​(String alias)
                                          throws ApiException
        Download a Certificate This operation can be used to download a certificate which matches the given alias.
        Parameters:
        alias - (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEndpointCertificateContentByAliasWithHttpInfo

        public ApiResponse<Void> getEndpointCertificateContentByAliasWithHttpInfo​(String alias)
                                                                   throws ApiException
        Download a Certificate This operation can be used to download a certificate which matches the given alias.
        Parameters:
        alias - (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEndpointCertificateContentByAliasAsync

        public okhttp3.Call getEndpointCertificateContentByAliasAsync​(String alias,
                                                              ApiCallback<Void> _callback)
                                                       throws ApiException
        Download a Certificate (asynchronously) This operation can be used to download a certificate which matches the given alias.
        Parameters:
        alias - (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

      • getEndpointCertificatesCall

        public okhttp3.Call getEndpointCertificatesCall​(Integer limit,
                                                Integer offset,
                                                String alias,
                                                String endpoint,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getEndpointCertificates
        Parameters:
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        alias - Alias for the certificate (optional)
        endpoint - Endpoint of which the certificate is uploaded (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getEndpointCertificates

        public CertificatesDTO getEndpointCertificates​(Integer limit,
                                               Integer offset,
                                               String alias,
                                               String endpoint)
                                        throws ApiException
        Retrieve/Search Uploaded Certificates This operation can be used to retrieve and search the uploaded certificates.
        Parameters:
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        alias - Alias for the certificate (optional)
        endpoint - Endpoint of which the certificate is uploaded (optional)
        Returns:
        CertificatesDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEndpointCertificatesWithHttpInfo

        public ApiResponse<CertificatesDTO> getEndpointCertificatesWithHttpInfo​(Integer limit,
                                                                        Integer offset,
                                                                        String alias,
                                                                        String endpoint)
                                                                 throws ApiException
        Retrieve/Search Uploaded Certificates This operation can be used to retrieve and search the uploaded certificates.
        Parameters:
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        alias - Alias for the certificate (optional)
        endpoint - Endpoint of which the certificate is uploaded (optional)
        Returns:
        ApiResponse<CertificatesDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEndpointCertificatesAsync

        public okhttp3.Call getEndpointCertificatesAsync​(Integer limit,
                                                 Integer offset,
                                                 String alias,
                                                 String endpoint,
                                                 ApiCallback<CertificatesDTO> _callback)
                                          throws ApiException
        Retrieve/Search Uploaded Certificates (asynchronously) This operation can be used to retrieve and search the uploaded certificates.
        Parameters:
        limit - Maximum size of resource array to return. (optional, default to 25)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        alias - Alias for the certificate (optional)
        endpoint - Endpoint of which the certificate is uploaded (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

      • updateEndpointCertificateByAliasCall

        public okhttp3.Call updateEndpointCertificateByAliasCall​(String alias,
                                                         File certificate,
                                                         ApiCallback _callback)
                                                  throws ApiException
        Build call for updateEndpointCertificateByAlias
        Parameters:
        alias - Alias for the certificate (required)
        certificate - The certificate that needs to be uploaded. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateEndpointCertificateByAlias

        public CertMetadataDTO updateEndpointCertificateByAlias​(String alias,
                                                        File certificate)
                                                 throws ApiException
        Update a certificate. This operation can be used to update an uploaded certificate.
        Parameters:
        alias - Alias for the certificate (required)
        certificate - The certificate that needs to be uploaded. (required)
        Returns:
        CertMetadataDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateEndpointCertificateByAliasWithHttpInfo

        public ApiResponse<CertMetadataDTO> updateEndpointCertificateByAliasWithHttpInfo​(String alias,
                                                                                 File certificate)
                                                                          throws ApiException
        Update a certificate. This operation can be used to update an uploaded certificate.
        Parameters:
        alias - Alias for the certificate (required)
        certificate - The certificate that needs to be uploaded. (required)
        Returns:
        ApiResponse<CertMetadataDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateEndpointCertificateByAliasAsync

        public okhttp3.Call updateEndpointCertificateByAliasAsync​(String alias,
                                                          File certificate,
                                                          ApiCallback<CertMetadataDTO> _callback)
                                                   throws ApiException
        Update a certificate. (asynchronously) This operation can be used to update an uploaded certificate.
        Parameters:
        alias - Alias for the certificate (required)
        certificate - The certificate that needs to be uploaded. (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