eu.ciechanowiec.sling.rocket.asset.Asset Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sling.rocket.commons Show documentation
Common utilities used by Sling Rocket
There is a newer version: 13.32.0
package eu.ciechanowiec.sling.rocket.asset;

import eu.ciechanowiec.sling.rocket.jcr.Referencable;
import eu.ciechanowiec.sling.rocket.jcr.path.WithJCRPath;
import org.apache.jackrabbit.JcrConstants;

import javax.jcr.Node;
import javax.jcr.Property;
import javax.jcr.PropertyType;
import java.util.List;

/**
 * 
 * Represents {@link Node} instances of primary types specified in {@link Asset#SUPPORTED_PRIMARY_TYPES}.
 * That can be either a persisted or a hypothetically persisted {@link Node}.
 * 
 * 
 *     
 *        The exact type of the underlying {@link Node} is considered
 *        an implementation detail and is hidden from the client.
 *        The client might choose a {@link Node} of any supported type as the base for this {@link Asset}.
 *     
 *     
 *        The basic implementation of this interface is {@link UniversalAsset}.
 *     
 * 
 */
@SuppressWarnings("StaticMethodOnlyUsedInOneClass")
public interface Asset extends WithJCRPath, Referencable {

    /**
     * The type name of a {@link Node} that contains a binary file and related metadata.
     */
    String NT_ASSET_REAL = "rocket:AssetReal";

    /**
     * The type name of a {@link Node} that links to a different {@link Node} that can be represented by
     * an instance of an {@link Asset}.
     */
    String NT_ASSET_LINK = "rocket:AssetLink";

    /**
     * The type name of a {@link Node} with metadata, which is a
     * child of a {@link Node} of type {@link Asset#NT_ASSET_REAL}.
     */
    String NT_ASSET_METADATA = "rocket:AssetMetadata";

    /**
     * Name of a {@link Property} of type {@link PropertyType#REFERENCE} on a {@link Node} of type
     * {@link Asset#NT_ASSET_LINK}, which points to a different {@link Node} that can be represented by
     * an instance of an {@link Asset}.
     */
    String PN_LINKED_ASSET = "linkedAsset";

    /**
     * Name of a {@link Node} with a file, which is a child of a {@link Node} of type {@link Asset#NT_ASSET_REAL}.
     */
    String FILE_NODE_NAME = "file";

    /**
     * Name of a {@link Node} with metadata, which is a child of a {@link Node} of type {@link Asset#NT_ASSET_REAL}.
     */
    String METADATA_NODE_NAME = "metadata";

    /**
     * List of {@link Node} primary types supported by {@link Asset}.
     */
    List SUPPORTED_PRIMARY_TYPES = List.of(
            NT_ASSET_REAL, NT_ASSET_LINK, JcrConstants.NT_RESOURCE, JcrConstants.NT_FILE
    );

    /**
     * Returns the {@link AssetFile} associated with this {@link Asset}.
     * @return {@link AssetFile} associated with this {@link Asset}
     */
    AssetFile assetFile();

    /**
     * Returns the {@link AssetMetadata} associated with this {@link Asset}.
     * @return {@link AssetMetadata} associated with this {@link Asset}
     */
    AssetMetadata assetMetadata();
}