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

Class ClientCertificatesApi

java.lang.Object

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

public class ClientCertificatesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ClientCertificatesApi()
ClientCertificatesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ClientCertMetadataDTO	addAPIClientCertificate(String apiId, File certificate, String alias, String tier)	Upload a New Certificate This operation can be used to upload a new certificate for an endpoint.
okhttp3.Call	addAPIClientCertificateAsync(String apiId, File certificate, String alias, String tier, ApiCallback<ClientCertMetadataDTO> _callback)	Upload a New Certificate (asynchronously) This operation can be used to upload a new certificate for an endpoint.
okhttp3.Call	addAPIClientCertificateCall(String apiId, File certificate, String alias, String tier, ApiCallback _callback)	Build call for addAPIClientCertificate
ApiResponse<ClientCertMetadataDTO>	addAPIClientCertificateWithHttpInfo(String apiId, File certificate, String alias, String tier)	Upload a New Certificate This operation can be used to upload a new certificate for an endpoint.
void	deleteAPIClientCertificateByAlias(String alias, String apiId)	Delete a Certificate This operation can be used to delete an uploaded certificate.
okhttp3.Call	deleteAPIClientCertificateByAliasAsync(String alias, String apiId, ApiCallback<Void> _callback)	Delete a Certificate (asynchronously) This operation can be used to delete an uploaded certificate.
okhttp3.Call	deleteAPIClientCertificateByAliasCall(String alias, String apiId, ApiCallback _callback)	Build call for deleteAPIClientCertificateByAlias
ApiResponse<Void>	deleteAPIClientCertificateByAliasWithHttpInfo(String alias, String apiId)	Delete a Certificate This operation can be used to delete an uploaded certificate.
ApiClient	getApiClient()
CertificateInfoDTO	getAPIClientCertificateByAlias(String alias, String apiId)	Get the Certificate Information This operation can be used to get the information about a certificate.
okhttp3.Call	getAPIClientCertificateByAliasAsync(String alias, String apiId, ApiCallback<CertificateInfoDTO> _callback)	Get the Certificate Information (asynchronously) This operation can be used to get the information about a certificate.
okhttp3.Call	getAPIClientCertificateByAliasCall(String alias, String apiId, ApiCallback _callback)	Build call for getAPIClientCertificateByAlias
ApiResponse<CertificateInfoDTO>	getAPIClientCertificateByAliasWithHttpInfo(String alias, String apiId)	Get the Certificate Information This operation can be used to get the information about a certificate.
void	getAPIClientCertificateContentByAlias(String apiId, String alias)	Download a Certificate This operation can be used to download a certificate which matches the given alias.
okhttp3.Call	getAPIClientCertificateContentByAliasAsync(String apiId, String alias, ApiCallback<Void> _callback)	Download a Certificate (asynchronously) This operation can be used to download a certificate which matches the given alias.
okhttp3.Call	getAPIClientCertificateContentByAliasCall(String apiId, String alias, ApiCallback _callback)	Build call for getAPIClientCertificateContentByAlias
ApiResponse<Void>	getAPIClientCertificateContentByAliasWithHttpInfo(String apiId, String alias)	Download a Certificate This operation can be used to download a certificate which matches the given alias.
ClientCertificatesDTO	getAPIClientCertificates(String apiId, Integer limit, Integer offset, String alias)	Retrieve/ Search Uploaded Client Certificates This operation can be used to retrieve and search the uploaded client certificates.
okhttp3.Call	getAPIClientCertificatesAsync(String apiId, Integer limit, Integer offset, String alias, ApiCallback<ClientCertificatesDTO> _callback)	Retrieve/ Search Uploaded Client Certificates (asynchronously) This operation can be used to retrieve and search the uploaded client certificates.
okhttp3.Call	getAPIClientCertificatesCall(String apiId, Integer limit, Integer offset, String alias, ApiCallback _callback)	Build call for getAPIClientCertificates
ApiResponse<ClientCertificatesDTO>	getAPIClientCertificatesWithHttpInfo(String apiId, Integer limit, Integer offset, String alias)	Retrieve/ Search Uploaded Client Certificates This operation can be used to retrieve and search the uploaded client certificates.
void	setApiClient(ApiClient apiClient)
ClientCertMetadataDTO	updateAPIClientCertificateByAlias(String alias, String apiId, File certificate, String tier)	Update a Certificate This operation can be used to update an uploaded certificate.
okhttp3.Call	updateAPIClientCertificateByAliasAsync(String alias, String apiId, File certificate, String tier, ApiCallback<ClientCertMetadataDTO> _callback)	Update a Certificate (asynchronously) This operation can be used to update an uploaded certificate.
okhttp3.Call	updateAPIClientCertificateByAliasCall(String alias, String apiId, File certificate, String tier, ApiCallback _callback)	Build call for updateAPIClientCertificateByAlias
ApiResponse<ClientCertMetadataDTO>	updateAPIClientCertificateByAliasWithHttpInfo(String alias, String apiId, File certificate, String tier)	Update a Certificate This operation can be used to update an uploaded certificate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientCertificatesApi

