org.apache.shindig.gadgets.spec.Preload.java Source code

Introduction

Here is the source code for org.apache.shindig.gadgets.spec.Preload.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.shindig.gadgets.spec;

import org.apache.shindig.common.uri.Uri;
import org.apache.shindig.common.xml.XmlUtil;
import org.apache.shindig.gadgets.AuthType;
import org.apache.shindig.gadgets.variables.Substitutions;

import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Maps;

import org.apache.commons.lang.StringUtils;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

/**
 * Represents an addressable piece of content that can be preloaded by the server
 * to satisfy makeRequest calls
 */
public class Preload implements RequestAuthenticationInfo {
    private static final Set<String> KNOWN_ATTRIBUTES = ImmutableSet.of("views", "href", "authz", "sign_owner",
            "sign_viewer");

    private final Uri base;

    /**
     * Creates a new Preload from an xml node.
     *
     * @param preload The Preload to create
     * @throws SpecParserException When the href is not specified
     */
    public Preload(Element preload, Uri base) throws SpecParserException {
        this.base = base;
        href = XmlUtil.getUriAttribute(preload, "href");
        if (href == null) {
            throw new SpecParserException("Preload/@href is missing or invalid.");
        }

        // Record all the associated views
        String viewNames = XmlUtil.getAttribute(preload, "views", "").trim();
        if (viewNames.length() == 0) {
            this.views = ImmutableSet.of();
        } else {
            this.views = ImmutableSet.copyOf(viewNames.trim().split("\\s*,+\\s*"));
        }

        auth = AuthType.parse(XmlUtil.getAttribute(preload, "authz"));
        signOwner = XmlUtil.getBoolAttribute(preload, "sign_owner", true);
        signViewer = XmlUtil.getBoolAttribute(preload, "sign_viewer", true);
        Map<String, String> attributes = Maps.newHashMap();
        NamedNodeMap attrs = preload.getAttributes();
        for (int i = 0; i < attrs.getLength(); ++i) {
            Node attr = attrs.item(i);
            if (!KNOWN_ATTRIBUTES.contains(attr.getNodeName())) {
                attributes.put(attr.getNodeName(), attr.getNodeValue());
            }
        }
        this.attributes = Collections.unmodifiableMap(attributes);
    }

    private Preload(Preload preload, Substitutions substituter) {
        base = preload.base;
        views = preload.views;
        auth = preload.auth;
        signOwner = preload.signOwner;
        signViewer = preload.signViewer;
        href = base.resolve(substituter.substituteUri(preload.href));
        Map<String, String> attributes = Maps.newHashMap();
        for (Map.Entry<String, String> entry : preload.attributes.entrySet()) {
            attributes.put(entry.getKey(), substituter.substituteString(entry.getValue()));
        }
        this.attributes = Collections.unmodifiableMap(attributes);
    }

    /**
     * Preload@href
     */
    private final Uri href;

    public Uri getHref() {
        return href;
    }

    /**
     * Preload@auth
     */
    private final AuthType auth;

    public AuthType getAuthType() {
        return auth;
    }

    /**
     * Preload/@sign_owner
     */
    private final boolean signOwner;

    public boolean isSignOwner() {
        return signOwner;
    }

    /**
     * Preload/@sign_viewer
     */
    private final boolean signViewer;

    public boolean isSignViewer() {
        return signViewer;
    }

    /**
     * All attributes from the preload tag
     */
    private final Map<String, String> attributes;

    public Map<String, String> getAttributes() {
        return attributes;
    }

    /**
     * Prelaod@views
     */
    private final Set<String> views;

    public Set<String> getViews() {
        return views;
    }

    public Preload substitute(Substitutions substituter) {
        return new Preload(this, substituter);
    }

    /**
     * Produces an xml representation of the Preload.
     */
    @Override
    public String toString() {
        StringBuilder buf = new StringBuilder();
        buf.append("<Preload href='").append(href).append('\'').append(" authz='")
                .append(auth.toString().toLowerCase()).append('\'').append(" views='")
                .append(StringUtils.join(views, ',')).append('\'');
        for (Map.Entry<String, String> entry : attributes.entrySet()) {
            buf.append(' ').append(entry.getKey()).append("='").append(entry.getValue()).append('\'');
        }
        buf.append("/>");
        return buf.toString();
    }
}