Package emissary.output.filter

Class DataFilter

java.lang.Object

emissary.output.filter.AbstractFilter

emissary.output.filter.DataFilter

All Implemented Interfaces:

IDropOffFilter

public class DataFilter
extends AbstractFilter

Filter that writes unadorned data as raw bytes

Field Summary

Fields inherited from class emissary.output.filter.AbstractFilter

ALL_ALT_VIEWS, ALL_LANGUAGE_VIEWS, ALL_PRIMARY_VIEWS, configG, denylist, denylistAllowedNameChars, denylistFiletypeFormat, denylistFiletypeFormatPattern, denylistViewNameFormat, denylistViewNameFormatPattern, dropOffUtil, errorSpec, filterConditionSpec, filterConfig, filterName, LANGUAGE_VIEW, LANGUAGE_VIEW_NAME, logger, METADATA_VIEW, METADATA_VIEW_NAME, outputSpec, outputTypes, PRIMARY_VIEW, PRIMARY_VIEW_NAME, slogger, wildCardDenylist

Fields inherited from interface emissary.output.filter.IDropOffFilter

PRE_SORTED, STATUS_FAILURE, STATUS_OUTPUT_STREAM_FAILURE, STATUS_SUCCESS, TLD_PARAM

Constructor Summary

Constructors

Constructor	Description
DataFilter()

Method Summary

Modifier and Type	Method	Description
int	filter(IBaseDataObject d, Map<String,Object> params)	Output one payload item
int	filter(IBaseDataObject d, Map<String,Object> params, OutputStream output)	Output one payload item to the provided output stream
void	initialize(Configurator configG, String filterName, Configurator filterConfig)	Initialize reads the configuration items for this filter
protected boolean	isPrimaryViewOutputtable(String lang, String fileType, String currentForm)
protected boolean	isViewOutputtable(String lang, String fileType, String currentForm, String viewName)
static void	main(String[] args)	Main to test output types
protected boolean	writeDataFile(IBaseDataObject d, IBaseDataObject tld, String baseFileName, byte[] data, String type)	Write a file, either the primary view or an alt view
protected boolean	writeDataStream(IBaseDataObject d, IBaseDataObject tld, OutputStream output, byte[] data, String type)

Methods inherited from class emissary.output.filter.AbstractFilter

close, denyListContains, filter, filter, getCharset, getDenylistFiletypeFormat, getDenylistViewNameFormat, getErrorSpec, getFilterName, getOutputSpec, getOutputTypes, getPrimaryTypesToCheck, getTypesToCheck, getTypesToCheckForNamedView, initialize, initializeDenylist, initializeOutputTypes, isOutputtable, isOutputtable, isOutputtable, isOutputtable, isOutputtable, isOutputtable, loadFilterConfiguration, loadNameValidationPatterns, loadOutputSpec, matchesDenylistFiletypeFormatPattern, matchesDenylistViewNameFormatPattern, normalizeBytes, normalizeBytes, setFilterName, validateAndRemoveDenylistFiletype

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFilter

public DataFilter()

Method Detail

initialize

public void initialize(Configurator configG,
                       @Nullable
                       String filterName,
                       Configurator filterConfig)

Initialize reads the configuration items for this filter

Specified by:

initialize in interface IDropOffFilter

Overrides:

initialize in class AbstractFilter

Parameters:

configG - the configurator to read from

filterName - the configured name of this filter or null for the default

filterConfig - the configuration for the specific filter

filter

public int filter(IBaseDataObject d,
                  Map<String,Object> params)

Output one payload item

Parameters:

d - the payload

params - the map of configuration items

Returns:

status value

filter

public int filter(IBaseDataObject d,
                  Map<String,Object> params,
                  OutputStream output)

Output one payload item to the provided output stream

Specified by:

filter in interface IDropOffFilter

Overrides:

filter in class AbstractFilter

Parameters:

d - the payload

params - the map of configuration items

output - the output stream to write to

Returns:

status value

isPrimaryViewOutputtable

protected boolean isPrimaryViewOutputtable(String lang,
                                           String fileType,
                                           String currentForm)

isViewOutputtable

protected boolean isViewOutputtable(String lang,
                                    String fileType,
                                    String currentForm,
                                    String viewName)

writeDataFile

protected boolean writeDataFile(IBaseDataObject d,
                                IBaseDataObject tld,
                                String baseFileName,
                                byte[] data,
                                @Nullable
                                String type)

Write a file, either the primary view or an alt view

Parameters:

d - the DataObject to output

tld - the TLD Object to extract metadata (if applicable)

baseFileName - the base file name

data - the bytes to write

type - of data

writeDataStream

protected boolean writeDataStream(IBaseDataObject d,
                                  IBaseDataObject tld,
                                  OutputStream output,
                                  byte[] data,
                                  @Nullable
                                  String type)

main

public static void main(String[] args)

Main to test output types