org.apache.ambari.server.api.services

Class RoleAuthorizationService

java.lang.Object

org.apache.ambari.server.api.services.BaseService

org.apache.ambari.server.api.services.RoleAuthorizationService

public class RoleAuthorizationService
extends BaseService

RoleAuthorizationService is a read-only service responsible for role authorization resource requests.

The result sets returned by this service are either the full set of available authorizations or those related to a particular permission.

Field Summary

Fields inherited from class org.apache.ambari.server.api.services.BaseService

DATA_TYPE_INT, DATA_TYPE_STRING, DEFAULT_FROM, DEFAULT_PAGE_SIZE, FIELDS_SEPARATOR, MEDIA_TYPE_TEXT_CSV_TYPE, MSG_CLUSTER_NOT_FOUND, MSG_CLUSTER_OR_HOST_NOT_FOUND, MSG_INVALID_ARGUMENTS, MSG_INVALID_REQUEST, MSG_NOT_AUTHENTICATED, MSG_PERMISSION_DENIED, MSG_REQUEST_ACCEPTED, MSG_RESOURCE_ALREADY_EXISTS, MSG_RESOURCE_NOT_FOUND, MSG_SERVER_ERROR, MSG_SUCCESSFUL_OPERATION, MSG_VIEW_NOT_FOUND, PARAM_TYPE_BODY, PARAM_TYPE_QUERY, QUERY_FIELDS, QUERY_FILTER_DESCRIPTION, QUERY_FROM, QUERY_FROM_DESCRIPTION, QUERY_FROM_VALUES, QUERY_PAGE_SIZE, QUERY_PAGE_SIZE_DESCRIPTION, QUERY_PREDICATE, QUERY_PREDICATE_DESCRIPTION, QUERY_SORT, QUERY_SORT_DESCRIPTION, QUERY_TO, QUERY_TO_DESCRIPTION, QUERY_TO_TYPE, QUERY_TO_VALUES, requestAuditLogger, RESPONSE_CONTAINER_LIST

Constructor Summary

Constructors

Constructor and Description
RoleAuthorizationService() Constructs a new RoleAuthorizationService that is not linked to any role (or permission)
RoleAuthorizationService(String permissionId) Constructs a new RoleAuthorizationService that is linked to the specified permission

Method Summary

Modifier and Type	Method and Description
protected ResourceInstance	createAuthorizationResource(String authorizationId) Create an authorization resource.
javax.ws.rs.core.Response	getAuthorization(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String authorizationId) Handles: GET /permissions/{permission_id}/authorizations/{authorization_id} Get a specific authorization, potentially limited to the set of authorizations for a permission if this RoleAuthorizationService is linked ot a particular permission.
javax.ws.rs.core.Response	getAuthorizations(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: GET /permissions/{permission_id}/authorizations Get all authorizations for the relative permission, or all if this RoleAuthorizationService is not linked to a particular permission.

Methods inherited from class org.apache.ambari.server.api.services.BaseService

createResource, getBodyParser, getResultSerializer, getResultSerializer, handleRequest, handleRequest, init

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleAuthorizationService

public RoleAuthorizationService()

Constructs a new RoleAuthorizationService that is not linked to any role (or permission)

RoleAuthorizationService

public RoleAuthorizationService(String permissionId)

Constructs a new RoleAuthorizationService that is linked to the specified permission

Parameters:

permissionId - the permission id of a permission (or role)

Method Detail

getAuthorizations

public javax.ws.rs.core.Response getAuthorizations(@Context
                                                   javax.ws.rs.core.HttpHeaders headers,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo ui)

Handles: GET /permissions/{permission_id}/authorizations Get all authorizations for the relative permission, or all if this RoleAuthorizationService is not linked to a particular permission.

Parameters:

headers - http headers

ui - uri info

Returns:

authorizations collection resource representation

getAuthorization

public javax.ws.rs.core.Response getAuthorization(@Context
                                                  javax.ws.rs.core.HttpHeaders headers,
                                                  @Context
                                                  javax.ws.rs.core.UriInfo ui,
                                                  String authorizationId)

Handles: GET /permissions/{permission_id}/authorizations/{authorization_id} Get a specific authorization, potentially limited to the set of authorizations for a permission if this RoleAuthorizationService is linked ot a particular permission.

Parameters:

headers - http headers

ui - uri info

authorizationId - authorization ID

Returns:

authorization instance representation

createAuthorizationResource

protected ResourceInstance createAuthorizationResource(String authorizationId)

Create an authorization resource.

Parameters:

authorizationId - authorization id

Returns:

an authorization resource instance