EndorsementEndpoint.java

package com.ciandt.techgallery.service.endpoint;

import com.google.api.server.spi.config.Api;
import com.google.api.server.spi.config.ApiMethod;
import com.google.api.server.spi.config.Named;
import com.google.api.server.spi.config.AuthLevel;
import com.google.api.server.spi.config.ApiReference;
import com.google.api.server.spi.response.BadRequestException;
import com.google.api.server.spi.response.InternalServerErrorException;
import com.google.api.server.spi.response.NotFoundException;
import com.google.appengine.api.oauth.OAuthRequestException;
import com.google.appengine.api.users.User;

import com.ciandt.techgallery.Constants;
import com.ciandt.techgallery.persistence.model.Endorsement;
import com.ciandt.techgallery.service.EndorsementService;
import com.ciandt.techgallery.service.impl.EndorsementServiceImpl;
import com.ciandt.techgallery.service.model.EndorsementResponse;
import com.ciandt.techgallery.service.model.Response;

/**
 * Endpoint controller class for Endorsements requests. Endorsements are used only for users.
 * 
 * @author felipers
 *
 */

@ApiReference(TechGalleryApiDefinition.class)
public class EndorsementEndpoint {

  private EndorsementService service = EndorsementServiceImpl.getInstance();

  /**
   * Endpoint for adding or updating an Endorsement.
   * 
   * @param endorsement json with endorsement info.
   * @param user Endorsement User
   * @return endorsement
   * @throws InternalServerErrorException in case something goes wrong
   * @throws OAuthRequestException in case of authentication problem
   * @throws NotFoundException in case the information are not founded
   * @throws BadRequestException in case a request with problem were made.
   */
  @ApiMethod(name = "addEndorsement", path = "endorsement", httpMethod = "post")
  public Endorsement addEndorsement(EndorsementResponse endorsement, User user)
      throws InternalServerErrorException, BadRequestException, NotFoundException,
      OAuthRequestException {
    return service.addOrUpdateEndorsement(endorsement, user);
  }

  /**
   * Endpoint for adding or updating an Endorsement through Plus One button.
   * 
   * @param endorsement json with endorsement info.
   * @param user Endorsement User
   * @return endorsement
   * @throws InternalServerErrorException in case something goes wrong
   * @throws OAuthRequestException in case of authentication problem
   * @throws NotFoundException in case the information are not founded
   * @throws BadRequestException in case a request with problem were made.
   */
  @ApiMethod(name = "addEndorsementPlusOne", path = "endorsementPlusOne", httpMethod = "post")
  public Endorsement addEndorsementPlusOne(EndorsementResponse endorsement, User user)
      throws InternalServerErrorException, BadRequestException, NotFoundException,
      OAuthRequestException {
    return service.addOrUpdateEndorsementPlusOne(endorsement, user);
  }

  /**
   * Endpoint for getting a list of Endorsements.
   * 
   * @return List of all Endorsements
   * @throws InternalServerErrorException in case something goes wrong
   * @throws NotFoundException in case the information are not founded
   */
  @ApiMethod(name = "getEndorsements", path = "endorsement", httpMethod = "get")
  public Response getEndorsements(User user) throws InternalServerErrorException, NotFoundException {
    return service.getEndorsements();
  }

  /**
   * Endpoint for getting an Endorsement.
   * 
   * @param id entity id.
   * @return Endorsement
   * @throws NotFoundException in case the information are not founded
   */
  @ApiMethod(name = "getEndorsement", path = "endorsement/{id}", httpMethod = "get")
  public Endorsement getEndorsement(@Named("id") Long id, User user) throws NotFoundException {
    return service.getEndorsement(id);
  }

  /**
   * Endpoint for getting all endorsements of a Technology.
   * 
   * @param id technology id.
   * @return List of endorsements
   * @throws InternalServerErrorException in case something goes wrong
   * @throws OAuthRequestException in case of authentication problem
   * @throws NotFoundException in case the information are not founded
   * @throws BadRequestException in case a request with problem were made.
   */
  @ApiMethod(name = "getEndorsementsByTech", path = "endorsement/tech/{id}", httpMethod = "get")
  public Response getEndorsementsByTech(@Named("id") String id, User user) throws NotFoundException,
      InternalServerErrorException, BadRequestException, OAuthRequestException {
    return service.getEndorsementsByTech(id, user);
  }

}