org.camunda.bpm.engine.authorization.Resource Maven / Gradle / Ivy
/*
* 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;
/**
* Resources are entities for which a user or a group is authorized. Examples of
* resources are applications, process-definitions, process-instances, tasks ...
*
* A resource has a type and an id. The type ({@link #setResource(String)})
* allows to group all resources of the same kind. A resource id is the identifier of
* an individual resource instance ({@link #setResourceId(String)}). For example:
* the resource type could be "processDefinition" and the resource-id could be the
* id of an individual process definition.
*
* See {@link Resources} for a set of built-in resource constants.
*
* @author Daniel Meyer
* @see Resources
*
*/
public interface Resource {
/** returns the name of the resource */
String resourceName();
/** an integer representing the type of the resource.
* @return the type identitfyer of the resource */
int resourceType();
}