org.apache.hadoop.yarn.server.resourcemanager

Class AdminService

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.resourcemanager.AdminService

All Implemented Interfaces:

Closeable, AutoCloseable, Service, GetUserMappingsProtocol, ResourceManagerAdministrationProtocol

public class AdminService
extends AbstractService
implements ResourceManagerAdministrationProtocol

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

Service.STATE

Field Summary

Fields inherited from interface org.apache.hadoop.tools.GetUserMappingsProtocol

versionID

Constructor Summary

Constructors

Constructor and Description
AdminService(Configuration conf, ResourceScheduler scheduler, RMContext rmContext, NodesListManager nodesListManager, ClientRMService clientRMService, ApplicationMasterService applicationMasterService, ResourceTrackerService resourceTrackerService)

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getGroupsForUser(String user) Get the groups which are mapped to the given user.
RefreshAdminAclsResponse	refreshAdminAcls(RefreshAdminAclsRequest request)
RefreshNodesResponse	refreshNodes(RefreshNodesRequest request)
RefreshQueuesResponse	refreshQueues(RefreshQueuesRequest request)
RefreshServiceAclsResponse	refreshServiceAcls(RefreshServiceAclsRequest request)
RefreshSuperUserGroupsConfigurationResponse	refreshSuperUserGroupsConfiguration(RefreshSuperUserGroupsConfigurationRequest request)
RefreshUserToGroupsMappingsResponse	refreshUserToGroupsMappings(RefreshUserToGroupsMappingsRequest request)
void	serviceInit(Configuration conf) All initialization code needed by a service.
protected void	serviceStart() Actions called during the INITED to STARTED transition.
protected void	serviceStop() Actions called during the transition to the STOPPED state.

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminService

public AdminService(Configuration conf,
            ResourceScheduler scheduler,
            RMContext rmContext,
            NodesListManager nodesListManager,
            ClientRMService clientRMService,
            ApplicationMasterService applicationMasterService,
            ResourceTrackerService resourceTrackerService)

Method Detail

serviceInit

public void serviceInit(Configuration conf)
                 throws Exception

Description copied from class: AbstractService

All initialization code needed by a service. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.init(Configuration) prevents re-entrancy. The base implementation checks to see if the subclass has created a new configuration instance, and if so, updates the base class value

Overrides:

serviceInit in class AbstractService

Parameters:

conf - configuration

Throws:

Exception - on a failure -these will be caught, possibly wrapped, and wil; trigger a service stop

serviceStart

protected void serviceStart()
                     throws Exception

Description copied from class: AbstractService

Actions called during the INITED to STARTED transition. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.start() prevents re-entrancy.

Overrides:

serviceStart in class AbstractService

Throws:

Exception - if needed -these will be caught, wrapped, and trigger a service stop

serviceStop

protected void serviceStop()
                    throws Exception

Description copied from class: AbstractService

Actions called during the transition to the STOPPED state. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.stop() prevents re-entrancy. Implementations MUST write this to be robust against failures, including checks for null references -and for the first failure to not stop other attempts to shut down parts of the service.

Overrides:

serviceStop in class AbstractService

Throws:

Exception - if needed -these will be caught and logged.

refreshQueues

public RefreshQueuesResponse refreshQueues(RefreshQueuesRequest request)
                                    throws YarnException

Specified by:

refreshQueues in interface ResourceManagerAdministrationProtocol

Throws:

YarnException

refreshNodes

public RefreshNodesResponse refreshNodes(RefreshNodesRequest request)
                                  throws YarnException

Specified by:

refreshNodes in interface ResourceManagerAdministrationProtocol

Throws:

YarnException

refreshSuperUserGroupsConfiguration

public RefreshSuperUserGroupsConfigurationResponse refreshSuperUserGroupsConfiguration(RefreshSuperUserGroupsConfigurationRequest request)
                                                                                throws YarnException

Specified by:

refreshSuperUserGroupsConfiguration in interface ResourceManagerAdministrationProtocol

Throws:

YarnException

refreshUserToGroupsMappings

public RefreshUserToGroupsMappingsResponse refreshUserToGroupsMappings(RefreshUserToGroupsMappingsRequest request)
                                                                throws YarnException

Specified by:

refreshUserToGroupsMappings in interface ResourceManagerAdministrationProtocol

Throws:

YarnException

refreshAdminAcls

public RefreshAdminAclsResponse refreshAdminAcls(RefreshAdminAclsRequest request)
                                          throws YarnException

Specified by:

refreshAdminAcls in interface ResourceManagerAdministrationProtocol

Throws:

YarnException

refreshServiceAcls

public RefreshServiceAclsResponse refreshServiceAcls(RefreshServiceAclsRequest request)
                                              throws YarnException

Specified by:

refreshServiceAcls in interface ResourceManagerAdministrationProtocol

Throws:

YarnException

getGroupsForUser

public String[] getGroupsForUser(String user)
                          throws IOException

Description copied from interface: GetUserMappingsProtocol

Get the groups which are mapped to the given user.

Specified by:

getGroupsForUser in interface GetUserMappingsProtocol

Parameters:

user - The user to get the groups for.

Returns:

The set of groups the user belongs to.

Throws:

IOException