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

Class RolesApi

java.lang.Object

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

public class RolesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RolesApi()
RolesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	validateSystemRole(String roleId) Check given role name is already exist Using this operation, user can check a given role name exists or not.
com.squareup.okhttp.Call	validateSystemRoleAsync(String roleId, ApiCallback<Void> callback) Check given role name is already exist (asynchronously) Using this operation, user can check a given role name exists or not.
com.squareup.okhttp.Call	validateSystemRoleCall(String roleId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validateSystemRole
ApiResponse<Void>	validateSystemRoleWithHttpInfo(String roleId) Check given role name is already exist Using this operation, user can check a given role name exists or not.
void	validateUserRole(String roleId) Validate whether the logged-in user has the given role Using this operation, logged-in user can check whether he has given role.
com.squareup.okhttp.Call	validateUserRoleAsync(String roleId, ApiCallback<Void> callback) Validate whether the logged-in user has the given role (asynchronously) Using this operation, logged-in user can check whether he has given role.
com.squareup.okhttp.Call	validateUserRoleCall(String roleId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validateUserRole
ApiResponse<Void>	validateUserRoleWithHttpInfo(String roleId) Validate whether the logged-in user has the given role Using this operation, logged-in user can check whether he has given role.

Methods inherited from class java.lang.Object

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

Constructor Detail

RolesApi

public RolesApi()

RolesApi

public RolesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

validateSystemRoleCall

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

Build call for validateSystemRole

Parameters:

roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

validateSystemRole

public void validateSystemRole(String roleId)
                        throws ApiException

Check given role name is already exist Using this operation, user can check a given role name exists or not.

Parameters:

roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)

Throws:

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

validateSystemRoleWithHttpInfo

public ApiResponse<Void> validateSystemRoleWithHttpInfo(String roleId)
                                                 throws ApiException

Check given role name is already exist Using this operation, user can check a given role name exists or not.

Parameters:

roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)

Returns:

ApiResponse<Void>

Throws:

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

validateSystemRoleAsync

public com.squareup.okhttp.Call validateSystemRoleAsync(String roleId,
                                                        ApiCallback<Void> callback)
                                                 throws ApiException

Check given role name is already exist (asynchronously) Using this operation, user can check a given role name exists or not.

Parameters:

roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (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

validateUserRoleCall

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

Build call for validateUserRole

Parameters:

roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

validateUserRole

public void validateUserRole(String roleId)
                      throws ApiException

Validate whether the logged-in user has the given role Using this operation, logged-in user can check whether he has given role.

Parameters:

roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)

Throws:

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

validateUserRoleWithHttpInfo

public ApiResponse<Void> validateUserRoleWithHttpInfo(String roleId)
                                               throws ApiException

Validate whether the logged-in user has the given role Using this operation, logged-in user can check whether he has given role.

Parameters:

roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (required)

Returns:

ApiResponse<Void>

Throws:

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

validateUserRoleAsync

public com.squareup.okhttp.Call validateUserRoleAsync(String roleId,
                                                      ApiCallback<Void> callback)
                                               throws ApiException

Validate whether the logged-in user has the given role (asynchronously) Using this operation, logged-in user can check whether he has given role.

Parameters:

roleId - The Base 64 URL encoded role name with domain. If the given role is in secondary user-store, role ID should be derived as Base64URLEncode({user-store-name}/{role-name}). If the given role is in PRIMARY user-store, role ID can be derived as Base64URLEncode(role-name) (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