public class AdminService
extends org.apache.hadoop.service.CompositeService
implements org.apache.hadoop.ha.HAServiceProtocol, org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol
org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHook| Constructor and Description | 
|---|
| AdminService(ResourceManager rm) | 
| Modifier and Type | Method and Description | 
|---|---|
| org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsResponse | addToClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.BatchSaveFederationQueuePoliciesResponse | batchSaveFederationQueuePolicies(org.apache.hadoop.yarn.server.api.protocolrecords.BatchSaveFederationQueuePoliciesRequest request)In YARN-Federation mode, this method provides a way to save queue policies in batches. | 
| org.apache.hadoop.yarn.server.api.protocolrecords.CheckForDecommissioningNodesResponse | checkForDecommissioningNodes(org.apache.hadoop.yarn.server.api.protocolrecords.CheckForDecommissioningNodesRequest checkForDecommissioningNodesRequest) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationApplicationResponse | deleteFederationApplication(org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationApplicationRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationQueuePoliciesResponse | deleteFederationPoliciesByQueues(org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationQueuePoliciesRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.DeregisterSubClusterResponse | deregisterSubCluster(org.apache.hadoop.yarn.server.api.protocolrecords.DeregisterSubClusterRequest request)In YARN Federation mode, We allow users to mark subClusters
 With no heartbeat for a long time as SC_LOST state. | 
| org.apache.hadoop.security.authorize.AccessControlList | getAccessControlList() | 
| org.apache.hadoop.yarn.server.api.protocolrecords.GetSubClustersResponse | getFederationSubClusters(org.apache.hadoop.yarn.server.api.protocolrecords.GetSubClustersRequest request) | 
| String[] | getGroupsForUser(String user) | 
| org.apache.hadoop.ipc.RPC.Server | getServer() | 
| org.apache.hadoop.ha.HAServiceStatus | getServiceStatus()Return the HA status of this RM. | 
| org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesResponse | listFederationQueuePolicies(org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesRequest request) | 
| protected org.apache.hadoop.conf.Configuration | loadNewConfiguration() | 
| org.apache.hadoop.yarn.server.api.protocolrecords.NodesToAttributesMappingResponse | mapAttributesToNodes(org.apache.hadoop.yarn.server.api.protocolrecords.NodesToAttributesMappingRequest request) | 
| void | monitorHealth() | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RefreshAdminAclsResponse | refreshAdminAcls(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshAdminAclsRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RefreshClusterMaxPriorityResponse | refreshClusterMaxPriority(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshClusterMaxPriorityRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResponse | refreshNodes(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResourcesResponse | refreshNodesResources(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResourcesRequest request) | 
| void | refreshQueues() | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RefreshQueuesResponse | refreshQueues(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshQueuesRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RefreshServiceAclsResponse | refreshServiceAcls(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshServiceAclsRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RefreshSuperUserGroupsConfigurationResponse | refreshSuperUserGroupsConfiguration(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshSuperUserGroupsConfigurationRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RefreshUserToGroupsMappingsResponse | refreshUserToGroupsMappings(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshUserToGroupsMappingsRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsResponse | removeFromClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeResponse | replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest request) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyResponse | saveFederationQueuePolicy(org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyRequest request)In YARN-Federation mode, We will be storing the Policy information for Queues. | 
| void | serviceInit(org.apache.hadoop.conf.Configuration conf) | 
| protected void | serviceStart() | 
| protected void | serviceStop() | 
| protected void | startServer() | 
| protected void | stopServer() | 
| void | transitionToActive(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) | 
| void | transitionToObserver(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) | 
| void | transitionToStandby(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo) | 
| org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceResponse | updateNodeResource(org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceRequest request) | 
addIfService, addService, getServices, removeServiceclose, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStoppublic AdminService(ResourceManager rm)
public void serviceInit(org.apache.hadoop.conf.Configuration conf)
                 throws Exception
serviceInit in class org.apache.hadoop.service.CompositeServiceExceptionprotected void serviceStart()
                     throws Exception
serviceStart in class org.apache.hadoop.service.CompositeServiceExceptionprotected void serviceStop()
                    throws Exception
serviceStop in class org.apache.hadoop.service.CompositeServiceExceptionpublic void monitorHealth()
                   throws IOException
monitorHealth in interface org.apache.hadoop.ha.HAServiceProtocolIOExceptionpublic void transitionToActive(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo)
                        throws IOException
transitionToActive in interface org.apache.hadoop.ha.HAServiceProtocolIOExceptionpublic void transitionToStandby(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo)
                         throws IOException
transitionToStandby in interface org.apache.hadoop.ha.HAServiceProtocolIOExceptionpublic void transitionToObserver(org.apache.hadoop.ha.HAServiceProtocol.StateChangeRequestInfo reqInfo)
                          throws IOException
transitionToObserver in interface org.apache.hadoop.ha.HAServiceProtocolIOExceptionpublic org.apache.hadoop.ha.HAServiceStatus getServiceStatus()
                                                      throws IOException
getServiceStatus in interface org.apache.hadoop.ha.HAServiceProtocolHAServiceStatus of the current RMIOException - if the caller does not have permissionspublic org.apache.hadoop.yarn.server.api.protocolrecords.RefreshQueuesResponse refreshQueues(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshQueuesRequest request)
                                                                                      throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                             org.apache.hadoop.ipc.StandbyException
refreshQueues in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionorg.apache.hadoop.ipc.StandbyExceptionprotected org.apache.hadoop.conf.Configuration loadNewConfiguration()
                                                             throws IOException,
                                                                    org.apache.hadoop.yarn.exceptions.YarnException
IOExceptionorg.apache.hadoop.yarn.exceptions.YarnException@InterfaceAudience.Private
public void refreshQueues()
                                              throws IOException,
                                                     org.apache.hadoop.yarn.exceptions.YarnException
IOExceptionorg.apache.hadoop.yarn.exceptions.YarnExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResponse refreshNodes(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesRequest request)
                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                           org.apache.hadoop.ipc.StandbyException
refreshNodes in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionorg.apache.hadoop.ipc.StandbyExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.RefreshSuperUserGroupsConfigurationResponse refreshSuperUserGroupsConfiguration(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshSuperUserGroupsConfigurationRequest request)
                                                                                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                                         IOException
refreshSuperUserGroupsConfiguration in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.RefreshUserToGroupsMappingsResponse refreshUserToGroupsMappings(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshUserToGroupsMappingsRequest request)
                                                                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                         IOException
refreshUserToGroupsMappings in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.RefreshAdminAclsResponse refreshAdminAcls(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshAdminAclsRequest request)
                                                                                            throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                   IOException
refreshAdminAcls in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.RefreshServiceAclsResponse refreshServiceAcls(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshServiceAclsRequest request)
                                                                                                throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                       IOException
refreshServiceAcls in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic String[] getGroupsForUser(String user) throws IOException
getGroupsForUser in interface org.apache.hadoop.tools.GetUserMappingsProtocolIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceResponse updateNodeResource(org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceRequest request)
                                                                                                throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                       IOException
updateNodeResource in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResourcesResponse refreshNodesResources(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshNodesResourcesRequest request)
                                                                                                      throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                             org.apache.hadoop.ipc.StandbyException
refreshNodesResources in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionorg.apache.hadoop.ipc.StandbyException@VisibleForTesting public org.apache.hadoop.security.authorize.AccessControlList getAccessControlList()
@VisibleForTesting public org.apache.hadoop.ipc.RPC.Server getServer()
public org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsResponse addToClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsRequest request)
                                                                                                        throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                               IOException
addToClusterNodeLabels in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsResponse removeFromClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsRequest request)
                                                                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                         IOException
removeFromClusterNodeLabels in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeResponse replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest request)
                                                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                         IOException
replaceLabelsOnNode in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.CheckForDecommissioningNodesResponse checkForDecommissioningNodes(org.apache.hadoop.yarn.server.api.protocolrecords.CheckForDecommissioningNodesRequest checkForDecommissioningNodesRequest)
                                                                                                                    throws IOException,
                                                                                                                           org.apache.hadoop.yarn.exceptions.YarnException
checkForDecommissioningNodes in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolIOExceptionorg.apache.hadoop.yarn.exceptions.YarnExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.RefreshClusterMaxPriorityResponse refreshClusterMaxPriority(org.apache.hadoop.yarn.server.api.protocolrecords.RefreshClusterMaxPriorityRequest request)
                                                                                                              throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                     IOException
refreshClusterMaxPriority in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.NodesToAttributesMappingResponse mapAttributesToNodes(org.apache.hadoop.yarn.server.api.protocolrecords.NodesToAttributesMappingRequest request)
                                                                                                        throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                               IOException
mapAttributesToNodes in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.DeregisterSubClusterResponse deregisterSubCluster(org.apache.hadoop.yarn.server.api.protocolrecords.DeregisterSubClusterRequest request)
                                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException
deregisterSubCluster in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolrequest - deregisterSubCluster request.
 The request contains the id of to deregister sub-cluster.org.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.public org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyResponse saveFederationQueuePolicy(org.apache.hadoop.yarn.server.api.protocolrecords.SaveFederationQueuePolicyRequest request)
                                                                                                              throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                     IOException
saveFederationQueuePolicy in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolrequest - saveFederationQueuePolicy Requestorg.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.IOException - if an IO error occurred.public org.apache.hadoop.yarn.server.api.protocolrecords.BatchSaveFederationQueuePoliciesResponse batchSaveFederationQueuePolicies(org.apache.hadoop.yarn.server.api.protocolrecords.BatchSaveFederationQueuePoliciesRequest request)
                                                                                                                            throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                                   IOException
batchSaveFederationQueuePolicies in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolrequest - BatchSaveFederationQueuePolicies Requestorg.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.IOException - if an IO error occurred.public org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesResponse listFederationQueuePolicies(org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesRequest request)
                                                                                                                   throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                          IOException
listFederationQueuePolicies in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationApplicationResponse deleteFederationApplication(org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationApplicationRequest request)
                                                                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                         IOException
deleteFederationApplication in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.GetSubClustersResponse getFederationSubClusters(org.apache.hadoop.yarn.server.api.protocolrecords.GetSubClustersRequest request)
                                                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                         IOException
getFederationSubClusters in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationQueuePoliciesResponse deleteFederationPoliciesByQueues(org.apache.hadoop.yarn.server.api.protocolrecords.DeleteFederationQueuePoliciesRequest request)
                                                                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                                IOException
deleteFederationPoliciesByQueues in interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocolorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionCopyright © 2008–2025 Apache Software Foundation. All rights reserved.