Java Code Examples for com.google.api.server.spi.config.ApiMethod.HttpMethod#GET

/**
 * Gets a signed URL that can be used to upload a blob.
 *
 * @param bucketName Google Cloud Storage bucket to use for upload.
 * @param objectPath path to the object in the bucket.
 * @param accessMode controls how the uploaded blob can be accessed.
 * @param contentType the MIME type of the object of be uploaded. Can be null.
 * @param user the user making the request.
 * @throws UnauthorizedException if the user is not authorized.
 * @throws BadRequestException if the bucketName or objectPath are not valid.
 */
@ApiMethod(httpMethod = HttpMethod.GET, path = "blobs/uploads/{bucketName}/{objectPath}")
public BlobAccess getUploadUrl(@Named("bucketName") String bucketName,
    @Named("objectPath") String objectPath, @Named("accessMode") BlobAccessMode accessMode,
    @Nullable @Named("contentType") String contentType, User user)
    throws UnauthorizedException, BadRequestException {
  validateUser(user);

  validateBucketAndObjectPath(bucketName, objectPath);

  if (!reserveNameIfAvailable(bucketName, objectPath, accessMode, user)) {
    throw new UnauthorizedException("You don't have permissions to upload this object");
  }

  return getBlobUrlForUpload(
      bucketName, objectPath, accessMode, contentType != null ? contentType : "");
}
 

@ApiMethod(
    name = "foos.list",
    path = "foos",
    httpMethod = HttpMethod.GET,
    cacheControl = @ApiMethodCacheControl(
        noCache = true,
        maxAge = 1
    ),
    scopes = {"s0", "s1 s2"},
    audiences = {"a0", "a1"},
    clientIds = {"c0", "c1"},
    authenticators = { FailAuthenticator.class },
    peerAuthenticators = { FailPeerAuthenticator.class }
)
public List<Foo> listFoos() {
  return null;
}
 

@ApiMethod(
        name = "getAnnouncement",
        path = "announcement",
        httpMethod = HttpMethod.GET
)
public Announcement getAnnouncement() {
    MemcacheService memcacheService = MemcacheServiceFactory.getMemcacheService();
    Object message = memcacheService.get(Constants.MEMCACHE_ANNOUNCEMENTS_KEY);
    if (message != null) {
        return new Announcement(message.toString());
    }
    return null;
}
 

/**
 * Returns a Profile object associated with the given user object. The cloud
 * endpoints system automatically inject the User object.
 *
 * @param user
 *            A User object injected by the cloud endpoints.
 * @return Profile object.
 * @throws UnauthorizedException
 *             when the User object is null.
 */
@ApiMethod(name = "getProfile", path = "profile", httpMethod = HttpMethod.GET)
public Profile getProfile(final User user) throws UnauthorizedException {
    if (user == null) {
        throw new UnauthorizedException("Authorization required");
    }

    // TODO
    // load the Profile Entity
    String userId = user.getUserId();
    Key key = Key.create(Profile.class, userId);

    Profile profile = (Profile) ofy().load().key(key).now();
    return profile;
}
 

@ApiMethod(
        name = "getAnnouncement",
        path = "announcement",
        httpMethod = HttpMethod.GET
)
public Announcement getAnnouncement() {
    MemcacheService memcacheService = MemcacheServiceFactory.getMemcacheService();
    Object message = memcacheService.get(Constants.MEMCACHE_ANNOUNCEMENTS_KEY);
    if (message != null) {
        return new Announcement(message.toString());
    }
    return null;
}
 

/**
 * Gets a signed URL that can be used to download a blob.
 *
 * @param bucketName Google Cloud Storage bucket where the object was uploaded.
 * @param objectPath path to the object in the bucket.
 * @param user       the user making the request.
 * @throws com.google.api.server.spi.response.UnauthorizedException if the user is not authorized.
 * @throws com.google.api.server.spi.response.BadRequestException   if the bucketName or objectPath are not valid.
 * @throws com.google.api.server.spi.response.NotFoundException     if the object doesn't exist.
 */
