com.liferay.portal.kernel.template.URLTemplateResource.java Source code

Introduction

Here is the source code for com.liferay.portal.kernel.template.URLTemplateResource.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.kernel.template;

import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.util.URLUtil;
import com.liferay.portal.kernel.util.Validator;

import java.io.IOException;
import java.io.InputStreamReader;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.io.Reader;

import java.net.URL;
import java.net.URLConnection;

/**
 * @author Tina Tian
 */
public class URLTemplateResource implements TemplateResource {

    /**
     * The empty constructor is required by {@link java.io.Externalizable}. Do
     * not use this for any other purpose.
     */
    public URLTemplateResource() {
    }

    public URLTemplateResource(String templateId, URL templateURL) {
        if (Validator.isNull(templateId)) {
            throw new IllegalArgumentException("Template ID is null");
        }

        if (templateURL == null) {
            throw new IllegalArgumentException("Template URL is null");
        }

        _templateId = templateId;
        _templateURL = templateURL;
        _templateURLExternalForm = templateURL.toExternalForm();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }

        if (!(obj instanceof URLTemplateResource)) {
            return false;
        }

        URLTemplateResource urlTemplateResource = (URLTemplateResource) obj;

        if (_templateId.equals(urlTemplateResource._templateId)
                && _templateURLExternalForm.equals(urlTemplateResource._templateURLExternalForm)) {

            return true;
        }

        return false;
    }

    @Override
    public long getLastModified() {
        try {
            return URLUtil.getLastModifiedTime(_templateURL);
        } catch (IOException ioe) {
            _log.error("Unable to get last modified time for template " + _templateId, ioe);

            return 0;
        }
    }

    @Override
    public Reader getReader() throws IOException {
        URLConnection urlConnection = _templateURL.openConnection();

        return new InputStreamReader(urlConnection.getInputStream(), TemplateConstants.DEFAUT_ENCODING);
    }

    @Override
    public String getTemplateId() {
        return _templateId;
    }

    @Override
    public int hashCode() {
        return _templateId.hashCode() * 11 + _templateURLExternalForm.hashCode();
    }

    @Override
    public void readExternal(ObjectInput objectInput) throws IOException {
        _templateId = objectInput.readUTF();

        _templateURLExternalForm = objectInput.readUTF();

        _templateURL = new URL(_templateURLExternalForm);
    }

    @Override
    public void writeExternal(ObjectOutput objectOutput) throws IOException {
        objectOutput.writeUTF(_templateId);
        objectOutput.writeUTF(_templateURLExternalForm);
    }

    private static final Log _log = LogFactoryUtil.getLog(URLTemplateResource.class);

    private String _templateId;
    private URL _templateURL;
    private String _templateURLExternalForm;

}