Modifier and Type	Class and Description
private static class	WireFeedInput.EmptyEntityResolver

Modifier and Type	Field and Description
private boolean	allowDoctypes
private static Map<ClassLoader, FeedParsers>	clMap
private static final InputSource	EMPTY_INPUTSOURCE
private final Locale	locale
private static final EntityResolver	RESOLVER
private final boolean	validate
private boolean	xmlHealerOn

Access	Constructor and Description
public	WireFeedInput() Creates a WireFeedInput instance with input validation turned off.
public	WireFeedInput(final boolean indicates if the input should be validated. NOT IMPLEMENTED YET (validation does not happen) validate, final Locale locale) Creates a WireFeedInput instance.

Method Summary

Modifier and Type	Method and Description
public WireFeed	Returns: the WireFeed read from the file. build(final File file to read to create the WireFeed. file) Builds an WireFeed (RSS or Atom) from a file.
public WireFeed	Returns: the WireFeed read from the Reader. build(Reader Reader to read to create the WireFeed. reader) Builds an WireFeed (RSS or Atom) from an Reader.
public WireFeed	Returns: the WireFeed read from the W3C SAX InputSource. build(final InputSource W3C SAX InputSource to read to create the WireFeed. is) Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource.
public WireFeed	Returns: the WireFeed read from the W3C DOM document. build(final Document W3C DOM document to read to create the WireFeed. document) Builds an WireFeed (RSS or Atom) from an W3C DOM document.
public WireFeed	Returns: the WireFeed read from the JDOM document. build(final Document JDOM document to read to create the WireFeed. document) Builds an WireFeed (RSS or Atom) from an JDOM document.
protected SAXBuilder	Returns: a new org.jdom2.input.SAXBuilder object createSAXBuilder() Creates and sets up a org.jdom2.input.SAXBuilder for parsing.
private static FeedParsers	getFeedParsers()
public static List<String>	Returns: a list of String elements with the supported input feed types. getSupportedFeedTypes() Returns the list of supported input feed types.
public boolean	Returns: TRUE if healing is enabled, FALSE if not. getXmlHealerOn() Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream.
public boolean	Returns: true when Doctype declarations are allowed, false otherwise isAllowDoctypes() Indicates whether Doctype declarations are allowed.
private boolean	isFeatureSupported(XMLReader parser, String feature, boolean value)
public void	setAllowDoctypes(boolean true when Doctype declarations should be allowed again, false otherwise allowDoctypes) Since ROME 1.5.1 we fixed a security vulnerability by disallowing Doctype declarations by default.
private void	setFeature(SAXBuilder saxBuilder, XMLReader parser, String feature, boolean value)
public void	setXmlHealerOn(final boolean TRUE enables stream healing, FALSE disables it. heals) Enables XML healing in the WiredFeedInput instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowDoctypes	back to summary
private boolean allowDoctypes

clMap	back to summary
private static Map<ClassLoader, FeedParsers> clMap

EMPTY_INPUTSOURCE	back to summary
private static final InputSource EMPTY_INPUTSOURCE

locale	back to summary
private final Locale locale

RESOLVER	back to summary
private static final EntityResolver RESOLVER

validate	back to summary
private final boolean validate

xmlHealerOn	back to summary
private boolean xmlHealerOn

Constructor Detail

WireFeedInput	back to summary
public WireFeedInput() Creates a WireFeedInput instance with input validation turned off.

WireFeedInput

back to summary

public WireFeedInput()

Creates a WireFeedInput instance with input validation turned off.

WireFeedInput	back to summary
public WireFeedInput(final boolean validate, final Locale locale) Creates a WireFeedInput instance. Parameters validate:boolean indicates if the input should be validated. NOT IMPLEMENTED YET (validation does not happen)

WireFeedInput

back to summary

public WireFeedInput(final boolean validate, final Locale locale)

Creates a WireFeedInput instance.

Parameters

