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
019package org.apache.hadoop.yarn.api.protocolrecords;
020
021import java.util.List;
022
023import org.apache.hadoop.classification.InterfaceAudience.Private;
024import org.apache.hadoop.classification.InterfaceAudience.Public;
025import org.apache.hadoop.classification.InterfaceStability.Stable;
026import org.apache.hadoop.classification.InterfaceStability.Unstable;
027import org.apache.hadoop.yarn.api.ApplicationClientProtocol;
028import org.apache.hadoop.yarn.api.records.QueueACL;
029import org.apache.hadoop.yarn.api.records.QueueUserACLInfo;
030import org.apache.hadoop.yarn.util.Records;
031
032/**
033 * <p>The response sent by the <code>ResourceManager</code> to clients
034 * seeking queue acls for the user.</p>
035 *
036 * <p>The response contains a list of {@link QueueUserACLInfo} which
037 * provides information about {@link QueueACL} per queue.</p>
038 * 
039 * @see QueueACL
040 * @see QueueUserACLInfo
041 * @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)
042 */
043@Public
044@Stable
045public abstract class GetQueueUserAclsInfoResponse {
046
047  @Private
048  @Unstable
049  public static GetQueueUserAclsInfoResponse newInstance(
050      List<QueueUserACLInfo> queueUserAclsList) {
051    GetQueueUserAclsInfoResponse response =
052        Records.newRecord(GetQueueUserAclsInfoResponse.class);
053    response.setUserAclsInfoList(queueUserAclsList);
054    return response;
055  }
056
057  /**
058   * Get the <code>QueueUserACLInfo</code> per queue for the user.
059   * @return <code>QueueUserACLInfo</code> per queue for the user
060   */
061  @Public
062  @Stable
063  public abstract List<QueueUserACLInfo> getUserAclsInfoList();
064  
065  @Private
066  @Unstable
067  public abstract void setUserAclsInfoList(
068      List<QueueUserACLInfo> queueUserAclsList);
069  
070}