org.apache.ambari.server.controller.internal

Class AlertResourceProviderUtils

java.lang.Object

org.apache.ambari.server.controller.internal.AlertResourceProviderUtils

public class AlertResourceProviderUtils
extends Object

AlertResourceProviderUtils provides utility methods used to help perform tasks within alert-specific resource providers.

Constructor Summary

Constructors

Constructor and Description
AlertResourceProviderUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	hasAuthorization(String serviceName, Long clusterResourceId, Set<RoleAuthorization> clusterLevelAuthorizations, Set<RoleAuthorization> serviceLevelAuthorizations) Tests if the authenticated user is authorized to for either service- or cluster-level access to alert data.
static boolean	hasViewAuthorization(AlertGroupEntity entity, Long clusterResourceId) Tests if the authenticated user is authorized to view the requested alert data
static boolean	hasViewAuthorization(String serviceName, Long clusterResourceId) Tests if the authenticated user is authorized to view service- or cluster-level alert data
static void	verifyAuthorization(AlertDefinitionEntity entity, Set<RoleAuthorization> clusterLevelAuthorizations, Set<RoleAuthorization> serviceLevelAuthorizations, String operation) Tests if the authenticated user is authorized to for either service- or cluster-level access to alert data.
static void	verifyAuthorization(String serviceName, Long clusterResourceId, Set<RoleAuthorization> clusterLevelAuthorizations, Set<RoleAuthorization> serviceLevelAuthorizations, String operation) Tests if the authenticated user is authorized to for either service- or cluster-level access to alert data.
static void	verifyExecuteAuthorization(AlertDefinitionEntity entity) Tests if the authenticated user is authorized to execute service- or cluster-level alert data.
static void	verifyExecuteAuthorization(String serviceName, Long clusterResourceId) Tests if the authenticated user is authorized to execute service- or cluster-level alert data.
static void	verifyManageAuthorization(AlertDefinitionEntity entity) Tests if the authenticated user is authorized to manage service- or cluster-level alert data.
static void	verifyManageAuthorization(AlertGroupEntity entity, Long clusterResourceId) Tests if the authenticated user is authorized to manage service- or cluster-level alert data.
static void	verifyManageAuthorization(String serviceName, Long clusterResourceId) Tests if the authenticated user is authorized to manage service- or cluster-level alert data.
static void	verifyToggleAuthorization(AlertDefinitionEntity entity) Tests if the authenticated user is authorized to toggle service- or cluster-level alert data.
static void	verifyToggleAuthorization(String serviceName, Long clusterResourceId) Tests if the authenticated user is authorized to toggle service- or cluster-level alert data.
static void	verifyViewAuthorization(AlertCurrentEntity entity) Tests if the authenticated user is authorized to view service- or cluster-level alert data.
static void	verifyViewAuthorization(AlertDefinitionEntity entity) Tests if the authenticated user is authorized to view service- or cluster-level alert data.
static void	verifyViewAuthorization(AlertGroupEntity entity, Long clusterResourceId) Tests if the authenticated user is authorized to view service- or cluster-level alert data.
static void	verifyViewAuthorization(AlertHistoryEntity entity) Tests if the authenticated user is authorized to view service- or cluster-level alert data.
static void	verifyViewAuthorization(String serviceName, Long clusterResourceId) Tests if the authenticated user is authorized to view service- or cluster-level alert data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertResourceProviderUtils

public AlertResourceProviderUtils()

Method Detail

hasViewAuthorization

public static boolean hasViewAuthorization(AlertGroupEntity entity,
                                           Long clusterResourceId)

Tests if the authenticated user is authorized to view the requested alert data

Parameters:

entity - an AlertGroupEntity

clusterResourceId - the resource id of the relevant cluster

Returns:

true if the authenticated user is authorized; otherwise false

hasViewAuthorization

public static boolean hasViewAuthorization(String serviceName,
                                           Long clusterResourceId)

Tests if the authenticated user is authorized to view service- or cluster-level alert data

Parameters:

serviceName - the name of the relevant service - null or empty indicates a cluster-level alert

clusterResourceId - the resource id of the relevant cluster

Returns:

true if the authenticated user is authorized; otherwise false

verifyViewAuthorization

public static void verifyViewAuthorization(AlertCurrentEntity entity)
                                    throws AuthorizationException

Tests if the authenticated user is authorized to view service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

entity - an AlertCurrentEntity

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyViewAuthorization

public static void verifyViewAuthorization(AlertHistoryEntity entity)
                                    throws AuthorizationException

Tests if the authenticated user is authorized to view service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

entity - an AlertHistoryEntity

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyViewAuthorization

public static void verifyViewAuthorization(AlertGroupEntity entity,
                                           Long clusterResourceId)
                                    throws AuthorizationException

Tests if the authenticated user is authorized to view service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

entity - an AlertGroupEntity

clusterResourceId - the resource id of the relevant cluster

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyViewAuthorization

public static void verifyViewAuthorization(AlertDefinitionEntity entity)
                                    throws AuthorizationException

Tests if the authenticated user is authorized to view service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

entity - an AlertDefinitionEntity

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyViewAuthorization

public static void verifyViewAuthorization(String serviceName,
                                           Long clusterResourceId)
                                    throws AuthorizationException