validate:boolean: indicates if the input should be validated. NOT IMPLEMENTED YET (validation does not happen)

Method Detail

build	back to summary
public WireFeed build(final File file) throws FileNotFoundException, IOException, IllegalArgumentException, FeedException Builds an WireFeed (RSS or Atom) from a file. Note This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom2.Document)'. Parameters file:File file to read to create the WireFeed. Returns:WireFeed the WireFeed read from the file. Exceptions FileNotFoundException: thrown if the file could not be found. IOException: thrown if there is problem reading the file. IllegalArgumentException: thrown if feed type could not be understood by any of the underlying parsers. FeedException: if the feed could not be parsed

build

back to summary

public WireFeed build(final File file) throws FileNotFoundException, IOException, IllegalArgumentException, FeedException

Builds an WireFeed (RSS or Atom) from a file.

Note

This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom2.Document)'.

Parameters

file:File: file to read to create the WireFeed.

Returns:WireFeed

the WireFeed read from the file.

Exceptions

FileNotFoundException:: thrown if the file could not be found.
IOException:: thrown if there is problem reading the file.
IllegalArgumentException:: thrown if feed type could not be understood by any of the underlying parsers.
FeedException:: if the feed could not be parsed

build	back to summary
public WireFeed build(Reader reader) throws IllegalArgumentException, FeedException Builds an WireFeed (RSS or Atom) from an Reader. Note This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom2.Document)'. Parameters reader:Reader Reader to read to create the WireFeed. Returns:WireFeed the WireFeed read from the Reader. Exceptions IllegalArgumentException: thrown if feed type could not be understood by any of the underlying parsers. FeedException: if the feed could not be parsed

build

back to summary

public WireFeed build(Reader reader) throws IllegalArgumentException, FeedException

Builds an WireFeed (RSS or Atom) from an Reader.

Note

This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom2.Document)'.

Parameters

reader:Reader: Reader to read to create the WireFeed.

Returns:WireFeed

the WireFeed read from the Reader.

Exceptions

IllegalArgumentException:: thrown if feed type could not be understood by any of the underlying parsers.
FeedException:: if the feed could not be parsed

build	back to summary
public WireFeed build(final InputSource is) throws IllegalArgumentException, FeedException Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource. Note This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom2.Document)'. Parameters is:InputSource W3C SAX InputSource to read to create the WireFeed. Returns:WireFeed the WireFeed read from the W3C SAX InputSource. Exceptions IllegalArgumentException: thrown if feed type could not be understood by any of the underlying parsers. FeedException: if the feed could not be parsed

build

back to summary

public WireFeed build(final InputSource is) throws IllegalArgumentException, FeedException

Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource.

Note

This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom2.Document)'.

Parameters

is:InputSource: W3C SAX InputSource to read to create the WireFeed.

Returns:WireFeed

the WireFeed read from the W3C SAX InputSource.

Exceptions

IllegalArgumentException:: thrown if feed type could not be understood by any of the underlying parsers.
FeedException:: if the feed could not be parsed

build	back to summary
public WireFeed build(final Document document) throws IllegalArgumentException, FeedException Builds an WireFeed (RSS or Atom) from an W3C DOM document. Note This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom2.Document)'. Parameters document:Document W3C DOM document to read to create the WireFeed. Returns:WireFeed the WireFeed read from the W3C DOM document. Exceptions IllegalArgumentException: thrown if feed type could not be understood by any of the underlying parsers. FeedException: if the feed could not be parsed

build

back to summary

public WireFeed build(final Document document) throws IllegalArgumentException, FeedException

Builds an WireFeed (RSS or Atom) from an W3C DOM document.

Note

This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom2.Document)'.

Parameters

document:Document: W3C DOM document to read to create the WireFeed.

Returns:WireFeed

the WireFeed read from the W3C DOM document.

Exceptions

IllegalArgumentException:: thrown if feed type could not be understood by any of the underlying parsers.
FeedException:: if the feed could not be parsed

