com.day.cq.dam.commons.handler

Class DefaultFormatHandler

java.lang.Object

com.day.cq.dam.commons.handler.DefaultFormatHandler

All Implemented Interfaces:

FormatHandler

public class DefaultFormatHandler
extends java.lang.Object
implements FormatHandler

Base class for format handlers.

Constructor Summary

Constructors

Constructor and Description
DefaultFormatHandler()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accepts(byte[] data, int off, int len) Return a flag indicating whether the handler is able to handle the data.
protected Processor[]	getAllProcessors(Context context) Return all processors available for this mime type.
java.io.InputStream	getMetadata(java.io.InputStream in) Return metadata as in input stream (utility method).
protected Processor[]	getMetadataProcessors(Context context) Return the processors responsible for detecting metadata.
java.awt.image.BufferedImage	getThumbnailImage(java.io.InputStream in) Return a thumbnail image from an input stream (utility method).
protected Processor[]	getThumbnailProcessors(Context context) Return the processors responsible for detecting thumbnails.
protected int	locate(byte[] pattern, byte[] data, int off, int len) Locate the pattern given in a byte array.
protected boolean	matchPrefix(byte[] expected, byte[] actual) Check whether the bytes following match the given byte array.
void	process(java.io.InputStream in, Context context) Process the input stream given.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFormatHandler

public DefaultFormatHandler()

Method Detail

accepts

public boolean accepts(byte[] data,
              int off,
              int len)

Return a flag indicating whether the handler is able to handle the data. The default format handler accepts all kind of data.

Specified by:

accepts in interface FormatHandler

Parameters:

data - data buffer

off - offset

len - number of valid bytes

Returns:

true if the handler is able to handle the data; false otherwise

getThumbnailProcessors

protected Processor[] getThumbnailProcessors(Context context)

Return the processors responsible for detecting thumbnails. This implementation detects thumbnails in <xapGImg:image> tags.

Returns:

processors

getMetadataProcessors

protected Processor[] getMetadataProcessors(Context context)

Return the processors responsible for detecting metadata. This implementation detects metadata in <?xpacket> tags.

Returns:

processors

getAllProcessors

protected Processor[] getAllProcessors(Context context)

Return all processors available for this mime type.

Returns:

processors

process

public final void process(java.io.InputStream in,
           Context context)
                   throws java.io.IOException

Process the input stream given.

Specified by:

process in interface FormatHandler

Parameters:

in - input stream

context - call context

Throws:

java.io.IOException - if an I/O error occurs

getThumbnailImage

public java.awt.image.BufferedImage getThumbnailImage(java.io.InputStream in)
                                               throws java.io.IOException,
                                                      ProcessorException

Return a thumbnail image from an input stream (utility method).

Specified by:

getThumbnailImage in interface FormatHandler

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

public java.io.InputStream getMetadata(java.io.InputStream in)
                                throws java.io.IOException,
                                       ProcessorException

Return metadata as in input stream (utility method).

Specified by:

getMetadata in interface FormatHandler

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

locate

protected int locate(byte[] pattern,
         byte[] data,
         int off,
         int len)

Locate the pattern given in a byte array.

Parameters:

pattern - binary pattern to locate

data - data to scan

off - offset inside data

len - number of valid bytes in data

Returns:

offset where pattern was found (position following the pattern); -1 if pattern was not found

matchPrefix

protected boolean matchPrefix(byte[] expected,
                  byte[] actual)
                       throws java.io.IOException

Check whether the bytes following match the given byte array.

Parameters:

expected - byte array

actual - actual bytes following

Returns:

true if the bytes following match; false otherwise.

Throws:

java.io.IOException - if an I/O error occurs