Package org.jsoup

Class Jsoup


  • public class Jsoup
    extends java.lang.Object
    The core public access point to the jsoup functionality.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Jsoup()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String clean​(java.lang.String bodyHtml, java.lang.String baseUri, Whitelist whitelist)
      Get safe HTML from untrusted input HTML, by parsing input HTML and filtering it through a white-list of permitted tags and attributes.
      static java.lang.String clean​(java.lang.String bodyHtml, java.lang.String baseUri, Whitelist whitelist, Document.OutputSettings outputSettings)
      Get safe HTML from untrusted input HTML, by parsing input HTML and filtering it through a white-list of permitted tags and attributes.
      static java.lang.String clean​(java.lang.String bodyHtml, Whitelist whitelist)
      Get safe HTML from untrusted input HTML, by parsing input HTML and filtering it through a white-list of permitted tags and attributes.
      static Connection connect​(java.lang.String url)
      Creates a new Connection to a URL.
      static boolean isValid​(java.lang.String bodyHtml, Whitelist whitelist)
      Test if the input body HTML has only tags and attributes allowed by the Whitelist.
      static Document parse​(java.io.File in, java.lang.String charsetName)
      Parse the contents of a file as HTML.
      static Document parse​(java.io.File in, java.lang.String charsetName, java.lang.String baseUri)
      Parse the contents of a file as HTML.
      static Document parse​(java.io.InputStream in, java.lang.String charsetName, java.lang.String baseUri)
      Read an input stream, and parse it to a Document.
      static Document parse​(java.io.InputStream in, java.lang.String charsetName, java.lang.String baseUri, Parser parser)
      Read an input stream, and parse it to a Document.
      static Document parse​(java.lang.String html)
      Parse HTML into a Document.
      static Document parse​(java.lang.String html, java.lang.String baseUri)
      Parse HTML into a Document.
      static Document parse​(java.lang.String html, java.lang.String baseUri, Parser parser)
      Parse HTML into a Document, using the provided Parser.
      static Document parse​(java.net.URL url, int timeoutMillis)
      Fetch a URL, and parse it as HTML.
      static Document parseBodyFragment​(java.lang.String bodyHtml)
      Parse a fragment of HTML, with the assumption that it forms the body of the HTML.
      static Document parseBodyFragment​(java.lang.String bodyHtml, java.lang.String baseUri)
      Parse a fragment of HTML, with the assumption that it forms the body of the HTML.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Jsoup

        private Jsoup()
    • Method Detail

      • parse

        public static Document parse​(java.lang.String html,
                                     java.lang.String baseUri)
        Parse HTML into a Document. The parser will make a sensible, balanced document tree out of any HTML.
        Parameters:
        html - HTML to parse
        baseUri - The URL where the HTML was retrieved from. Used to resolve relative URLs to absolute URLs, that occur before the HTML declares a <base href> tag.
        Returns:
        sane HTML
      • parse

        public static Document parse​(java.lang.String html,
                                     java.lang.String baseUri,
                                     Parser parser)
        Parse HTML into a Document, using the provided Parser. You can provide an alternate parser, such as a simple XML (non-HTML) parser.
        Parameters:
        html - HTML to parse
        baseUri - The URL where the HTML was retrieved from. Used to resolve relative URLs to absolute URLs, that occur before the HTML declares a <base href> tag.
        parser - alternate parser to use.
        Returns:
        sane HTML
      • parse

        public static Document parse​(java.lang.String html)
        Parse HTML into a Document. As no base URI is specified, absolute URL detection relies on the HTML including a <base href> tag.
        Parameters:
        html - HTML to parse
        Returns:
        sane HTML
        See Also:
        parse(String, String)
      • connect

        public static Connection connect​(java.lang.String url)
        Creates a new Connection to a URL. Use to fetch and parse a HTML page.

        Use examples:

        • Document doc = Jsoup.connect("http://example.com").userAgent("Mozilla").data("name", "jsoup").get();
        • Document doc = Jsoup.connect("http://example.com").cookie("auth", "token").post();
        Parameters:
        url - URL to connect to. The protocol must be http or https.
        Returns:
        the connection. You can add data, cookies, and headers; set the user-agent, referrer, method; and then execute.
      • parse

        public static Document parse​(java.io.File in,
                                     java.lang.String charsetName,
                                     java.lang.String baseUri)
                              throws java.io.IOException
        Parse the contents of a file as HTML.
        Parameters:
        in - file to load HTML from
        charsetName - (optional) character set of file contents. Set to null to determine from http-equiv meta tag, if present, or fall back to UTF-8 (which is often safe to do).
        baseUri - The URL where the HTML was retrieved from, to resolve relative links against.
        Returns:
        sane HTML
        Throws:
        java.io.IOException - if the file could not be found, or read, or if the charsetName is invalid.
      • parse

        public static Document parse​(java.io.File in,
                                     java.lang.String charsetName)
                              throws java.io.IOException
        Parse the contents of a file as HTML. The location of the file is used as the base URI to qualify relative URLs.
        Parameters:
        in - file to load HTML from
        charsetName - (optional) character set of file contents. Set to null to determine from http-equiv meta tag, if present, or fall back to UTF-8 (which is often safe to do).
        Returns:
        sane HTML
        Throws:
        java.io.IOException - if the file could not be found, or read, or if the charsetName is invalid.
        See Also:
        parse(File, String, String)
      • parse

        public static Document parse​(java.io.InputStream in,
                                     java.lang.String charsetName,
                                     java.lang.String baseUri)
                              throws java.io.IOException
        Read an input stream, and parse it to a Document.
        Parameters:
        in - input stream to read. Make sure to close it after parsing.
        charsetName - (optional) character set of file contents. Set to null to determine from http-equiv meta tag, if present, or fall back to UTF-8 (which is often safe to do).
        baseUri - The URL where the HTML was retrieved from, to resolve relative links against.
        Returns:
        sane HTML
        Throws:
        java.io.IOException - if the file could not be found, or read, or if the charsetName is invalid.
      • parse

        public static Document parse​(java.io.InputStream in,
                                     java.lang.String charsetName,
                                     java.lang.String baseUri,
                                     Parser parser)
                              throws java.io.IOException
        Read an input stream, and parse it to a Document. You can provide an alternate parser, such as a simple XML (non-HTML) parser.
        Parameters:
        in - input stream to read. Make sure to close it after parsing.
        charsetName - (optional) character set of file contents. Set to null to determine from http-equiv meta tag, if present, or fall back to UTF-8 (which is often safe to do).
        baseUri - The URL where the HTML was retrieved from, to resolve relative links against.
        parser - alternate parser to use.
        Returns:
        sane HTML
        Throws:
        java.io.IOException - if the file could not be found, or read, or if the charsetName is invalid.
      • parseBodyFragment

        public static Document parseBodyFragment​(java.lang.String bodyHtml,
                                                 java.lang.String baseUri)
        Parse a fragment of HTML, with the assumption that it forms the body of the HTML.
        Parameters:
        bodyHtml - body HTML fragment
        baseUri - URL to resolve relative URLs against.
        Returns:
        sane HTML document
        See Also:
        Document.body()
      • parseBodyFragment

        public static Document parseBodyFragment​(java.lang.String bodyHtml)
        Parse a fragment of HTML, with the assumption that it forms the body of the HTML.
        Parameters:
        bodyHtml - body HTML fragment
        Returns:
        sane HTML document
        See Also:
        Document.body()
      • parse

        public static Document parse​(java.net.URL url,
                                     int timeoutMillis)
                              throws java.io.IOException
        Fetch a URL, and parse it as HTML. Provided for compatibility; in most cases use connect(String) instead.

        The encoding character set is determined by the content-type header or http-equiv meta tag, or falls back to UTF-8.

        Parameters:
        url - URL to fetch (with a GET). The protocol must be http or https.
        timeoutMillis - Connection and read timeout, in milliseconds. If exceeded, IOException is thrown.
        Returns:
        The parsed HTML.
        Throws:
        java.net.MalformedURLException - if the request URL is not a HTTP or HTTPS URL, or is otherwise malformed
        HttpStatusException - if the response is not OK and HTTP response errors are not ignored
        UnsupportedMimeTypeException - if the response mime type is not supported and those errors are not ignored
        java.net.SocketTimeoutException - if the connection times out
        java.io.IOException - if a connection or read error occurs
        See Also:
        connect(String)
      • clean

        public static java.lang.String clean​(java.lang.String bodyHtml,
                                             java.lang.String baseUri,
                                             Whitelist whitelist)
        Get safe HTML from untrusted input HTML, by parsing input HTML and filtering it through a white-list of permitted tags and attributes.
        Parameters:
        bodyHtml - input untrusted HTML (body fragment)
        baseUri - URL to resolve relative URLs against
        whitelist - white-list of permitted HTML elements
        Returns:
        safe HTML (body fragment)
        See Also:
        Cleaner.clean(Document)
      • clean

        public static java.lang.String clean​(java.lang.String bodyHtml,
                                             Whitelist whitelist)
        Get safe HTML from untrusted input HTML, by parsing input HTML and filtering it through a white-list of permitted tags and attributes.
        Parameters:
        bodyHtml - input untrusted HTML (body fragment)
        whitelist - white-list of permitted HTML elements
        Returns:
        safe HTML (body fragment)
        See Also:
        Cleaner.clean(Document)
      • clean

        public static java.lang.String clean​(java.lang.String bodyHtml,
                                             java.lang.String baseUri,
                                             Whitelist whitelist,
                                             Document.OutputSettings outputSettings)
        Get safe HTML from untrusted input HTML, by parsing input HTML and filtering it through a white-list of permitted tags and attributes.

        The HTML is treated as a body fragment; it's expected the cleaned HTML will be used within the body of an existing document. If you want to clean full documents, use Cleaner.clean(Document) instead, and add structural tags (html, head, body etc) to the whitelist.

        Parameters:
        bodyHtml - input untrusted HTML (body fragment)
        baseUri - URL to resolve relative URLs against
        whitelist - white-list of permitted HTML elements
        outputSettings - document output settings; use to control pretty-printing and entity escape modes
        Returns:
        safe HTML (body fragment)
        See Also:
        Cleaner.clean(Document)
      • isValid

        public static boolean isValid​(java.lang.String bodyHtml,
                                      Whitelist whitelist)
        Test if the input body HTML has only tags and attributes allowed by the Whitelist. Useful for form validation.

        The input HTML should still be run through the cleaner to set up enforced attributes, and to tidy the output.

        Assumes the HTML is a body fragment (i.e. will be used in an existing HTML document body.)

        Parameters:
        bodyHtml - HTML to test
        whitelist - whitelist to test against
        Returns:
        true if no tags or attributes were removed; false otherwise
        See Also:
        clean(String, org.jsoup.safety.Whitelist)