Tests if the authenticated user is authorized to view service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

serviceName - the name of the relevant service - null or empty indicates a cluster-level alert

clusterResourceId - the resource id of the relevant cluster

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyExecuteAuthorization

public static void verifyExecuteAuthorization(AlertDefinitionEntity entity)
                                       throws AuthorizationException

Tests if the authenticated user is authorized to execute service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

entity - an AlertDefinitionEntity

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyExecuteAuthorization

public static void verifyExecuteAuthorization(String serviceName,
                                              Long clusterResourceId)
                                       throws AuthorizationException

Tests if the authenticated user is authorized to execute service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

serviceName - the name of the relevant service - null or empty indicates a cluster-level alert

clusterResourceId - the resource id of the relevant cluster

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyToggleAuthorization

public static void verifyToggleAuthorization(AlertDefinitionEntity entity)
                                      throws AuthorizationException

Tests if the authenticated user is authorized to toggle service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

entity - an AlertDefinitionEntity

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyToggleAuthorization

public static void verifyToggleAuthorization(String serviceName,
                                             Long clusterResourceId)
                                      throws AuthorizationException

Tests if the authenticated user is authorized to toggle service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

serviceName - the name of the relevant service - null or empty indicates a cluster-level alert

clusterResourceId - the resource id of the relevant cluster

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyManageAuthorization

public static void verifyManageAuthorization(AlertGroupEntity entity,
                                             Long clusterResourceId)
                                      throws AuthorizationException

Tests if the authenticated user is authorized to manage service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

entity - an AlertGroupEntity

clusterResourceId - the resource id of the relevant cluster

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyManageAuthorization

public static void verifyManageAuthorization(AlertDefinitionEntity entity)
                                      throws AuthorizationException

Tests if the authenticated user is authorized to manage service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

entity - an AlertDefinitionEntity

Throws:

AuthorizationException - if the authenticated user is not authorized

verifyManageAuthorization

public static void verifyManageAuthorization(String serviceName,
                                             Long clusterResourceId)
                                      throws AuthorizationException

Tests if the authenticated user is authorized to manage service- or cluster-level alert data. An authorization failure results in a thrown AuthorizationException.

Parameters:

serviceName - the name of the relevant service - null or empty indicates a cluster-level alert

clusterResourceId - the resource id of the relevant cluster

Throws:

AuthorizationException - if the authenticated user is not authorized

hasAuthorization

public static boolean hasAuthorization(String serviceName,
                                       Long clusterResourceId,
                                       Set<RoleAuthorization> clusterLevelAuthorizations,
                                       Set<RoleAuthorization> serviceLevelAuthorizations)

Tests if the authenticated user is authorized to for either service- or cluster-level access to alert data.

If the service name is null or empty, the alert is considered to be a cluster-level alert, else it is considered to be a service-level alert.

If the clusterResourceId is null, no cluster is assume and the alert is considered to be an Ambari-level alert.

Parameters:

serviceName - the name of the relevant service - null or empty indicates a cluster-level alert

clusterResourceId - the resource id of the relevant cluster

clusterLevelAuthorizations - the set of cluster-level authorizations to check for

serviceLevelAuthorizations - the set of service-level authorizations to check for

Returns:

true if the authenticated user is authorized; otherwise false

verifyAuthorization

public static void verifyAuthorization(AlertDefinitionEntity entity,
                                       Set<RoleAuthorization> clusterLevelAuthorizations,
                                       Set<RoleAuthorization> serviceLevelAuthorizations,
                                       String operation)
                                throws AuthorizationException

Tests if the authenticated user is authorized to for either service- or cluster-level access to alert data. An authorization failure results in a thrown AuthorizationException.

If the service name from the AlertDefinitionEntity is null or empty, the alert is considered to be a cluster-level alert, else it is considered to be a service-level alert.

Parameters:

entity - an AlertDefinitionEntity

clusterLevelAuthorizations - the set of cluster-level authorizations to check for

serviceLevelAuthorizations - the set of service-level authorizations to check for

operation - the name of the operation being tested for (used in error and logging messages)

Throws:

AuthorizationException - if the authenticated user is not authorized

See Also:

verifyAuthorization(String, Long, Set, Set, String)

verifyAuthorization

public static void verifyAuthorization(String serviceName,
                                       Long clusterResourceId,
                                       Set<RoleAuthorization> clusterLevelAuthorizations,
                                       Set<RoleAuthorization> serviceLevelAuthorizations,
                                       String operation)
                                throws AuthorizationException

Tests if the authenticated user is authorized to for either service- or cluster-level access to alert data. An authorization failure results in a thrown AuthorizationException.

If the service name from the AlertDefinitionEntity is null or empty, the alert is considered to be a cluster-level alert, else it is considered to be a service-level alert.

Parameters:

serviceName - the name of the relevant service - null or empty indicates a cluster-level alert

clusterResourceId - the resource id of the relevant cluster

clusterLevelAuthorizations - the set of cluster-level authorizations to check for

serviceLevelAuthorizations - the set of service-level authorizations to check for

operation - the name of the operation being tested for (used in error and logging messages)

Throws:

AuthorizationException - if the authenticated user is not authorized