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

Class SettingsApi

java.lang.Object

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

public class SettingsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SettingsApi()
SettingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
SettingsDTO	settingsGet() Retreive admin settings Retreive admin settings
com.squareup.okhttp.Call	settingsGetAsync(ApiCallback<SettingsDTO> callback) Retreive admin settings (asynchronously) Retreive admin settings
com.squareup.okhttp.Call	settingsGetCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for settingsGet
ApiResponse<SettingsDTO>	settingsGetWithHttpInfo() Retreive admin settings Retreive admin settings
ScopeSettingsDTO	settingsScopesScopeGet(String username, String scope) Retrieve scopes for a particular user This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter
com.squareup.okhttp.Call	settingsScopesScopeGetAsync(String username, String scope, ApiCallback<ScopeSettingsDTO> callback) Retrieve scopes for a particular user (asynchronously) This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter
com.squareup.okhttp.Call	settingsScopesScopeGetCall(String username, String scope, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for settingsScopesScopeGet
ApiResponse<ScopeSettingsDTO>	settingsScopesScopeGetWithHttpInfo(String username, String scope) Retrieve scopes for a particular user This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsApi

public SettingsApi()

SettingsApi

public SettingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

settingsGetCall

public com.squareup.okhttp.Call settingsGetCall(ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for settingsGet

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

settingsGet

public SettingsDTO settingsGet()
                        throws ApiException

Retreive admin settings Retreive admin settings

Returns:

SettingsDTO

Throws:

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

settingsGetWithHttpInfo

public ApiResponse<SettingsDTO> settingsGetWithHttpInfo()
                                                 throws ApiException

Retreive admin settings Retreive admin settings

Returns:

ApiResponse<SettingsDTO>

Throws:

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

settingsGetAsync

public com.squareup.okhttp.Call settingsGetAsync(ApiCallback<SettingsDTO> callback)
                                          throws ApiException

Retreive admin settings (asynchronously) Retreive admin settings

Parameters:

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

settingsScopesScopeGetCall

public com.squareup.okhttp.Call settingsScopesScopeGetCall(String username,
                                                           String scope,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for settingsScopesScopeGet

Parameters:

username - (required)

scope - scope name to be validated (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

settingsScopesScopeGet

public ScopeSettingsDTO settingsScopesScopeGet(String username,
                                               String scope)
                                        throws ApiException

Retrieve scopes for a particular user This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter

Parameters:

username - (required)

scope - scope name to be validated (required)

Returns:

ScopeSettingsDTO

Throws:

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

settingsScopesScopeGetWithHttpInfo

public ApiResponse<ScopeSettingsDTO> settingsScopesScopeGetWithHttpInfo(String username,
                                                                        String scope)
                                                                 throws ApiException

Retrieve scopes for a particular user This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter

Parameters:

username - (required)

scope - scope name to be validated (required)

Returns:

ApiResponse<ScopeSettingsDTO>

Throws:

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

settingsScopesScopeGetAsync

public com.squareup.okhttp.Call settingsScopesScopeGetAsync(String username,
                                                            String scope,
                                                            ApiCallback<ScopeSettingsDTO> callback)
                                                     throws ApiException

Retrieve scopes for a particular user (asynchronously) This operation will return the scope list of particular user In order to get it, we need to pass the userId as a query parameter

Parameters:

username - (required)

scope - scope name to be validated (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