Package org.wso2.am.integration.clients.admin.api

Class ApplicationCollectionApi

java.lang.Object

org.wso2.am.integration.clients.admin.api.ApplicationCollectionApi

public class ApplicationCollectionApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ApplicationCollectionApi()
ApplicationCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApplicationListDTO	applicationsGet(String user, Integer limit, Integer offset, String accept, String ifNoneMatch, String name, String tenantDomain)	Retrieve/Search Applications This operation can be used to retrieve list of applications owned by the given user, If no user is provided, the applications owned by the user associated with the provided access token will be returned.
okhttp3.Call	applicationsGetAsync(String user, Integer limit, Integer offset, String accept, String ifNoneMatch, String name, String tenantDomain, ApiCallback<ApplicationListDTO> _callback)	Retrieve/Search Applications (asynchronously) This operation can be used to retrieve list of applications owned by the given user, If no user is provided, the applications owned by the user associated with the provided access token will be returned.
okhttp3.Call	applicationsGetCall(String user, Integer limit, Integer offset, String accept, String ifNoneMatch, String name, String tenantDomain, ApiCallback _callback)	Build call for applicationsGet
ApiResponse<ApplicationListDTO>	applicationsGetWithHttpInfo(String user, Integer limit, Integer offset, String accept, String ifNoneMatch, String name, String tenantDomain)	Retrieve/Search Applications This operation can be used to retrieve list of applications owned by the given user, If no user is provided, the applications owned by the user associated with the provided access token will be returned.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationCollectionApi

public ApplicationCollectionApi()

ApplicationCollectionApi

public ApplicationCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

applicationsGetCall

public okhttp3.Call applicationsGetCall(String user,
                                        Integer limit,
                                        Integer offset,
                                        String accept,
                                        String ifNoneMatch,
                                        String name,
                                        String tenantDomain,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for applicationsGet

Parameters:

user - username of the application creator (optional)

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)

accept - Media types acceptable for the response. Default is application/json. (optional, default to "application/json")

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (optional)

name - Application Name (optional)

tenantDomain - Tenant domain of the applications to get. This has to be specified only if it is required to get applications of a tenant other than the requester's tenant. So, if not specified, the default will be set as the requester's tenant domain. This cross tenant Application access is allowed only for super tenant admin users **only at a migration process**. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

applicationsGet

public ApplicationListDTO applicationsGet(String user,
                                          Integer limit,
                                          Integer offset,
                                          String accept,
                                          String ifNoneMatch,
                                          String name,
                                          String tenantDomain)
                                   throws ApiException

Retrieve/Search Applications This operation can be used to retrieve list of applications owned by the given user, If no user is provided, the applications owned by the user associated with the provided access token will be returned.

Parameters:

user - username of the application creator (optional)

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)

accept - Media types acceptable for the response. Default is application/json. (optional, default to "application/json")

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (optional)

name - Application Name (optional)

tenantDomain - Tenant domain of the applications to get. This has to be specified only if it is required to get applications of a tenant other than the requester's tenant. So, if not specified, the default will be set as the requester's tenant domain. This cross tenant Application access is allowed only for super tenant admin users **only at a migration process**. (optional)

Returns:

ApplicationListDTO

Throws:

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

applicationsGetWithHttpInfo

public ApiResponse<ApplicationListDTO> applicationsGetWithHttpInfo(String user,
                                                                   Integer limit,
                                                                   Integer offset,
                                                                   String accept,
                                                                   String ifNoneMatch,
                                                                   String name,
                                                                   String tenantDomain)
                                                            throws ApiException

Retrieve/Search Applications This operation can be used to retrieve list of applications owned by the given user, If no user is provided, the applications owned by the user associated with the provided access token will be returned.

Parameters:

user - username of the application creator (optional)

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)

accept - Media types acceptable for the response. Default is application/json. (optional, default to "application/json")

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (optional)

name - Application Name (optional)

tenantDomain - Tenant domain of the applications to get. This has to be specified only if it is required to get applications of a tenant other than the requester's tenant. So, if not specified, the default will be set as the requester's tenant domain. This cross tenant Application access is allowed only for super tenant admin users **only at a migration process**. (optional)

Returns:

ApiResponse<ApplicationListDTO>

Throws:

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

applicationsGetAsync

public okhttp3.Call applicationsGetAsync(String user,
                                         Integer limit,
                                         Integer offset,
                                         String accept,
                                         String ifNoneMatch,
                                         String name,
                                         String tenantDomain,
                                         ApiCallback<ApplicationListDTO> _callback)
                                  throws ApiException

Retrieve/Search Applications (asynchronously) This operation can be used to retrieve list of applications owned by the given user, If no user is provided, the applications owned by the user associated with the provided access token will be returned.

Parameters:

user - username of the application creator (optional)

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)

accept - Media types acceptable for the response. Default is application/json. (optional, default to "application/json")

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). (optional)

name - Application Name (optional)

tenantDomain - Tenant domain of the applications to get. This has to be specified only if it is required to get applications of a tenant other than the requester's tenant. So, if not specified, the default will be set as the requester's tenant domain. This cross tenant Application access is allowed only for super tenant admin users **only at a migration process**. (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