org.apache.ambari.server.controller

Class MaintenanceStateHelper

java.lang.Object

org.apache.ambari.server.controller.MaintenanceStateHelper

public class MaintenanceStateHelper
extends Object

Used to help manage maintenance state checks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MaintenanceStateHelper.HostPredicate The MaintenanceStateHelper.HostPredicate interaface is used as a way to pass a custom implementation into one of the many isOperationAllowed(org.apache.ambari.server.controller.spi.Resource.Type, Service) methods.

Constructor Summary

Constructors

Constructor and Description
MaintenanceStateHelper(com.google.inject.Injector injector)

Method Summary

Modifier and Type	Method and Description
Set<String>	filterHostsInMaintenanceState(Set<String> candidateHosts, MaintenanceStateHelper.HostPredicate condition) Removes from a set all hosts that match a given condition.
MaintenanceState	getEffectiveState(long clusterId, Alert alert) Gets the effective maintenance state for a given alert.
MaintenanceState	getEffectiveState(ServiceComponentHost sch) Gets the effective state for a HostComponent
MaintenanceState	getEffectiveState(ServiceComponentHost sch, Host host) Get effective state of HostComponent
Set<Map<String,String>>	getMaintenanceHostComponents(Clusters clusters, Cluster cluster)
Resource.Type	guessOperationLevel(RequestResourceFilter filter) Fallback logic for guessing operation level from request resource filter.
boolean	isOperationAllowed(Cluster cluster, RequestOperationLevel levelObj, RequestResourceFilter reqFilter, String serviceName, String componentName, String hostname)
boolean	isOperationAllowed(Host host, long clusterId, Resource.Type level)
boolean	isOperationAllowed(Resource.Type level, Service service)
boolean	isOperationAllowed(Resource.Type operationLevel, ServiceComponentHost sch) Determine based on the requesting Resource level and the state of the operand whether to allow operations on it.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaintenanceStateHelper

@Inject
public MaintenanceStateHelper(com.google.inject.Injector injector)

Method Detail

isOperationAllowed

public boolean isOperationAllowed(Cluster cluster,
                                  RequestOperationLevel levelObj,
                                  RequestResourceFilter reqFilter,
                                  String serviceName,
                                  String componentName,
                                  String hostname)
                           throws org.apache.ambari.server.AmbariException

Parameters:

cluster - cluster for request

levelObj - operation level (can be null)

reqFilter - request resource filter for operation (can't be null)

serviceName - service name (can be null)

componentName - component name (can be null)

hostname - host name (can't be null)

Returns:

true if operation may be performed on a given target (based on target's maintenance status).

Throws:

org.apache.ambari.server.AmbariException

isOperationAllowed

public boolean isOperationAllowed(Resource.Type level,
                                  Service service)
                           throws org.apache.ambari.server.AmbariException

Parameters:

level - operation level

service - the service

Returns:

true if operation may be performed on a given target (based on target's maintenance status).

Throws:

org.apache.ambari.server.AmbariException

isOperationAllowed

public boolean isOperationAllowed(Host host,
                                  long clusterId,
                                  Resource.Type level)
                           throws org.apache.ambari.server.AmbariException

Parameters:

host - the service

clusterId - cluster the host belongs to

level - operation level for request

Returns:

true if operation may be performed on a given target (based on target's maintenance status).

Throws:

org.apache.ambari.server.AmbariException

getEffectiveState

public MaintenanceState getEffectiveState(ServiceComponentHost sch,
                                          Host host)
                                   throws org.apache.ambari.server.AmbariException

Get effective state of HostComponent

Parameters:

sch - the host component

host - the host

Returns:

the maintenance state

Throws:

org.apache.ambari.server.AmbariException

getEffectiveState

public MaintenanceState getEffectiveState(ServiceComponentHost sch)
                                   throws org.apache.ambari.server.AmbariException

Gets the effective state for a HostComponent

Parameters:

sch - the host component

Returns:

the maintenance state

Throws:

org.apache.ambari.server.AmbariException

getEffectiveState

public MaintenanceState getEffectiveState(long clusterId,
                                          Alert alert)
                                   throws org.apache.ambari.server.AmbariException

Gets the effective maintenance state for a given alert. This will determine whether the alert needs to report that it is in maintenance mode.

Parameters:

clusterId - the ID of the cluster for the alert.

alert - the alert (not null).

Returns:

MaintenanceState.OFF if the host/service/component all report they are not in maintenance mode; MaintenanceState.ON otherwise.

Throws:

org.apache.ambari.server.AmbariException

getMaintenanceHostComponents

public Set<Map<String,String>> getMaintenanceHostComponents(Clusters clusters,
                                                            Cluster cluster)
                                                     throws org.apache.ambari.server.AmbariException

Parameters:

clusters - the collection of clusters

cluster - the specific cluster to check

Returns:

a property map of all host components that are in a maintenance state (either MaintenanceState.ON or MaintenanceState.IMPLIED_FROM_HOST or MaintenanceState.IMPLIED_FROM_SERVICE or MaintenanceState.IMPLIED_FROM_SERVICE_AND_HOST)

Throws:

org.apache.ambari.server.AmbariException

isOperationAllowed

public boolean isOperationAllowed(Resource.Type operationLevel,
                                  ServiceComponentHost sch)
                           throws org.apache.ambari.server.AmbariException

Determine based on the requesting Resource level and the state of the operand whether to allow operations on it.

Parameters:

operationLevel - Request Source: {CLUSTER, SERVICE, HOSTCOMPONENT, HOST}

sch - HostComponent which is the operand of the operation

Returns:

Throws:

org.apache.ambari.server.AmbariException

guessOperationLevel

public Resource.Type guessOperationLevel(RequestResourceFilter filter)

Fallback logic for guessing operation level from request resource filter. It is used when operation level is not defined explicitly.

filterHostsInMaintenanceState

public Set<String> filterHostsInMaintenanceState(Set<String> candidateHosts,
                                                 MaintenanceStateHelper.HostPredicate condition)
                                          throws org.apache.ambari.server.AmbariException

Removes from a set all hosts that match a given condition.

Parameters:

candidateHosts - source set that should to be modified

condition - condition

Returns:

all hosts that have been removed from a candidateHosts

Throws:

org.apache.ambari.server.AmbariException