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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation

There is a newer version: 7.23.0-alpha1

/*
 * 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;

/**
 * The set of built-in {@link Permission Permissions} for
 * {@link Resources#OPTIMIZE Optimize resource} in Camunda Platform.
 *
 * @deprecated These permissions have no effect
 */
@Deprecated
public enum OptimizePermissions implements Permission {

  /**
   * The none permission means 'no action', 'doing nothing'. It does not mean
   * that no permissions are granted.
   */
  NONE("NONE", 0),

  /**
   * Indicates that all interactions are permitted. If ALL is revoked it means
   * that the user is not permitted to do everything, which means that at least
   * one permission is revoked. This does not implicate that all individual
   * permissions are revoked.
   * 
   * Example: If the EDIT permission is revoked then the ALL
   * permission is revoked as well, because the user is not authorized
   * to execute all actions anymore.
   */
  ALL("ALL", Integer.MAX_VALUE),

  /** Indicates that EDIT interactions are permitted. */
  EDIT("EDIT", 2),

  /** Indicates that SHARE interactions are permitted. */
  SHARE("SHARE", 4);

  private static final Resource[] RESOURCES = new Resource[] { Resources.OPTIMIZE };

  private String name;
  private int id;

  private OptimizePermissions(String name, int id) {
    this.name = name;
    this.id = id;
  }

  @Override
  public String getName() {
    return name;
  }

  @Override
  public int getValue() {
    return id;
  }

  @Override
  public Resource[] getTypes() {
    return RESOURCES;
  }

}