/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.ambari.server.controller;

import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.UriInfo;

import org.apache.ambari.server.api.services.users.UserPrivilegeService;
import org.apache.ambari.server.orm.entities.PrincipalTypeEntity;

import io.swagger.annotations.ApiModelProperty;

/**
 * Response schema for endpoint {@link UserPrivilegeService#getPrivileges(HttpHeaders, UriInfo, String)}
 */
public class UserPrivilegeResponse extends PrivilegeResponse implements ApiModel {

  private final String userName;

  /**
   *
   * @param userName           user name
   * @param permissionLabel    permission label
   * @param permissionName     permission name
   * @param privilegeId        privilege id
   * @param principalType      principal type
   */
  public UserPrivilegeResponse(String userName, String permissionLabel, String permissionName, Integer privilegeId,
                           PrincipalTypeEntity.PrincipalType principalType) {
    this.userName = userName;
    this.permissionLabel = permissionLabel;
    this.privilegeId = privilegeId;
    this.permissionName = permissionName;
    this.principalType = principalType;
  }

  /**
   * Returns user name
   * @return  user name
   */
  @ApiModelProperty(name = "PrivilegeInfo/user_name",required = true)
  public String getUserName() {
    return userName;
  }
}
