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.io.Serializable;
023import java.util.List;
024
025/**
026 * Typed Web resource (js, css, bundle).
027 *
028 * @since 7.3
029 */
030public interface Resource extends Serializable {
031
032    /**
033     * Marker for Nuxeo web resources, used by URI locators.
034     */
035    public static final String PREFIX = "nuxeo:";
036
037    String getName();
038
039    String getType();
040
041    String getPath();
042
043    String getURI();
044
045    /**
046     * Returns an optional target to push resources to in the page.
047     * <p>
048     * Currently only useful to JSF resources.
049     *
050     * @since 7.10
051     */
052    String getTarget();
053
054    /**
055     * Names of the resource dependencies.
056     */
057    List<String> getDependencies();
058
059    /**
060     * Names of the resource processors, hooking features like flavor replacement on the resource.
061     */
062    List<String> getProcessors();
063
064    /**
065     * Returns true if resource can be minimized.
066     * <p>
067     * Returns true by default if not specified.
068     */
069    boolean isShrinkable();
070
071}