@ApiMethod(httpMethod = HttpMethod.GET, path = "blobs/downloads/{bucketName}/{objectPath}")
public BlobAccess getDownloadUrl(
  @Named("bucketName") String bucketName, @Named("objectPath") String objectPath, User user)
  throws UnauthorizedException, BadRequestException, NotFoundException {
  validateUser(user);

  validateBucketAndObjectPath(bucketName, objectPath);

  checkReadObjectPermissions(bucketName, objectPath, user);

  return getBlobUrlForDownload(bucketName, objectPath);
}
 

@ApiMethod(
    name = "foos.get",
    path = "foos/{id}",
    httpMethod = HttpMethod.GET,
    cacheControl = @ApiMethodCacheControl(
        noCache = false,
        maxAge = 2
    )
)
public Foo getFoo(@Named("id") String id) {
  return null;
}
 

@ApiMethod(name = "api.foos.fn1", path = "fn1", httpMethod = HttpMethod.GET)
public Foo foo(@Named("id") String id) {
  return null;
}
 

@ApiMethod(httpMethod = HttpMethod.GET, path = "test")
public StringValue test() throws Exception {
  return new StringValue("x");
}
 

@ApiMethod(httpMethod = HttpMethod.GET, path = "collidingpath/{id}")
public StringValue getCollidingPath(@Named("id") String id) {
  return new StringValue(id);
}
 

@ApiMethod(
    name = "testArrayPathParam",
    httpMethod = HttpMethod.GET,
    path = "testArrayPathParam/{values}")
public void testArrayPathParam(@Named("values") ArrayList<String> values) {
}
 

@ApiMethod(name = "showIndex", path = "showIndex",
        httpMethod = HttpMethod.GET)
public Map<String, List<Long>> showIndex() {
    return ADS_INDEX.ShowInvertedIndex();
}
 

@ApiMethod(name = "api.foos.base", path = "base", httpMethod = HttpMethod.GET)
public Object foo(@Named("id") String id) {
  return null;
}
 

@ApiMethod(name = "api.foos.fn", path = "fn", httpMethod = HttpMethod.GET)
public Foo foo(Object id) {
  return null;
}
 

@ApiMethod(name = "api.foos.base", path = "base", httpMethod = HttpMethod.GET)
public Foo foo(Number id) {
  return null;
}
 

@ApiMethod(name = "api.foos.fn", path = "fn", httpMethod = HttpMethod.GET)
public Foo foo(@Named("id") List<Integer> id) {
  return null;
}
 

@ApiMethod(name = "sayHello", path = "sayHello",
        httpMethod = HttpMethod.GET)

public HelloClass sayHello() {
    return new HelloClass();
}
 

@ApiMethod(name = "api.foos.base", path = "base", httpMethod = HttpMethod.GET)
public Foo foo(@Named("id") String id) {
  return null;
}
 

@ApiMethod(name = "foo.get", description = "get desc", path = "foos/{id}",
    httpMethod = HttpMethod.GET)
public Foo getFoo(@Named("id") @Description("id desc") String id) {
  return null;
}
 

/**
 * Finds the CloudEntity specified by its Id.
 *
 * @param kindName
 *          Name of the kind for the CloudEntity to get.
 * @param id
 *          Id of the CloudEntity to find.
 * @return {@link com.google.cloud.backend.beans.EntityDto} of the found CloudEntity.
 * @throws com.google.api.server.spi.response.UnauthorizedException
 *           if the requesting {@link com.google.appengine.api.users.User} has no sufficient permission for
 *           the operation.
 * @throws com.google.api.server.spi.response.NotFoundException
 *           if the requested CloudEntity has not found
 */
@ApiMethod(path = "CloudEntities/{kind}/{id}", httpMethod = HttpMethod.GET)
public EntityDto get(@Named("kind") String kindName, @Named("id") String id, User user)
    throws UnauthorizedException, NotFoundException {

  SecurityChecker.getInstance().checkIfUserIsAvailable(user);
  return CrudOperations.getInstance().getEntity(kindName, id, user);
}