com.centurylink.mdw.service.rest.Comments Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mdw-services Show documentation
MDW is a workflow framework specializing in microservice orchestration
There is a newer version: 6.1.39
/*
 * Copyright (C) 2017 CenturyLink, Inc.
 *
 * 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.centurylink.mdw.service.rest;

import java.util.List;
import java.util.Map;

import javax.ws.rs.Path;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import com.centurylink.mdw.common.service.Query;
import com.centurylink.mdw.common.service.ServiceException;
import com.centurylink.mdw.common.service.types.StatusMessage;
import com.centurylink.mdw.model.JsonArray;
import com.centurylink.mdw.model.Comment;
import com.centurylink.mdw.model.listener.Listener;
import com.centurylink.mdw.model.user.Role;
import com.centurylink.mdw.model.user.UserAction.Entity;
import com.centurylink.mdw.services.CollaborationServices;
import com.centurylink.mdw.services.ServiceLocator;
import com.centurylink.mdw.services.rest.JsonRestService;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

@Path("/Comments")
@Api("Discussion comments")
public class Comments extends JsonRestService {

    @Override
    @Path("/{id}")
    @ApiOperation(value="Retrieve comment(s)",
        notes="If id not present, includes all comments for the given owner type and ownerId.",
        response=Comment.class, responseContainer="List")
    @ApiImplicitParams({
        @ApiImplicitParam(name="ownerType", paramType="query", required=true, dataType="string"),
        @ApiImplicitParam(name="ownerId", paramType="query", required=true, dataType="string")})
    public JSONObject get(String path, Map headers) throws ServiceException, JSONException {
        String id = getSegment(path, 2);
        if (id != null) {
            try {
                return ServiceLocator.getCollaborationServices().getComment(Long.parseLong(id)).getJson();
            }
            catch (NumberFormatException ex) {
                throw new ServiceException(ServiceException.BAD_REQUEST, "Invalid comment id: " + id);
            }
        }
        else {
            Query query = new Query(path, headers);
            String ownerType = query.getFilter("ownerType");
            if (ownerType == null)
                throw new ServiceException("Missing parameter: ownerType");
            Long ownerId = query.getLongFilter("ownerId");
            if (ownerId == -1)
                throw new ServiceException("Missing parameter: ownerId");
            CollaborationServices collabServices = ServiceLocator.getCollaborationServices();
            List comments = collabServices.getComments(ownerType.toUpperCase(), ownerId);
            JSONArray commentsJson = new JSONArray();
            for (Comment comment : comments)
                commentsJson.put(comment.getJson());
            return new JsonArray(commentsJson).getJson();
        }
    }

    @Override
    @ApiOperation(value="Create a comment", response=Comment.class)
    @ApiImplicitParams({
        @ApiImplicitParam(name="comment", paramType="body", required=true, dataType="com.centurylink.mdw.model.Comment")})
    public JSONObject post(String path, JSONObject content, Map headers)
    throws ServiceException, JSONException {
        Comment comment = new Comment(content);
        comment.setId(ServiceLocator.getCollaborationServices().createComment(comment));
        headers.put(Listener.METAINFO_HTTP_STATUS_CODE, "201");
        return comment.getJson();
    }


    @Override
    @Path("/{id}")
    @ApiOperation(value="Update a comment", response=StatusMessage.class)
    @ApiImplicitParams({
        @ApiImplicitParam(name="comment", paramType="body", required=true, dataType="com.centurylink.mdw.model.Comment"),
        @ApiImplicitParam(name="id", paramType="path", required=true)})
    public JSONObject put(String path, JSONObject content, Map headers)
            throws ServiceException, JSONException {
        ServiceLocator.getCollaborationServices().updateComment(new Comment(content));
        return null;
    }

    @Override
    @Path("/{id}")
    @ApiOperation(value="Delete a comment", response=StatusMessage.class)
    public JSONObject delete(String path, JSONObject content, Map headers)
            throws ServiceException, JSONException {
        String id = getSegment(path, 1);
        if (id == null)
            throw new ServiceException(HTTP_400_BAD_REQUEST, "Missing comment id: " + path);
        try {
            ServiceLocator.getCollaborationServices().deleteComment(Long.parseLong(id));
            return null;
        }
        catch (NumberFormatException ex) {
            throw new ServiceException(HTTP_400_BAD_REQUEST, "Invalid comment id: " + id);
        }
    }

    @Override
    public List getRoles(String path) {
        List roles = super.getRoles(path);
        roles.add(Role.PROCESS_EXECUTION);
        return roles;
    }

    @Override
    protected Entity getEntity(String path, Object content, Map headers) {
        return Entity.Comment;
    }
}