getDocumentByURL (Database - Java™)

Instantiates a document in the database on which it is called and returns a Document object for it. This method is typically used for either the Server Web Navigator or Personal Web Navigator database, but can be called on any Database object.

Defined in

Database

Syntax

public Document getDocumentByURL(String url, boolean reload)
    throws NotesException
public Document getDocumentByURL(String url, boolean reload, boolean relifmod, boolean urllist, String charset, String webuser, String webpasswd, String proxyuser, String proxypasswd, boolean returnimmediately)
    throws NotesException

Parameters

String url

The desired uniform resource locator (URL), for example, http://www.acme.com. Specify the entire URL starting with http. You can enter a maximum string length of 15K.

boolean reload

Specify true to reload the page from its Internet server. Specify false to load the page from the Internet only if it is not already in the Web Navigator database.

boolean relifmod

(Defaults to the specification for the second parameter) Specify true to reload the page onlyif it has been modified on its Internet server, false to load the page from the Internet only if it is not already in the Web Navigator database.

boolean urllist

(Defaults to false) Web pages can contain URL links to other Web pages. You can specify whether to save the URLs in a field called URLLinksn in the Notes® document. (The Web Navigator creates a new URLLinksn field each time the field size reaches 64K. For example, the first URLLinks field is URLLinks1, the second is URLLinks2, and so on.)

Specify true if you want to save the URLs in the URLLinksn field(s). Specify false if you do not want to save the URLs in the URLLinksn field(s). If you save the URLs, you can use them in agents. For example, you can create an agent that opens Web pages in the Web Navigator database and then loads all the Web pages saved in each of the URLLinksn field(s).

CAUTION: Saving URLs in the URLLinksn field(s) may affect performance.

String charset

(Defaults to null) Enter the MIME character set (for example, ISO-2022-JP for Japanese or ISO-8859-1 for United States) that you want the Web Navigator to use when processing the Web page.

String webuser

(Defaults to null.) Some Internet servers require you to obtain a username before you can access their pages. This parameter allows you to enter the username that you previously obtained from the Full-text server.

String webpasswd

(Defaults to null) Some full-text servers require you to obtain a password before you can access their pages. This parameter allows you to enter the password that you previously obtained from the Internet server.

String proxyuser

(Defaults to null) Some proxy servers require that you specify a username in order to connect through them. This parameter allows you to enter the username for the proxy server. See your administrator for the username required by the proxy.

String proxypasswd

(Defaults to null) Some proxy servers require that you specify a password in order to connect through them. This parameter allows you to enter the password for the proxy server. See your administrator for the password required by the proxy.

boolean returnimmediately

(Defaults to false) Specify true to return immediately and not wait for completion of the retrieval. If you specify true, getDocumentByURL does not return the Document object representing the URL document. This parameter is useful for offline storage purposes; in this case, you do not need the Document object and do not have to wait for completion of the operation. This parameter is ignored and false is forced if the database being opened is not local to the execution context.

Return value


Document

The Notes® document that represents the URL document you specified.

Example