Package org.apache.hadoop.yarn.server.router.rmadmin

Interface RMAdminRequestInterceptor

All Superinterfaces:
org.apache.hadoop.conf.Configurable, org.apache.hadoop.tools.GetUserMappingsProtocol, org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol
All Known Implementing Classes:
AbstractRMAdminRequestInterceptor, DefaultRMAdminRequestInterceptor, FederationRMAdminInterceptor
public interface RMAdminRequestInterceptor extends org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol, org.apache.hadoop.conf.Configurable
Defines the contract to be implemented by the request interceptor classes, that can be used to intercept and inspect messages sent from the client to the resource manager.

  • Field Summary

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

    versionID

  • Method Summary

    Modifier and Type
    Method
    Description
    RMAdminRequestInterceptor
    getNextInterceptor()
    Returns the next interceptor in the chain.
    void
    init(String user)
    This method is called for initializing the interceptor.
    void
    setNextInterceptor(RMAdminRequestInterceptor nextInterceptor)
    Sets the next interceptor in the pipeline.
    void
    shutdown()
    This method is called to release the resources held by the interceptor.

    Methods inherited from interface org.apache.hadoop.conf.Configurable

    getConf, setConf

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

    getGroupsForUser

    Methods inherited from interface org.apache.hadoop.yarn.server.api.ResourceManagerAdministrationProtocol

    addToClusterNodeLabels, batchSaveFederationQueuePolicies, checkForDecommissioningNodes, deleteFederationApplication, deleteFederationPoliciesByQueues, deregisterSubCluster, getFederationSubClusters, listFederationQueuePolicies, mapAttributesToNodes, refreshAdminAcls, refreshClusterMaxPriority, refreshNodes, refreshNodesResources, refreshQueues, refreshServiceAcls, refreshSuperUserGroupsConfiguration, refreshUserToGroupsMappings, removeFromClusterNodeLabels, replaceLabelsOnNode, saveFederationQueuePolicy, updateNodeResource

  • Method Details

    • init

      void init(String user)
      This method is called for initializing the interceptor. This is guaranteed to be called only once in the lifetime of this instance.
      Parameters:
      user - the name of the client

    • shutdown

      void shutdown()
      This method is called to release the resources held by the interceptor. This will be called when the application pipeline is being destroyed. The concrete implementations should dispose the resources and forward the request to the next interceptor, if any.

    • setNextInterceptor

      void setNextInterceptor(RMAdminRequestInterceptor nextInterceptor)
      Sets the next interceptor in the pipeline. The concrete implementation of this interface should always pass the request to the nextInterceptor after inspecting the message. The last interceptor in the chain is responsible to send the messages to the resource manager service and so the last interceptor will not receive this method call.
      Parameters:
      nextInterceptor - the RMAdminRequestInterceptor to set in the pipeline

    • getNextInterceptor

      RMAdminRequestInterceptor getNextInterceptor()
      Returns the next interceptor in the chain.
      Returns:
      the next interceptor in the chain