org.dbflute.infra.manage.refresh.DfRefreshResourceRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2020 the original author or authors.
 *
 * 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.
 */
package org.dbflute.infra.manage.refresh;

import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.dbflute.util.Srl;

/**
 * The request of (Eclipse's) refresh resource. 

 * You can refresh automatically by this.
 *  * DfRefreshResourceRequest request
 *     = new DfRefreshResourceRequest(projectNameList, requestUrl);
 * request.refreshResources();
 * 
 * @author jflute
 */
public class DfRefreshResourceRequest {

    // ===================================================================================
    //                                                                          Definition
    //                                                                          ==========
    /** The mark of auto-detect, e.g. searching Eclipse .project file. (NotNull) */
    public static final String AUTO_DETECT_MARK = "$$AutoDetect$$"; // basically for engine

    /** The key of result map for response body. (NotNull) */
    public static final String KEY_BODY = "body";

    /** The key of result map for header fields. (NotNull) */
    public static final String KEY_HEADER_FIELDS = "headerFields";

    // ===================================================================================
    //                                                                           Attribute
    //                                                                           =========
    protected final List _projectNameList;
    protected final String _requestUrl;

    // ===================================================================================
    //                                                                         Constructor
    //                                                                         ===========
    /**
     * @param projectNameList The list of project name for refresh. (NotNull)
     * @param requestUrl The request URL for refresh to synchronizer. (NotNull)
     */
    public DfRefreshResourceRequest(List projectNameList, String requestUrl) {
        if (projectNameList == null || projectNameList.isEmpty()) {
            String msg = "The argument 'projectNameList' should not be null or empty: " + projectNameList;
            throw new IllegalArgumentException(msg);
        }
        if (Srl.is_Null_or_TrimmedEmpty(requestUrl)) {
            String msg = "The argument 'requestUrl' should not be null or empty: " + requestUrl;
            throw new IllegalArgumentException(msg);
        }
        _projectNameList = projectNameList;
        _requestUrl = requestUrl;
    }

    // ===================================================================================
    //                                                                             Refresh
    //                                                                             =======
    /**
     * Refresh resources per one project. (request to synchronizer)
     * @return The map of result. map:{projectName = map:{body = ...}} (NotNull)
     * @throws IOException When the refresh failed.
     */
    public Map> refreshResources() throws IOException {
        final Map> resultMap = newResultMap();
        for (String projectName : _projectNameList) {
            resultMap.put(projectName, doRefreshResources(projectName));
        }
        return resultMap;
    }

    protected Map> newResultMap() {
        return new LinkedHashMap>();
    }

    protected Map doRefreshResources(String projectName) throws IOException {
        final String pathAndQuery = buildRefreshPathAndQuery(projectName);
        final URL url = createRefreshRequestURL(pathAndQuery);
        if (url == null) {
            return null;
        }
        InputStream ins = null;
        try {
            final URLConnection conn = openConnect(url);
            ins = conn.getInputStream();
            final Map elementMap = newElementMap();
            setupBasicResult(conn, elementMap, ins);
            handleConnectedConnection(conn, elementMap);
            return elementMap;
        } finally {
            if (ins != null) {
                try {
                    ins.close();
                } catch (IOException ignored) {}
            }
        }
    }

    protected LinkedHashMap newElementMap() {
        return new LinkedHashMap();
    }

    protected String buildRefreshPathAndQuery(String projectName) {
        final StringBuilder sb = new StringBuilder();
        sb.append("refresh?").append(projectName).append("=INFINITE");
        return sb.toString();
    }

    protected void setupBasicResult(URLConnection conn, Map elementMap, InputStream ins) throws IOException {
        final String body = extractResponseBody(ins);
        elementMap.put(KEY_BODY, body);
        elementMap.put(KEY_HEADER_FIELDS, conn.getHeaderFields());
    }

    protected String extractResponseBody(InputStream ins) throws IOException {
        final byte[] body = new byte[1024];
        ins.read(body);
        return new String(body, "UTF-8");
    }

    protected void handleConnectedConnection(URLConnection conn, Map elementMap) throws IOException {
        // do nothing as default: for overriding
    }

    // ===================================================================================
    //                                                                   Connection Helper
    //                                                                   =================
    protected URLConnection openConnect(URL url) throws IOException {
        final URLConnection conn = url.openConnection();
        conn.setReadTimeout(getRefreshRequestReadTimeout());
        conn.connect();
        return conn;
    }

    protected URL createRefreshRequestURL(String path) throws MalformedURLException {
        String requestUrl = _requestUrl;
        if (!requestUrl.endsWith("/")) {
            requestUrl = requestUrl + "/";
        }
        return new URL(requestUrl + path);
    }

    protected int getRefreshRequestReadTimeout() {
        return 3 * 1000;
    }
}