Package com.day.cq.dam.commons.metadata
Class XmpFilterBlackWhite
- java.lang.Object
-
- com.day.cq.dam.commons.metadata.XmpFilterBlackWhite
-
-
Field Summary
Fields Modifier and Type Field Description static String
ApplyBlackList
static String
ApplyWhiteList
static String
BlackList
CQ-4326783: two more default xmpfilter (xmpMM:Pantry and xmpMM:History) were added to avoid the following two issues 1.static String
WhiteList
-
Constructor Summary
Constructors Constructor Description XmpFilterBlackWhite()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InputStream
filter(InputStream xmpIS)
Filter XMP properties from an XML inputstream and return the filtered XML in a new inputstream.boolean
isActive()
void
setConfig(Dictionary cfg)
InputStream
sieve(InputStream xmpIS)
Sieve XMP properties from an XML inputstream and return the properties hold back during filtering in a new XMP document.
-
-
-
Field Detail
-
ApplyWhiteList
@Property(boolValue=false, label="Apply Whitelist to XMP Properties", description="Only let the whitelisted xmp properties through, applied before any blacklist") public static final String ApplyWhiteList
- See Also:
- Constant Field Values
-
WhiteList
@Property(value="", label="Whitelisted XML Names for XMP filtering", description="XML Names, such as \'{namespace-uri}name\', \'{namespace-uri}*\', \'prefix:name\' and \'prefix:*\', passed on during XMP filtering. Use \'[>n]\' or \'[<n]\' to limit the values accepted for multi-valued XMP properties. Example: \'history[<100]\' will only let the first 99 values through", cardinality=2147483647) public static final String WhiteList
- See Also:
- Constant Field Values
-
ApplyBlackList
@Property(boolValue=true, label="Apply Blacklist to XMP Properties", description="Filter out the blacklisted xmp properties, applied after any whitelisting") public static final String ApplyBlackList
- See Also:
- Constant Field Values
-
BlackList
@Property(value={"{http://ns.adobe.com/photoshop/1.0/}DocumentAncestors[>100]","xmpMM:Pantry","xmpMM:History"}, label="Blacklisted XML Names for XMP filtering", description="XML Names, such as \'{namespace-uri}name\', \'{namespace-uri}*\', \'prefix:name\' and \'prefix:*\', filtered out during XMP processing. Use \'[>n]\' or \'[<n]\' to limit the values removed for multi-valued XMP properties. Example: \'history[>100]\' discards the 101st and following values.", cardinality=2147483647) public static final String BlackList
CQ-4326783: two more default xmpfilter (xmpMM:Pantry and xmpMM:History) were added to avoid the following two issues 1. a slow UI performance 2. a customer's environment crashed during metadata extraction- See Also:
- Constant Field Values
-
-
Method Detail
-
setConfig
public void setConfig(Dictionary cfg)
-
filter
public InputStream filter(InputStream xmpIS) throws IOException
Description copied from interface:XmpFilter
Filter XMP properties from an XML inputstream and return the filtered XML in a new inputstream.- Specified by:
filter
in interfaceXmpFilter
- Parameters:
xmpIS
- the XML for filtering- Returns:
- the filtered XML in utf-8 encoding
- Throws:
IOException
-
sieve
public InputStream sieve(InputStream xmpIS) throws IOException
Description copied from interface:XmpFilter
Sieve XMP properties from an XML inputstream and return the properties hold back during filtering in a new XMP document. Sieving is the opposite of filtering in regard to XMP XMP elements with one exception: sieve will never return partial properties. This means,XmpFilter.filter(InputStream)
may return the partial contents of an array XMP property (e.g. the first 10 entries).XmpFilter.sieve(InputStream)
will either report the complete array or ignore the property. Example: during ingestion, all but the first entry in xmpMM:History is filtered. The reported metadata contains just this one entry. If this metadata was written back to the document, all existing subsequent xmpMM:History entries would be overwritten and lost. TheXmpFilter.sieve(InputStream)
, called on the original data, will return such a property in full, e.g. the complete xmpMM:History. This allows the caller to merge changes as it desires.- Specified by:
sieve
in interfaceXmpFilter
- Parameters:
xmpIS
- the XML for sieving- Returns:
- the filtered XML in utf-8 encoding
- Throws:
IOException
-
-