Package com.day.cq.dam.api

Interface FormatHandler

  • All Known Implementing Classes:
    DefaultFormatHandler
    public interface FormatHandler
    A format handler knows how to handle a container-like file format and can be looked up in OSGI via an ID.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean accepts​(byte[] data, int off, int len)
      Return a flag indicating whether the handler is able to handle the data.
      java.io.InputStream getMetadata​(java.io.InputStream in)
      Return metadata as in input stream (utility method).
      java.awt.image.BufferedImage getThumbnailImage​(java.io.InputStream in)
      Return a thumbnail image from an input stream (utility method).
      void process​(java.io.InputStream in, Context context)
      Process the input stream given.

    • Method Detail

      • accepts

        boolean accepts​(byte[] data,
                int off,
                int len)
        Return a flag indicating whether the handler is able to handle the data.
        Parameters:
        data - data buffer
        off - offset
        len - number of valid bytes
        Returns:
        true if the handler is able to handle the data; false otherwise

      • process

        void process​(java.io.InputStream in,
             Context context)
      throws java.io.IOException
        Process the input stream given.
        Parameters:
        in - input stream
        context - call context
        Throws:
        java.io.IOException - if an I/O error occurs

      • getThumbnailImage

        java.awt.image.BufferedImage getThumbnailImage​(java.io.InputStream in)
                                        throws java.io.IOException,
                                               ProcessorException
        Return a thumbnail image from an input stream (utility method).
        Parameters:
        in - input stream
        Returns:
        buffered image or null
        Throws:
        java.io.IOException - if an I/O error occurs
        ProcessorException - if a processor reports an error

      • getMetadata

        java.io.InputStream getMetadata​(java.io.InputStream in)
                         throws java.io.IOException,
                                ProcessorException
        Return metadata as in input stream (utility method).
        Parameters:
        in - input stream
        Returns:
        metadata input stream or null
        Throws:
        java.io.IOException - if an I/O error occurs
        ProcessorException - if a processor reports an error