com.google.api.server.spi.request.Attribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of endpoints-framework Show documentation
A framework for building RESTful web APIs.
The newest version!
/*
 * Copyright 2016 Google Inc. All Rights Reserved.
 *
 * 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.api.server.spi.request;

import com.google.api.server.spi.ServletInitializationParameters;
import com.google.api.server.spi.Strings;
import com.google.api.server.spi.config.model.ApiMethodConfig;
import com.google.common.annotations.VisibleForTesting;

import javax.servlet.http.HttpServletRequest;

/**
 * Defines attribute constants passed in Request.
 */
public class Attribute {
  /**
   * A {@link com.google.appengine.api.users.User} with the currently authenticated App Engine user.
   *
   */
  public static final String AUTHENTICATED_APPENGINE_USER =
      "endpoints:Authenticated-AppEngine-User";
  /**
   * A {@link com.google.api.server.spi.config.model.ApiMethodConfig} with the current API method's
   * configuration.
   */
  public static final String API_METHOD_CONFIG = "endpoints:Api-Method-Config";
  /**
   * A {@link Boolean} indicating if client id whitelist should be checked.
   */
  public static final String ENABLE_CLIENT_ID_WHITELIST =
      "endpoints:Enable-Client-Id-Whitelist";
  /**
   * @deprecated
   */
  public static final String RESTRICT_SERVLET = "endpoints:Restrict-Servlet";
  /**
   * A {@link Boolean} indicating if the App Engine user should be populated.
   */
  public static final String REQUIRE_APPENGINE_USER = "endpoints:Require-AppEngine-User";
  /**
   * A {@link Boolean} indicating if token-based authentications (OAuth2 and JWT) should be skipped.
   */
  public static final String SKIP_TOKEN_AUTH = "endpoints:Skip-Token-Auth";
  /**
   * A {@link String} with the current request's auth token.
   */
  public static final String AUTH_TOKEN = "endpoints:Auth-Token";
  /**
   * If set, contains a cached OAuth2 {@link com.google.api.server.spi.auth.GoogleAuth.TokenInfo}
   * corresponding to the String token in the {@link Attribute#AUTH_TOKEN} {@value AUTH_TOKEN}
   * attribute.
   * The authentication from {@link com.google.api.server.spi.auth.GoogleOAuth2Authenticator} might
   * have failed anyway because of unauthorized client id or scopes.
   */
  public static final String TOKEN_INFO = "endpoints:Token-Info";
  /**
   * If set, contains a cached instance of a parsed and valid JWT
   * {@link com.google.api.client.googleapis.auth.oauth2.GoogleIdToken} corresponding to the String
   * token in the {@link Attribute#AUTH_TOKEN} {@value AUTH_TOKEN} attribute.
   * The authentication from {@link com.google.api.server.spi.auth.GoogleJwtAuthenticator} might
   * have failed anyway because of unauthorized client id or audience.
   */
  public static final String ID_TOKEN = "endpoints:Id-Token";

  private final HttpServletRequest request;

  @VisibleForTesting
  Attribute(HttpServletRequest request) {
    this.request = request;
  }

  public static Attribute from(HttpServletRequest request) {
    return new Attribute(request);
  }

  public  T get(String attr) {
    return (T) request.getAttribute(attr);
  }

  public void set(String attr, Object value) {
    request.setAttribute(attr, value);
  }

  public void remove(String attr) {
    request.removeAttribute(attr);
  }

  public boolean isEnabled(String attr) {
    return request.getAttribute(attr) == null ? false : (Boolean) request.getAttribute(attr);
  }

  public static Attribute bindStandardRequestAttributes(HttpServletRequest request,
      ApiMethodConfig methodConfig,
      ServletInitializationParameters initParameters) {
    Attribute attr = Attribute.from(request);
    attr.set(Attribute.RESTRICT_SERVLET, initParameters.isServletRestricted());
    attr.set(Attribute.ENABLE_CLIENT_ID_WHITELIST, initParameters.isClientIdWhitelistEnabled());
    attr.set(Attribute.API_METHOD_CONFIG, methodConfig);
    // No clientId is allowed. Producer is not interested in Jwt/OAuth2 authentication.
    if (initParameters.isClientIdWhitelistEnabled()
        && Strings.isEmptyOrNull(methodConfig.getClientIds())) {
      attr.set(Attribute.SKIP_TOKEN_AUTH, true);
    }
    return attr;
  }
}