Package de.xima.fc.interfaces.workflow

Interface IResourceDescriptor

All Superinterfaces:
Serializable
All Known Implementing Classes:
ByteArrayResourceDescriptor, CombinedResourceDescriptor, DevResourceDescriptor, DevResourceDescriptor, EmptyResourceDescriptor, PathResourceDescriptor, SupplyingResourceDescriptor, UrlResourceDescriptor, WrappedResourceDescriptor
public interface IResourceDescriptor extends Serializable
A resource descriptor that consists of an URI serving as the identifier for the resource, and an open() method for accessing the content of the resource. The resource identifier is used, for example, to prevent the same resource from being read multiple times. The content of the resource should not be dynamic and always be the same for a given URI.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getAbsoluteUri

      URI getAbsoluteUri()
      Returns:
      An absolute URI that identifies this resource. It is an error for this to return an URI where URI.isAbsolute() yields false.

    • open

      InputStream open() throws IOException
      Returns:
      An input stream to the content of the resource.
      Throws:
      IOException - When the resource could not be opened.

    • getCharset

      default Charset getCharset()
      Returns:
      When this resource is a plain text resource: the charset or encoding of the text. Defaults to UTF_8.
      Since:
      8.0.0