org.apache.ambari.server.events

Class MaintenanceModeEvent

java.lang.Object

org.apache.ambari.server.events.AmbariEvent

org.apache.ambari.server.events.MaintenanceModeEvent

public class MaintenanceModeEvent
extends AmbariEvent

The MaintenanceModeEvent is used to capture a host/service/component maintenance mode change and broadcast it to the system.

Although there are several different states aside from on & off in MaintenanceState, this event should handle explicit on or off state changes. This event should not be used for implied state changes, such as when a component goes into implied maintenance mode as a result of its host's maintenance mode being explicitely invoked.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ambari.server.events.AmbariEvent

AmbariEvent.AmbariEventType

Field Summary

Fields inherited from class org.apache.ambari.server.events.AmbariEvent

m_eventType

Constructor Summary

Constructors

Constructor and Description
MaintenanceModeEvent(MaintenanceState state, long clusterId, Host host) Constructor.
MaintenanceModeEvent(MaintenanceState state, Service service) Constructor.
MaintenanceModeEvent(MaintenanceState state, ServiceComponentHost serviceComponentHost) Constructor.

Method Summary

Modifier and Type	Method and Description
long	getClusterId() Gets the cluster id for the host, service or component that had the direct maintenance mode event,.
Host	getHost() Gets the host that had the direct maintenance mode event, or null if the event was not directly on a host.
MaintenanceState	getMaintenanceState() Gets the new maintenance state for the service/host/component.
Service	getService() Gets the service that had the direct maintenance mode event, or null if the event was not directly on a service.
ServiceComponentHost	getServiceComponentHost() Gets the component that had the direct maintenance mode event, or null if the event was not directly on a component.
String	toString()

Methods inherited from class org.apache.ambari.server.events.AmbariEvent

getType

Methods inherited from class java.lang.Object

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

Constructor Detail

MaintenanceModeEvent

public MaintenanceModeEvent(MaintenanceState state,
                            Service service)

Constructor.

Parameters:

state - the new state (not null).

service - the service that changed maintenance state (not null)).

MaintenanceModeEvent

public MaintenanceModeEvent(MaintenanceState state,
                            long clusterId,
                            Host host)

Constructor.

Parameters:

state - the new state (not null).

clusterId - the cluster to which the host belongs to (not -1).

host - the host that changed maintenance state (not null)).

MaintenanceModeEvent

public MaintenanceModeEvent(MaintenanceState state,
                            ServiceComponentHost serviceComponentHost)

Constructor.

Parameters:

state - the new state (not null).

serviceComponentHost - the component that changed maintenance state (not null)).

Method Detail

getService

public Service getService()

Gets the service that had the direct maintenance mode event, or null if the event was not directly on a service.

Returns:

the service or null

getHost

public Host getHost()

Gets the host that had the direct maintenance mode event, or null if the event was not directly on a host.

Returns:

the host or null

getServiceComponentHost

public ServiceComponentHost getServiceComponentHost()

Gets the component that had the direct maintenance mode event, or null if the event was not directly on a component.

Returns:

the component or null

getMaintenanceState

public MaintenanceState getMaintenanceState()

Gets the new maintenance state for the service/host/component.

Returns:

the new maintenance state (never null).

getClusterId

public long getClusterId()

Gets the cluster id for the host, service or component that had the direct maintenance mode event,.

Returns:

the cluster id

toString

public String toString()

Overrides:

toString in class AmbariEvent