org.camunda.bpm.engine.authorization.AuthorizationQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camunda-bpm-engine-api Show documentation
There is a newer version: 7.22.0
Show newest version
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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.camunda.bpm.engine.authorization;

import org.camunda.bpm.engine.query.Query;

/**
 * @author Daniel Meyer
 *
 */
public interface AuthorizationQuery extends Query {

  /** only selects authorizations for the given id */
  AuthorizationQuery authorizationId(String id);
  
  /** only selects authorizations for the given type. Legal values:
   * {@link Authorization#AUTH_TYPE_GLOBAL}, {@link Authorization#AUTH_TYPE_GRANT}
   * {@link Authorization#AUTH_TYPE_REVOKE} */
  AuthorizationQuery authorizationType(Integer type);
  
  /** only selects authorizations for the given user ids */
  AuthorizationQuery userIdIn(String... userIds);
  
  /** only selects authorizations for the given group ids */
  AuthorizationQuery groupIdIn(String... groupIds);
  
  /** only selects authorizations for the given resource type */
  AuthorizationQuery resourceType(Resource resource);
  
  /** only selects authorizations for the given resource type */
  AuthorizationQuery resourceType(int resourceType);
  
  /** only selects authorizations for the given resource id */
  AuthorizationQuery resourceId(String resourceId);
  
  /** only selects authorizations which grant the permissions represented by the parameter.
   * If this method is called multiple times, all passed-in permissions will be checked with AND semantics.
   * Example:
   * 
   *    * authorizationQuery.userId("user1")
   *   .resourceType("processDefinition")
   *   .resourceId("2313")
   *   .hasPermission(Permissions.READ)
   *   .hasPermission(Permissions.UPDATE)
   *   .hasPermission(Permissions.DELETE)
   *   .list();
   * 
   * 
   * Selects all Authorization objects which provide READ,UPDATE,DELETE 
   * Permissions for the given user. 
   * 
   */
  AuthorizationQuery hasPermission(Permission permission);
  
  // order by /////////////////////////////////////////////
  
  /** Order by resource type (needs to be followed by {@link #asc()} or {@link #desc()}). */
  AuthorizationQuery orderByResourceType();
  
  /** Order by resource id (needs to be followed by {@link #asc()} or {@link #desc()}). */
  AuthorizationQuery orderByResourceId();
  
}