freenet.client.filter

Interface ContentDataFilter

All Known Implementing Classes:

BMPFilter, CSSReadFilter, FlacFilter, GIFFilter, HTMLFilter, JPEGFilter, M3UFilter, MP3Filter, OggFilter, PNGFilter

public interface ContentDataFilter

Data filter for a specific MIME type.

Method Summary

Modifier and Type	Method and Description
default void	readFilter(java.io.InputStream input, java.io.OutputStream output, java.lang.String charset, java.util.Map<java.lang.String,java.lang.String> otherParams, FilterCallback cb) Deprecated.
void	readFilter(java.io.InputStream input, java.io.OutputStream output, java.lang.String charset, java.util.Map<java.lang.String,java.lang.String> otherParams, java.lang.String schemeHostAndPort, FilterCallback cb) Filter data for reading.

Method Detail

readFilter

void readFilter(java.io.InputStream input,
                java.io.OutputStream output,
                java.lang.String charset,
                java.util.Map<java.lang.String,java.lang.String> otherParams,
                java.lang.String schemeHostAndPort,
                FilterCallback cb)
         throws DataFilterException,
                java.io.IOException

Filter data for reading. Objective is to ensure the data is safe if rendered by e.g. a web browser, and to guarantee that it is of the correct type. Filters should usually be implemented as "white list", that is, they should parse everything, and when encountering anything they cannot parse, should delete it, or throw a DataFilterException. IMPORTANT Implementation note: The InputStream may be a PipedInputStream (or conceivably even a network stream). Implementations MUST NOT ASSUME that input.available() == 0 => EOF!

Parameters:

input - Stream to read potentially unsafe data from.

output - Stream to write safe (but possibly incomplete) data to.

charset - Character set of the data if appropriate for this MIME type.

otherParams - Other type parameters if appropriate.

schemeHostAndPort - Scheme, host and port of the node as seen in the request.

cb - Filter callback for modifying HTML tags. Irrelevant for most MIME types. In future we might need this for other types.

Throws:

DataFilterException - If the data cannot be filtered. Any data written so far should be discarded if possible.

java.io.IOException - If there was a failure to read from the input data or write to the output data. Implementations should not throw this if data is merely badly formatted - any such exceptions should be caught and converted to a DataFilterException.

readFilter

@Deprecated
default void readFilter(java.io.InputStream input,
                                    java.io.OutputStream output,
                                    java.lang.String charset,
                                    java.util.Map<java.lang.String,java.lang.String> otherParams,
                                    FilterCallback cb)
                             throws DataFilterException,
                                    java.io.IOException

Deprecated.

Compatibility for readFilter without schemeHostAndPort. Please use readFilter with schemeHostAndPort.

Throws:

DataFilterException

java.io.IOException