org.apache.shindig.gadgets.render.RenderingResults Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shindig-gadgets Show documentation

Renders gadgets, provides the gadget metadata service, and serves all javascript required by the OpenSocial specification.

There is a newer version: 3.0.0-beta4

Show newest version

/*
 * 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.render;

import org.apache.shindig.common.uri.Uri;

import com.google.common.base.Preconditions;

/**
 * Contains the results of a rendering operation.
 */
public class RenderingResults {
  private final Status status;
  private final String content;
  private final String errorMessage;
  private final Uri redirect;

  private RenderingResults(Status status, String content, String errorMessage, Uri redirect) {
    this.status = status;
    this.content = content;
    this.errorMessage = errorMessage;
    this.redirect = redirect;
  }

  public static RenderingResults ok(String content) {
    return new RenderingResults(Status.OK, content, null, null);
  }

  public static RenderingResults error(String errorMessage) {
    return new RenderingResults(Status.ERROR, null, errorMessage, null);
  }

  public static RenderingResults mustRedirect(Uri redirect) {
    Preconditions.checkNotNull(redirect);
    return new RenderingResults(Status.MUST_REDIRECT, null, null, redirect);
  }

  /**
   * @return The status of the rendering operation.
   */
  public Status getStatus() {
    return status;
  }

  /**
   * @return The content to render. Only available when status is OK.
   */
  public String getContent() {
    Preconditions.checkState(status == Status.OK, "Only available when status is OK.");
    return content;
  }

  /**
   * @return The error message for rendering. Only available when status is ERROR.
   */
  public String getErrorMessage() {
    Preconditions.checkState(status == Status.ERROR, "Only available when status is ERROR.");
    return errorMessage;
  }

  /**
   * @return The error message for rendering. Only available when status is ERROR.
   */
  public Uri getRedirect() {
    Preconditions.checkState(status == Status.MUST_REDIRECT, "Only available when status is MUST_REDIRECT.");
    return redirect;
  }

  public enum Status {
    OK, MUST_REDIRECT, ERROR
  }
}