build	back to summary
public WireFeed build(final Document document) throws IllegalArgumentException, FeedException Builds an WireFeed (RSS or Atom) from an JDOM document. Note All other build methods delegate to this method. Parameters document:Document JDOM document to read to create the WireFeed. Returns:WireFeed the WireFeed read from the JDOM document. Exceptions IllegalArgumentException: thrown if feed type could not be understood by any of the underlying parsers. FeedException: if the feed could not be parsed

build

back to summary

public WireFeed build(final Document document) throws IllegalArgumentException, FeedException

Builds an WireFeed (RSS or Atom) from an JDOM document.

Note

All other build methods delegate to this method.

Parameters

document:Document: JDOM document to read to create the WireFeed.

Returns:WireFeed

the WireFeed read from the JDOM document.

Exceptions

IllegalArgumentException:: thrown if feed type could not be understood by any of the underlying parsers.
FeedException:: if the feed could not be parsed

createSAXBuilder	back to summary
protected SAXBuilder createSAXBuilder() Creates and sets up a org.jdom2.input.SAXBuilder for parsing. Returns:SAXBuilder a new org.jdom2.input.SAXBuilder object

createSAXBuilder

back to summary

protected SAXBuilder createSAXBuilder()

Creates and sets up a org.jdom2.input.SAXBuilder for parsing.

Returns:SAXBuilder: a new org.jdom2.input.SAXBuilder object

getFeedParsers	back to summary
private static FeedParsers getFeedParsers()

getSupportedFeedTypes	back to summary
public static List<String> getSupportedFeedTypes() Returns the list of supported input feed types. Returns:List<String> a list of String elements with the supported input feed types. See Also {@link WireFeed} for details on the format of these strings.

getSupportedFeedTypes

back to summary

public static List<String> getSupportedFeedTypes()

Returns the list of supported input feed types.

Returns:List<String>: a list of String elements with the supported input feed types.
See Also: {@link WireFeed} for details on the format of these strings.

getXmlHealerOn	back to summary
public boolean getXmlHealerOn() Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream. Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog. Healing resolves HTML entities (from literal to code number) in the reader. The healing is done only with the build(File) and build(Reader) signatures. By default is TRUE. Returns:boolean TRUE if healing is enabled, FALSE if not.

getXmlHealerOn

back to summary

public boolean getXmlHealerOn()

Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream.

Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog.

Healing resolves HTML entities (from literal to code number) in the reader.

The healing is done only with the build(File) and build(Reader) signatures.

By default is TRUE.

Returns:boolean: TRUE if healing is enabled, FALSE if not.

isAllowDoctypes	back to summary
public boolean isAllowDoctypes() Indicates whether Doctype declarations are allowed. Returns:boolean true when Doctype declarations are allowed, false otherwise

isAllowDoctypes

back to summary

public boolean isAllowDoctypes()

Indicates whether Doctype declarations are allowed.

Returns:boolean: true when Doctype declarations are allowed, false otherwise

isFeatureSupported	back to summary
private boolean isFeatureSupported(XMLReader parser, String feature, boolean value)

setAllowDoctypes	back to summary
public void setAllowDoctypes(boolean allowDoctypes) Since ROME 1.5.1 we fixed a security vulnerability by disallowing Doctype declarations by default. This change breaks the compatibility with at least RSS 0.91N because it requires a Doctype declaration. You are able to allow Doctype declarations again with this property. You should only activate it when the feeds that you process are absolutely trustful. Parameters allowDoctypes:boolean true when Doctype declarations should be allowed again, false otherwise

setAllowDoctypes

back to summary

public void setAllowDoctypes(boolean allowDoctypes)

Since ROME 1.5.1 we fixed a security vulnerability by disallowing Doctype declarations by default. This change breaks the compatibility with at least RSS 0.91N because it requires a Doctype declaration. You are able to allow Doctype declarations again with this property. You should only activate it when the feeds that you process are absolutely trustful.

Parameters

