org.wikidata.wdtk.util.WebResourceFetcherImpl.java Source code

Introduction

Here is the source code for org.wikidata.wdtk.util.WebResourceFetcherImpl.java

Source

package org.wikidata.wdtk.util;

/*
 * #%L
 * Wikidata Toolkit Dump File Handling
 * %%
 * Copyright (C) 2014 Wikidata Toolkit Developers
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.io.IOException;
import java.io.InputStream;
import java.net.InetSocketAddress;
import java.net.Proxy;
import java.net.URL;
import java.net.URLConnection;

import org.apache.commons.lang3.text.translate.AggregateTranslator;

/**
 * Standard implementation of {@link WebResourceFetcher}.
 *
 * @author Markus Kroetzsch
 *
 */
public class WebResourceFetcherImpl implements WebResourceFetcher {

    protected static String userAgent = "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:31.0) Gecko/20100101 Firefox/31.0"; //"Wikidata Toolkit; Java " + System.getProperty("java.version");

    protected static Proxy proxy = null;

    /**
     * Returns the string that will be used to ideintify the user agent on all
     * requests made by Wikidata Toolkit.
     *
     * @return the user agent string
     */
    public static String getUserAgent() {
        return userAgent;
    }

    /**
     * Return the proxy used for the url connection.
     * @return
     */
    public static Proxy getProxy() {
        return proxy;
    }

    /**
     * Sets the string that will be used to ideintify the user agent on all
     * requests made by Wikidata Toolkit. This should be set in own tools based
     * on Wikidata Toolkit esp. when making large amounts of requests.
     *
     * @param userAgent
     *            the user agent string
     */
    public static void setUserAgent(String userAgent) {
        WebResourceFetcherImpl.userAgent = userAgent;
    }

    public void setProxy(Proxy proxy) {
        WebResourceFetcherImpl.proxy = proxy;
    }

    @Override
    public InputStream getInputStreamForUrl(String urlString) throws IOException {
        URL url = new URL(urlString);
        URLConnection urlConnection = null;
        if (proxy != null) {
            //         InetSocketAddress sa = new InetSocketAddress("llproxy.llan.ll.mit.edu", 8080);
            //           Proxy proxy = new Proxy(Proxy.Type.HTTP, sa);
            urlConnection = url.openConnection(proxy);
        } else {
            urlConnection = url.openConnection();
        }

        urlConnection.setRequestProperty("User-Agent", userAgent);

        return urlConnection.getInputStream();
    }

}