us.codecraft.webmagic.downloader.AbstractDownloader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webmagic-core Show documentation
The newest version!
package us.codecraft.webmagic.downloader;

import us.codecraft.webmagic.Page;
import us.codecraft.webmagic.Request;
import us.codecraft.webmagic.Site;
import us.codecraft.webmagic.Task;
import us.codecraft.webmagic.selector.Html;

/**
 * Base class of downloader with some common methods.
 *
 * @author [email protected]
 * @since 0.5.0
 */
public abstract class AbstractDownloader implements Downloader {

    /**
     * A simple method to download a url.
     *
     * @param url url
     * @return html
     */
    public Html download(String url) {
        return download(url, null);
    }

    /**
     * A simple method to download a url.
     *
     * @param url     url
     * @param charset charset
     * @return html
     */
    public Html download(String url, String charset) {
        Page page = download(new Request(url), Site.me().setCharset(charset).toTask());
        return (Html) page.getHtml();
    }

    /**
     * @param request the {@link Request}.
     * @deprecated Use {@link #onSuccess(Page, Task)} instead.
     */
    @Deprecated
    protected void onSuccess(Request request) {
    }

    /**
     * @param request the {@link Request}.
     * @param task the {@link Task}.
     * @since 0.7.6
     * @deprecated Use {@link #onSuccess(Page, Task)} instead.
     */
    @Deprecated
    protected void onSuccess(Request request, Task task) {
        this.onSuccess(request);
    }

    /**
     * @param page the {@link Page}.
     * @param task the {@link Task}.
     * @since 0.10.0
     */
    protected void onSuccess(Page page, Task task) {
        this.onSuccess(page.getRequest(), task);
    }

    /**
     * @param request the {@link Request}.
     * @deprecated Use {@link #onError(Page, Task, Throwable)} instead.
     */
    @Deprecated
    protected void onError(Request request) {
    }

    /**
     * @param request the {@link Request}.
     * @param task the {@link Task}.
     * @param e the exception.
     * @since 0.7.6
     * @deprecated Use {@link #onError(Page, Task, Throwable)} instead.
     */
    @Deprecated
    protected void onError(Request request, Task task, Throwable e) {
        this.onError(request);
    }

    /**
     * @param page the {@link Page}.
     * @param task the {@link Task}.
     * @param e the exception.
     * @since 0.10.0
     */
    protected void onError(Page page, Task task, Throwable e) {
        this.onError(page.getRequest(), task, e);
    }

}