com.google.gwt.dev.codeserver.OutboxTable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of vaadin-client-compiler Show documentation

Vaadin is a web application framework for Rich Internet Applications (RIA). Vaadin enables easy development and maintenance of fast and secure rich web applications with a stunning look and feel and a wide browser support. It features a server-side architecture with the majority of the logic running on the server. Ajax technology is used at the browser-side to ensure a rich and interactive user experience.

There is a newer version: 8.25.2

Show newest version

/*
 * Copyright 2011 Google Inc.
 *
 * 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 com.google.gwt.dev.codeserver;

import com.google.gwt.core.ext.TreeLogger;
import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.thirdparty.guava.common.collect.ImmutableList;
import com.google.gwt.thirdparty.guava.common.collect.Lists;
import com.google.gwt.thirdparty.guava.common.collect.Maps;

import java.io.File;
import java.util.Collection;
import java.util.List;
import java.util.Map;

/**
 * An in-memory table of all the outboxes available on this code server. The {@link WebServer}
 * uses this directory to find the {@link Outbox} associated with a URL and to list all the
 * modules on the front page.
 */
class OutboxTable {

  /**
   * A map from outbox id (an opaque string) to its outbox.
   */
  private final Map outboxes = Maps.newHashMap();

  /**
   * Adds a {@link Outbox} to the table.
   */
  void addOutbox(Outbox outbox) {
    outboxes.put(outbox.getId(), outbox);
  }

  ImmutableList getOutboxes() {
    return ImmutableList.copyOf(outboxes.values());
  }

  /**
   * Retrieves an {@link Outbox} corresponding to a given module name.
   * This should be the module name after renaming.
   * TODO: callers should use an Outbox id instead.
   */
  Outbox findByOutputModuleName(String moduleName) {
    for (Outbox box : outboxes.values()) {
      if (box.getOutputModuleName().equals(moduleName)) {
        return box;
      }
    }
    return null;
  }

  /**
   * Returns the list of known module names (after renaming).
   */
  Collection getOutputModuleNames() {
    List result = Lists.newArrayList();
    for (Outbox box : outboxes.values()) {
      result.add(box.getOutputModuleName());
    }
    return result;
  }

  void defaultCompileAll(TreeLogger logger) throws UnableToCompleteException {
    for (Outbox box: outboxes.values()) {
      box.maybePrecompile(logger);
    }
  }

  /**
   * Given the name of a policy file, searches all the boxes for a file with that name.
   * Returns null if not found.
   */
  File findPolicyFile(String filename) {
    for (Outbox box : outboxes.values()) {
      File candidate = box.getOutputFile(box.getOutputModuleName() + "/" + filename);
      if (candidate.isFile()) {
        return candidate;
      }
    }
    // not found
    return null;
  }
}