Java Code Examples for com.google.api.server.spi.config.AnnotationBoolean#TRUE

@Test
public void testValidateMethods_ignoredMethod() throws Exception {
  final class Bean {

  }
  @Api
  final class Endpoint {
    @ApiMethod(ignored = AnnotationBoolean.TRUE)
    public void thisShouldBeIgnored(Bean resource1, Bean resource2) {
    }
  }
  ApiConfig config = configLoader.loadConfiguration(ServiceContext.create(), Endpoint.class);
  // If this passes validation, then no error will be thrown. Otherwise, the validator will
  // complain that the method has two resources.
  validator.validate(config);
}
 

/**
 * Tests that ignored methods aren't written to config.
 */
@Test
public void ignoredMethod() throws Exception {
  final class Endpoint {
    @ApiMethod(ignored = AnnotationBoolean.TRUE)
    public void thisShouldBeIgnored() {
    }
  }

  new ApiConfigAnnotationReader().loadEndpointMethods(
      serviceContext, Endpoint.class, apiConfig.getApiClassConfig().getMethods());
  for (String config : writer.writeConfig(Collections.singleton(apiConfig)).values()) {
    assertThat(config).doesNotContain("thisShouldBeIgnored");
  }
}
 

@Test
public void testLevelOverridingWithClassOverrides() throws Exception {
  @ApiClass(
      scopes = {"s0c", "s1c"},
      audiences = {"a0c", "a1c"},
      clientIds = {"c0c", "c1c"},
      resource = "resource2",
      useDatastoreForAdditionalConfig = AnnotationBoolean.TRUE
  )
  final class Test extends SimpleLevelOverridingInheritedApi {
  }

  ApiConfig config = createConfig(Test.class);
  annotationReader.loadEndpointClass(serviceContext, Test.class, config);
  assertEquals("resource2", config.getApiClassConfig().getResource());
  assertTrue(config.getApiClassConfig().getUseDatastore());

  annotationReader.loadEndpointMethods(serviceContext, Test.class,
      config.getApiClassConfig().getMethods());

  ApiMethodConfig noOverrides =
      config.getApiClassConfig().getMethods().get(methodToEndpointMethod(
          SimpleLevelOverridingApi.class.getMethod("noOverrides")));
  assertEquals(toScopeExpression("s0c", "s1c"), noOverrides.getScopeExpression());
  assertEquals(Lists.newArrayList("a0c", "a1c"), noOverrides.getAudiences());
  assertEquals(Lists.newArrayList("c0c", "c1c"), noOverrides.getClientIds());

  ApiMethodConfig overrides =
      config.getApiClassConfig().getMethods().get(methodToEndpointMethod(
          SimpleLevelOverridingApi.class.getMethod("overrides")));
  assertEquals(toScopeExpression("s0b", "s1b"), overrides.getScopeExpression());
  assertEquals(Lists.newArrayList("a0b", "a1b"), overrides.getAudiences());
  assertEquals(Lists.newArrayList("c0b", "c1b"), overrides.getClientIds());
}
 

public void setIsAbstractIfSpecified(AnnotationBoolean isAbstract) {
  if (isAbstract == AnnotationBoolean.TRUE) {
    config.setIsAbstract(true);
  } else if (isAbstract == AnnotationBoolean.FALSE) {
    config.setIsAbstract(false);
  }
}
 

public void setIsDefaultVersionIfSpecified(AnnotationBoolean defaultVersion) {
  if (defaultVersion == AnnotationBoolean.TRUE) {
    config.setIsDefaultVersion(true);
  } else if (defaultVersion == AnnotationBoolean.FALSE) {
    config.setIsDefaultVersion(false);
  }
}
 

public void setIsDiscoverableIfSpecified(AnnotationBoolean discoverable) {
  if (discoverable == AnnotationBoolean.TRUE) {
    config.setIsDiscoverable(true);
  } else if (discoverable == AnnotationBoolean.FALSE) {
    config.setIsDiscoverable(false);
  }
}
 

/**
 * Returns an Objectify Query object for the specified filters.
 *
 * @return an Objectify Query.
 */
@ApiResourceProperty(ignored = AnnotationBoolean.TRUE)
public Query<Conference> getQuery() {
    // First check the feasibility of inequality filters.
    checkFilters();
    Query<Conference> query = ofy().load().type(Conference.class);
    if (inequalityFilter == null) {
        // Order by name.
        query = query.order("name");
    } else {
        // If we have any inequality filters, order by the field first.
        query = query.order(inequalityFilter.field.getFieldName());
        query = query.order("name");
    }
    for (Filter filter : this.filters) {
        // Applies filters in order.
        if (filter.field.fieldType == FieldType.STRING) {
            query = query.filter(String.format("%s %s", filter.field.getFieldName(),
                    filter.operator.getQueryOperator()), filter.value);
        } else if (filter.field.fieldType == FieldType.INTEGER) {
            query = query.filter(String.format("%s %s", filter.field.getFieldName(),
                    filter.operator.getQueryOperator()), Integer.parseInt(filter.value));
        }
    }
    LOG.info(query.toString());
    return query;
}
 

