Interface for QueryChecker adapter.

api/src/org/apache/cloudstack/acl/QueryChecker.java

@@ -0,0 +1,83 @@
+// 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.user.Account;
+import com.cloud.utils.component.Adapter;
+
+/**
+ * QueryChecker returns granted access at domain, account or resource level.
+ */
+public interface QueryChecker extends Adapter {
+
+    /**
+    * List granted domains for the caller, given a specific entity type.
+    *
+    * @param caller account to check against.
+    * @param entityType entity type
+    * @return list of domain Ids granted to the caller account.
+    */
+    List<Long> getAuthorizedDomains(Account caller, AclEntityType entityType);
+
+    /**
+    * List denied domains for the caller, given a specific entity type.
+    *
+    * @param caller account to check against.
+    * @param entityType entity type
+    * @return list of domain Ids granted to the caller account.
+    */
+    List<Long> getDeniedDomains(Account caller, AclEntityType entityType);
+
+    /**
+    * List granted accounts for the caller, given a specific entity type.
+    *
+    * @param caller account to check against.
+    * @param entityType entity type
+    * @return list of domain Ids granted to the caller account.
+    */
+    List<Long> getAuthorizedAccounts(Account caller, AclEntityType entityType);
+
+    /**
+    * List denied accounts for the caller, given a specific entity type.
+    *
+    * @param caller account to check against.
+    * @param entityType entity type
+    * @return list of domain Ids granted to the caller account.
+    */
+    List<Long> getDeniedAccounts(Account caller, AclEntityType entityType);
+
+    /**
+    * List granted resources for the caller, given a specific entity type.
+    *
+    * @param caller account to check against.
+    * @param entityType entity type
+    * @return list of domain Ids granted to the caller account.
+    */
+    List<Long> getAuthorizedResources(Account caller, AclEntityType entityType);
+
+    /**
+    * List denied resources for the caller, given a specific entity type.
+    *
+    * @param caller account to check against.
+    * @param entityType entity type
+    * @return list of domain Ids granted to the caller account.
+    */
+    List<Long> getDeniedResources(Account caller, AclEntityType entityType);
+
+}