001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Anahide Tchertchian
018 */
019
020package org.nuxeo.ecm.web.resources.api;
021
022import java.util.List;
023
024/**
025 * Typed Web resource (js, css, bundle).
026 *
027 * @since 7.3
028 */
029public interface Resource {
030
031    /**
032     * Marker for Nuxeo web resources, used by URI locators.
033     */
034    String PREFIX = "nuxeo:";
035
036    String getName();
037
038    String getType();
039
040    String getPath();
041
042    String getURI();
043
044    /**
045     * Returns an optional target to push resources to in the page.
046     * <p>
047     * Currently only useful to JSF resources.
048     *
049     * @since 7.10
050     */
051    String getTarget();
052
053    /**
054     * Names of the resource dependencies.
055     */
056    List<String> getDependencies();
057
058    /**
059     * Names of the resource processors, hooking features like flavor replacement on the resource.
060     */
061    List<String> getProcessors();
062
063    /**
064     * Returns true if resource can be minimized.
065     * <p>
066     * Returns true by default if not specified.
067     */
068    boolean isShrinkable();
069
070}