001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package org.apache.hadoop.yarn.api.records;
020    
021    import java.util.List;
022    
023    import org.apache.hadoop.classification.InterfaceAudience.Private;
024    import org.apache.hadoop.classification.InterfaceAudience.Public;
025    import org.apache.hadoop.classification.InterfaceStability.Stable;
026    import org.apache.hadoop.classification.InterfaceStability.Unstable;
027    import org.apache.hadoop.yarn.api.ClientRMProtocol;
028    
029    /**
030     * <p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
031     * the given user.</p>
032     * 
033     * @see QueueACL
034     * @see ClientRMProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)
035     */
036    @Public
037    @Stable
038    public interface QueueUserACLInfo {
039      /**
040       * Get the <em>queue name</em> of the queue.
041       * @return <em>queue name</em> of the queue
042       */
043      @Public
044      @Stable
045      String getQueueName();
046      
047      @Private
048      @Unstable
049      void setQueueName(String queueName);
050    
051      /**
052       * Get the list of <code>QueueACL</code> for the given user.
053       * @return list of <code>QueueACL</code> for the given user
054       */
055      @Public
056      @Stable
057      List<QueueACL> getUserAcls();
058    
059      @Private
060      @Unstable
061      void setUserAcls(List<QueueACL> acls);
062    }