public ClientCertificatesApi()

ClientCertificatesApi

public ClientCertificatesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addAPIClientCertificateCall

public okhttp3.Call addAPIClientCertificateCall(String apiId,
                                                File certificate,
                                                String alias,
                                                String tier,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for addAPIClientCertificate

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

certificate - The certificate that needs to be uploaded. (required)

alias - Alias for the certificate (required)

tier - api tier 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

addAPIClientCertificate

public ClientCertMetadataDTO addAPIClientCertificate(String apiId,
                                                     File certificate,
                                                     String alias,
                                                     String tier)
                                              throws ApiException

Upload a New Certificate This operation can be used to upload a new certificate for an endpoint.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

certificate - The certificate that needs to be uploaded. (required)

alias - Alias for the certificate (required)

tier - api tier to which the certificate should be applied. (required)

Returns:

ClientCertMetadataDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

addAPIClientCertificateWithHttpInfo

public ApiResponse<ClientCertMetadataDTO> addAPIClientCertificateWithHttpInfo(String apiId,
                                                                              File certificate,
                                                                              String alias,
                                                                              String tier)
                                                                       throws ApiException

Upload a New Certificate This operation can be used to upload a new certificate for an endpoint.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

certificate - The certificate that needs to be uploaded. (required)

alias - Alias for the certificate (required)

tier - api tier to which the certificate should be applied. (required)

Returns:

ApiResponse<ClientCertMetadataDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

addAPIClientCertificateAsync

public okhttp3.Call addAPIClientCertificateAsync(String apiId,
                                                 File certificate,
                                                 String alias,
                                                 String tier,
                                                 ApiCallback<ClientCertMetadataDTO> _callback)
                                          throws ApiException

Upload a New Certificate (asynchronously) This operation can be used to upload a new certificate for an endpoint.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

certificate - The certificate that needs to be uploaded. (required)

alias - Alias for the certificate (required)

tier - api tier 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

deleteAPIClientCertificateByAliasCall

public okhttp3.Call deleteAPIClientCertificateByAliasCall(String alias,
                                                          String apiId,
                                                          ApiCallback _callback)
                                                   throws ApiException

Build call for deleteAPIClientCertificateByAlias

Parameters:

alias - The alias of the certificate that should be deleted. (required)

apiId - **API ID** consisting of the **UUID** of the API. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAPIClientCertificateByAlias

public void deleteAPIClientCertificateByAlias(String alias,
                                              String apiId)
                                       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)

apiId - **API ID** consisting of the **UUID** of the API. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAPIClientCertificateByAliasWithHttpInfo

public ApiResponse<Void> deleteAPIClientCertificateByAliasWithHttpInfo(String alias,
                                                                       String apiId)
                                                                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)

apiId - **API ID** consisting of the **UUID** of the API. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAPIClientCertificateByAliasAsync

public okhttp3.Call deleteAPIClientCertificateByAliasAsync(String alias,
                                                           String apiId,
                                                           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)

