nifi-registry-security-api/src/main/java/org/apache/nifi/registry/security/authorization/Resource.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.nifi.registry.security.authorization;

/**
 * Resource in an authorization request.
 */
public interface Resource {

    /**
     * The identifier for this resource.
     *
     * @return identifier for this resource
     */
    String getIdentifier();

    /**
     * The name of this resource. May be null.
     *
     * @return name of this resource
     */
    String getName();

    /**
     * The description of this resource that may be safely used in messages to the client.
     *
     * @return safe description
     */
    String getSafeDescription();
}