allowDoctypes:boolean: true when Doctype declarations should be allowed again, false otherwise

setFeature	back to summary
private void setFeature(SAXBuilder saxBuilder, XMLReader parser, String feature, boolean value)

setXmlHealerOn	back to summary
public void setXmlHealerOn(final boolean heals) Enables XML healing in the WiredFeedInput instance. Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog. Healing resolves HTML entities (from literal to code number) in the reader. The healing is done only with the build(File) and build(Reader) signatures. By default is TRUE. Parameters heals:boolean TRUE enables stream healing, FALSE disables it.

setXmlHealerOn

back to summary

public void setXmlHealerOn(final boolean heals)

Enables XML healing in the WiredFeedInput instance.

Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog.

Healing resolves HTML entities (from literal to code number) in the reader.

The healing is done only with the build(File) and build(Reader) signatures.

By default is TRUE.

Parameters

heals:boolean: TRUE enables stream healing, FALSE disables it.

com.rometools.rome.io back to summary

private Class WireFeedInput.EmptyEntityResolver

Class Inheritance

extends Object
implements EntityResolver

java.lang.Object
com.rometools.rome.io.WireFeedInput.EmptyEntityResolver

All Implemented Interfaces

org.xml.sax.EntityResolver

Constructor Summary

Access	Constructor and Description
private	EmptyEntityResolver()

Method Summary

Modifier and Type	Method and Description
public InputSource	resolveEntity(final String The public identifier of the external entity being referenced, or null if none was supplied. publicId, final String The system identifier of the external entity being referenced. systemId) Implements org.xml.sax.EntityResolver.resolveEntity. Allow the application to resolve external entities.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

EmptyEntityResolver	back to summary
private EmptyEntityResolver()

Method Detail

resolveEntity	back to summary
public InputSource resolveEntity(final String publicId, final String systemId) Implements org.xml.sax.EntityResolver.resolveEntity. Doc from org.xml.sax.EntityResolver.resolveEntity. Allow the application to resolve external entities. The parser will call this method before opening any external entity except the top-level document entity. Such entities include the external DTD subset and external parameter entities referenced within the DTD (in either case, only if the parser reads external parameter entities), and external general entities referenced within the document element (if the parser reads external general entities). The application may request that the parser locate the entity itself, that it use an alternative URI, or that it use data provided by the application (as a character or byte input stream). Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box). Neither XML nor SAX specifies a preferred policy for using public or system IDs to resolve resources. However, SAX specifies how to interpret any InputSource returned by this method, and that if none is returned, then the system ID will be dereferenced as a URL. If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application. Parameters publicId:String The public identifier of the external entity being referenced, or null if none was supplied. systemId:String The system identifier of the external entity being referenced. Returns:InputSource An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier. Annotations @Override

resolveEntity

back to summary

public InputSource resolveEntity(final String publicId, final String systemId)

Implements org.xml.sax.EntityResolver.resolveEntity.

Doc from org.xml.sax.EntityResolver.resolveEntity.

Allow the application to resolve external entities.

The parser will call this method before opening any external entity except the top-level document entity. Such entities include the external DTD subset and external parameter entities referenced within the DTD (in either case, only if the parser reads external parameter entities), and external general entities referenced within the document element (if the parser reads external general entities). The application may request that the parser locate the entity itself, that it use an alternative URI, or that it use data provided by the application (as a character or byte input stream).

Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box). Neither XML nor SAX specifies a preferred policy for using public or system IDs to resolve resources. However, SAX specifies how to interpret any InputSource returned by this method, and that if none is returned, then the system ID will be dereferenced as a URL.

If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application.

Parameters

publicId:String: The public identifier of the external entity being referenced, or null if none was supplied.
systemId:String: The system identifier of the external entity being referenced.

Returns:InputSource

An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier.

Annotations

@Override

public Class WireFeedInput

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WireFeedInput.EmptyEntityResolver

Constructor Summary

Method Summary

Constructor Detail

Method Detail