HasResources.java

/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed 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.uberfire.security.client.authz.tree;

/**
 * Interface implemented for those {@link PermissionNode} instances that handle resources.
 */
public interface HasResources {

    /**
     * Retrieves the name of the resource (if any) this node is handling.
     * @return The name to display in the UI. If null then a generic resource name will be used such as "Item" or "Instance".
     */
    default String getResourceName() {
        return null;
    }
}