/**
 * Returns an Objectify Query object for the specified filters.
 *
 * @return an Objectify Query.
 */
@ApiResourceProperty(ignored = AnnotationBoolean.TRUE)
public Query<Conference> getQuery() {
    // First check the feasibility of inequality filters.
    checkFilters();
    Query<Conference> query = ofy().load().type(Conference.class);
    if (inequalityFilter == null) {
        // Order by name.
        query = query.order("name");
    } else {
        // If we have any inequality filters, order by the field first.
        query = query.order(inequalityFilter.field.getFieldName());
        query = query.order("name");
    }
    for (Filter filter : this.filters) {
        // Applies filters in order.
        if (filter.field.fieldType == FieldType.STRING) {
            query = query.filter(String.format("%s %s", filter.field.getFieldName(),
                    filter.operator.getQueryOperator()), filter.value);
        } else if (filter.field.fieldType == FieldType.INTEGER) {
            query = query.filter(String.format("%s %s", filter.field.getFieldName(),
                    filter.operator.getQueryOperator()), Integer.parseInt(filter.value));
        }
    }
    LOG.info(query.toString());
    return query;
}
 

public void setUseDatastoreIfSpecified(AnnotationBoolean useDatastore) {
  if (useDatastore == AnnotationBoolean.TRUE) {
    config.setUseDatastore(true);
  } else if (useDatastore == AnnotationBoolean.FALSE) {
    config.setUseDatastore(false);
  }
}
 

@Test
public void testAbstract() throws Exception {
  @Api(isAbstract = AnnotationBoolean.TRUE)
  class Test {}

  String apiConfigSource = g.generateConfig(Test.class).get("myapi-v1.api");
  ObjectNode root = objectMapper.readValue(apiConfigSource, ObjectNode.class);
  assertTrue(root.get("abstract").asBoolean());
}
 

public void setIgnoredIfSpecified(AnnotationBoolean ignored) {
  if (ignored == AnnotationBoolean.TRUE) {
    config.setIgnored(true);
  } else if (ignored == AnnotationBoolean.FALSE) {
    config.setIgnored(false);
  }
}
 

@ApiResourceProperty(ignored = AnnotationBoolean.TRUE)
public String getOrganizerUserId() {
    return organizerUserId;
}
 

@Override
@ApiResourceProperty(ignored = AnnotationBoolean.TRUE)
public String getFoo() {
  return foo;
}
 

@ApiResourceProperty(ignored = AnnotationBoolean.TRUE)
public String getOrganizerUserId() {
    return organizerUserId;
}
 

@ApiResourceProperty(ignored = AnnotationBoolean.TRUE)
public int getY() {
    return y;
}
 

@ApiResourceProperty(ignored = AnnotationBoolean.TRUE)
public String getOrganizerUserId() {
    return organizerUserId;
}
 

private ApiResourceProperty findAnnotation(Annotated a) {
  ApiResourceProperty annotation = a.getAnnotation(ApiResourceProperty.class);
  return annotation != null && annotation.ignored() != AnnotationBoolean.TRUE ? annotation : null;
}
 

@Override
public boolean hasIgnoreMarker(AnnotatedMember member) {
  ApiResourceProperty apiProperty = member.getAnnotation(ApiResourceProperty.class);
  return apiProperty != null && apiProperty.ignored() == AnnotationBoolean.TRUE;
}
 

/**
 * Echoes the received message back. If n is a non-negative integer, the message is copied that
 * many times in the returned message.
 *
 * <p>Note that name is specified and will override the default name of "{class name}.{method
 * name}". For example, the default is "echo.echo".
 *
 * <p>Note that httpMethod is not specified. This will default to a reasonable HTTP method
 * depending on the API method name. In this case, the HTTP method will default to POST.
 */
// [START echo_api_key]
@ApiMethod(name = "echo_api_key", path = "echo_api_key", apiKeyRequired = AnnotationBoolean.TRUE)
public Message echoApiKey(Message message, @Named("n") @Nullable Integer n) {
  return doEcho(message, n);
}
 

/**
 * Echoes the received message back. If n is a non-negative integer, the message is copied that
 * many times in the returned message.
 *
 * Note that name is specified and will override the default name of "{class name}.{method
 * name}". For example, the default is "echo.echo".
 *
 * Note that httpMethod is not specified. This will default to a reasonable HTTP method
 * depending on the API method name. In this case, the HTTP method will default to POST.
 */
@ApiMethod(name = "echo_api_key", path = "echo_api_key", apiKeyRequired = AnnotationBoolean.TRUE)
public Message echoApiKey(Message message, @Named("n") @Nullable Integer n) {
  return doEcho(message, n);
}