cloudstack-mirror/api/src/org/apache/cloudstack/acl/AclService.java
2013-09-26 17:48:29 -07:00

89 lines
2.5 KiB
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.acl;
import java.util.List;
import com.cloud.utils.Pair;
public interface AclService {
/**
* Creates an acl role for the given domain.
*
* @param domainId
* @param name
* @param description
* @return AclRole
*/
AclRole createAclRole(Long domainId, String aclRoleName, String description);
/**
* Delete an acl role.
*
* @param aclRoleId
*/
boolean deleteAclRole(long aclRoleId);
AclRole grantPermissionToAclRole(long aclRoleId, List<String> apiNames);
AclRole revokePermissionFromAclRole(long aclRoleId, List<String> apiNames);
AclGroup addAclRolesToGroup(List<Long> roleIds, Long groupId);
AclGroup removeAclRolesFromGroup(List<Long> roleIds, Long groupId);
/**
* Creates an acl group for the given domain.
*
* @param domainId
* @param name
* @param description
* @return AclGroup
*/
AclGroup createAclGroup(Long domainId, String aclGroupName, String description);
/**
* Delete an acl group.
*
* @param aclGroupId
*/
boolean deleteAclGroup(Long aclGroupId);
/** Lists Acl groups for a domain
* @param domainId
* @param aclGroupId
* @param aclGroupName
* @param startIndex
* @param pageSize
* @return
*/
Pair<List<? extends AclRole>, Integer> listAclGroups(Long aclRoleId, String aclRoleName,
Long domainId, Long startIndex, Long pageSize);
/**
* Get the acl group for the given group id.
* @param groupId
* @return AclGroup
*/
AclRole getAclGroup(Long groupId);
}