api/src/main/java/org/apache/cloudstack/api/response/RolePermissionResponse.java

// 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
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// 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.cloudstack.api.response;

import com.cloud.serializer.Param;
import com.google.gson.annotations.SerializedName;
import org.apache.cloudstack.acl.RolePermission;
import org.apache.cloudstack.acl.Rule;
import org.apache.cloudstack.api.ApiConstants;
import org.apache.cloudstack.api.BaseResponse;
import org.apache.cloudstack.api.EntityReference;

@EntityReference(value = RolePermission.class)
public class RolePermissionResponse extends BaseResponse {
    @SerializedName(ApiConstants.ID)
    @Param(description = "the ID of the role permission")
    private String id;

    @SerializedName(ApiConstants.ROLE_ID)
    @Param(description = "the ID of the role to which the role permission belongs")
    private String roleId;

    @SerializedName(ApiConstants.ROLE_NAME)
    @Param(description = "the name of the role to which the role permission belongs")
    private String roleName;

    @SerializedName(ApiConstants.RULE)
    @Param(description = "the api name or wildcard rule")
    private String rule;

    @SerializedName(ApiConstants.PERMISSION)
    @Param(description = "the permission type of the api name or wildcard rule, allow/deny")
    private String rulePermission;

    @SerializedName(ApiConstants.DESCRIPTION)
    @Param(description = "the description of the role permission")
    private String ruleDescription;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getRoleId() {
        return roleId;
    }

    public void setRoleId(String roleId) {
        this.roleId = roleId;
    }

    public String getRoleName() {
        return roleName;
    }

    public void setRoleName(String roleName) {
        this.roleName = roleName;
    }

    public String getRule() {
        return rule;
    }

    public void setRule(Rule rule) {
        if (rule != null) {
            this.rule = rule.getRuleString();
        }
    }

    public String getRulePermission() {
        return rulePermission;
    }

    public void setRulePermission(RolePermission.Permission rulePermission) {
        if (rulePermission != null) {
            this.rulePermission = rulePermission.name().toLowerCase();
        }
    }

    public void setDescription(String description) {
        this.ruleDescription = description;
    }
}