apiId - **API ID** consisting of the **UUID** of the API. (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

getAPIClientCertificateByAliasCall

public okhttp3.Call getAPIClientCertificateByAliasCall(String alias,
                                                       String apiId,
                                                       ApiCallback _callback)
                                                throws ApiException

Build call for getAPIClientCertificateByAlias

Parameters:

alias - (required)

apiId - **API ID** consisting of the **UUID** of the API. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAPIClientCertificateByAlias

public CertificateInfoDTO getAPIClientCertificateByAlias(String alias,
                                                         String apiId)
                                                  throws ApiException

Get the Certificate Information This operation can be used to get the information about a certificate.

Parameters:

alias - (required)

apiId - **API ID** consisting of the **UUID** of the API. (required)

Returns:

CertificateInfoDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIClientCertificateByAliasWithHttpInfo

public ApiResponse<CertificateInfoDTO> getAPIClientCertificateByAliasWithHttpInfo(String alias,
                                                                                  String apiId)
                                                                           throws ApiException

Get the Certificate Information This operation can be used to get the information about a certificate.

Parameters:

alias - (required)

apiId - **API ID** consisting of the **UUID** of the API. (required)

Returns:

ApiResponse<CertificateInfoDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIClientCertificateByAliasAsync

public okhttp3.Call getAPIClientCertificateByAliasAsync(String alias,
                                                        String apiId,
                                                        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)

apiId - **API ID** consisting of the **UUID** of the API. (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

getAPIClientCertificateContentByAliasCall

public okhttp3.Call getAPIClientCertificateContentByAliasCall(String apiId,
                                                              String alias,
                                                              ApiCallback _callback)
                                                       throws ApiException

Build call for getAPIClientCertificateContentByAlias

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

alias - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAPIClientCertificateContentByAlias

public void getAPIClientCertificateContentByAlias(String apiId,
                                                  String alias)
                                           throws ApiException

Download a Certificate This operation can be used to download a certificate which matches the given alias.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

alias - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIClientCertificateContentByAliasWithHttpInfo

public ApiResponse<Void> getAPIClientCertificateContentByAliasWithHttpInfo(String apiId,
                                                                           String alias)
                                                                    throws ApiException

Download a Certificate This operation can be used to download a certificate which matches the given alias.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

alias - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIClientCertificateContentByAliasAsync

public okhttp3.Call getAPIClientCertificateContentByAliasAsync(String apiId,
                                                               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:

apiId - **API ID** consisting of the **UUID** of the API. (required)

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

getAPIClientCertificatesCall

public okhttp3.Call getAPIClientCertificatesCall(String apiId,
                                                 Integer limit,
                                                 Integer offset,
                                                 String alias,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for getAPIClientCertificates

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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)

alias - Alias for the client certificate (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAPIClientCertificates

public ClientCertificatesDTO getAPIClientCertificates(String apiId,
                                                      Integer limit,
                                                      Integer offset,
                                                      String alias)
                                               throws ApiException

Retrieve/ Search Uploaded Client Certificates This operation can be used to retrieve and search the uploaded client certificates.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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)

alias - Alias for the client certificate (optional)

Returns:

ClientCertificatesDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIClientCertificatesWithHttpInfo

public ApiResponse<ClientCertificatesDTO> getAPIClientCertificatesWithHttpInfo(String apiId,
                                                                               Integer limit,
                                                                               Integer offset,
                                                                               String alias)
                                                                        throws ApiException

Retrieve/ Search Uploaded Client Certificates This operation can be used to retrieve and search the uploaded client certificates.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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)

alias - Alias for the client certificate (optional)

Returns:

ApiResponse<ClientCertificatesDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIClientCertificatesAsync

public okhttp3.Call getAPIClientCertificatesAsync(String apiId,
                                                  Integer limit,
                                                  Integer offset,
                                                  String alias,
                                                  ApiCallback<ClientCertificatesDTO> _callback)
                                           throws ApiException

Retrieve/ Search Uploaded Client Certificates (asynchronously) This operation can be used to retrieve and search the uploaded client certificates.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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)

alias - Alias for the client certificate (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

updateAPIClientCertificateByAliasCall

public okhttp3.Call updateAPIClientCertificateByAliasCall(String alias,
                                                          String apiId,
                                                          File certificate,
                                                          String tier,
                                                          ApiCallback _callback)
                                                   throws ApiException

Build call for updateAPIClientCertificateByAlias

Parameters:

alias - Alias for the certificate (required)

apiId - **API ID** consisting of the **UUID** of the API. (required)

certificate - The certificate that needs to be uploaded. (optional)

tier - The tier of the certificate (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateAPIClientCertificateByAlias

public ClientCertMetadataDTO updateAPIClientCertificateByAlias(String alias,
                                                               String apiId,
                                                               File certificate,
                                                               String tier)
                                                        throws ApiException

Update a Certificate This operation can be used to update an uploaded certificate.

Parameters:

alias - Alias for the certificate (required)

apiId - **API ID** consisting of the **UUID** of the API. (required)

certificate - The certificate that needs to be uploaded. (optional)

tier - The tier of the certificate (optional)

Returns:

ClientCertMetadataDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateAPIClientCertificateByAliasWithHttpInfo

public ApiResponse<ClientCertMetadataDTO> updateAPIClientCertificateByAliasWithHttpInfo(String alias,
                                                                                        String apiId,
                                                                                        File certificate,
                                                                                        String tier)
                                                                                 throws ApiException

Update a Certificate This operation can be used to update an uploaded certificate.

Parameters:

alias - Alias for the certificate (required)

apiId - **API ID** consisting of the **UUID** of the API. (required)

certificate - The certificate that needs to be uploaded. (optional)

tier - The tier of the certificate (optional)

Returns:

ApiResponse<ClientCertMetadataDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateAPIClientCertificateByAliasAsync

public okhttp3.Call updateAPIClientCertificateByAliasAsync(String alias,
                                                           String apiId,
                                                           File certificate,
                                                           String tier,
                                                           ApiCallback<ClientCertMetadataDTO> _callback)
                                                    throws ApiException

Update a Certificate (asynchronously) This operation can be used to update an uploaded certificate.

Parameters:

alias - Alias for the certificate (required)

apiId - **API ID** consisting of the **UUID** of the API. (required)

certificate - The certificate that needs to be uploaded. (optional)

tier - The tier of the certificate (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