com.centurylink.mdw.service.rest.Workgroups 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
Show all versions of mdw-services Show documentation
MDW is a workflow framework specializing in microservice orchestration
/*
* 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.ArrayList;
import java.util.List;
import java.util.Map;
import javax.ws.rs.Path;
import org.json.JSONException;
import org.json.JSONObject;
import com.centurylink.mdw.cache.CachingException;
import com.centurylink.mdw.common.service.ServiceException;
import com.centurylink.mdw.common.service.types.StatusMessage;
import com.centurylink.mdw.dataaccess.DataAccessException;
import com.centurylink.mdw.model.user.Workgroup;
import com.centurylink.mdw.model.listener.Listener;
import com.centurylink.mdw.model.user.Role;
import com.centurylink.mdw.model.user.User;
import com.centurylink.mdw.model.user.UserAction.Entity;
import com.centurylink.mdw.service.data.user.UserGroupCache;
import com.centurylink.mdw.services.ServiceLocator;
import com.centurylink.mdw.services.UserServices;
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("/Workgroups")
@Api("MDW user workgroups service")
public class Workgroups extends JsonRestService {
@Override
public List getRoles(String path, String method) {
if (method.equals("GET")) {
List roles = new ArrayList<>();
if (UserGroupCache.getRole(Role.ASSET_VIEW) != null) {
roles.add(Role.USER_VIEW);
roles.add(Role.USER_ADMIN);
roles.add(Workgroup.SITE_ADMIN_GROUP);
}
return roles;
}
else {
List roles = super.getRoles(path);
roles.add(Role.USER_ADMIN);
return roles;
}
}
@Override
protected Entity getEntity(String path, Object content, Map headers) {
return Entity.Workgroup;
}
/**
* Retrieve a workgroup or all workgroups.
*/
@Override
@Path("/{groupName}")
@ApiOperation(value="Retrieve a workgroup or all workgroups",
notes="If groupName is not present, returns all workgroups.",
response=Workgroup.class, responseContainer="List")
public JSONObject get(String path, Map headers)
throws ServiceException, JSONException {
UserServices userServices = ServiceLocator.getUserServices();
try {
String groupName = getSegment(path, 1);
if (groupName == null) // check parameter
groupName = getParameters(headers).get("name");
if (groupName != null) {
Workgroup group = userServices.getWorkgroup(groupName);
if (group == null)
throw new ServiceException(ServiceException.NOT_FOUND, "Workgroup not found: " + groupName);
return group.getJson();
}
else {
return userServices.getWorkgroups().getJson();
}
}
catch (ServiceException ex) {
throw ex;
}
catch (Exception ex) {
throw new ServiceException(ex.getMessage(), ex);
}
}
/**
* For creating a new workgroup or a new group/user relationship.
*/
@Override
@Path("/{groupName}/users/{cuid}")
@ApiOperation(value="Create a workgroup or add a user to an existing workgroup",
notes="If users/{cuid} is present, user is added to workgroup.", response=StatusMessage.class)
@ApiImplicitParams({
@ApiImplicitParam(name="Workgroup", paramType="body", required=true, dataType="com.centurylink.mdw.model.user.Workgroup"),
@ApiImplicitParam(name="groupName", paramType="path", required=true)})
public JSONObject post(String path, JSONObject content, Map headers)
throws ServiceException, JSONException {
String name = getSegment(path, 1);
String rel = getSegment(path, 2);
UserServices userServices = ServiceLocator.getUserServices();
try {
if (rel == null) {
Workgroup workgroup = new Workgroup(content);
Workgroup existing = userServices.getWorkgroups().get(workgroup.getName());
if (existing != null)
throw new ServiceException(HTTP_409_CONFLICT, "Workgroup name already exists: " + workgroup.getName());
userServices.createWorkgroup(workgroup);
headers.put(Listener.METAINFO_HTTP_STATUS_CODE, "201");
}
else if (rel.equals("users")) {
String cuid = getSegment(path, 3);
User user = UserGroupCache.getUser(cuid);
if (user == null) {
throw new CachingException("Cannot find user: " + cuid);
}
if (user.belongsToGroup(name)) // in case added elsewhere
throw new ServiceException(HTTP_409_CONFLICT, "User " + cuid + " already belongs to workgroup " + name);
userServices.addUserToWorkgroup(cuid, name);
}
else {
String msg = "Unsupported relationship for workgroup " + name + ": " + rel;
throw new ServiceException(HTTP_400_BAD_REQUEST, msg);
}
return null;
}
catch (DataAccessException ex) {
throw new ServiceException(HTTP_500_INTERNAL_ERROR, ex.getMessage(), ex);
}
catch (CachingException ex) {
throw new ServiceException(HTTP_500_INTERNAL_ERROR, ex.getMessage(), ex);
}
}
/**
* For update.
*/
@Override
@Path("/{groupName}")
@ApiOperation(value="Update a workgroup", response=StatusMessage.class)
@ApiImplicitParams({
@ApiImplicitParam(name="Workgroup", paramType="body", required=true, dataType="com.centurylink.mdw.model.user.Workgroup")})
public JSONObject put(String path, JSONObject content, Map headers)
throws ServiceException, JSONException {
UserServices userServices = ServiceLocator.getUserServices();
String name = getSegment(path, 1);
if (name == null)
throw new ServiceException(HTTP_400_BAD_REQUEST, "Missing path segment: {name}");
if (!content.has("name"))
throw new ServiceException(HTTP_400_BAD_REQUEST, "Missing required property: name");
Workgroup workgroup = new Workgroup(content);
try {
Workgroup existing = userServices.getWorkgroup(name);
if (existing == null)
throw new ServiceException(HTTP_404_NOT_FOUND, "Workgroup not found: " + name);
// update
workgroup.setId(existing.getId());
userServices.updateWorkgroup(workgroup);
return null;
}
catch (DataAccessException ex) {
throw new ServiceException(HTTP_500_INTERNAL_ERROR, ex.getMessage(), ex);
}
}
/**
* Delete workgroup or remove user from group.
*/
@Path("/{groupName}/users/{cuid}")
@ApiOperation(value="Delete a workgroup or remove a user from a workgroup",
notes="If users/{cuid} is present, user is removed from workgroup.", response=StatusMessage.class)
public JSONObject delete(String path, JSONObject content, Map headers)
throws ServiceException, JSONException {
String name = getSegment(path, 1);
String rel = getSegment(path, 2);
UserServices userServices = ServiceLocator.getUserServices();
try {
if (rel == null) {
Workgroup workgroup = userServices.getWorkgroup(name);
if (workgroup == null)
throw new ServiceException(ServiceException.NOT_FOUND, "Workgroup not found: " + name);
userServices.deleteWorkgroup(name);
}
else if (rel.equals("users")) {
String cuid = getSegment(path, 3);
userServices.removeUserFromWorkgroup(cuid, name);
}
}
catch (DataAccessException ex) {
throw new ServiceException(HTTP_500_INTERNAL_ERROR, ex.getMessage(), ex);
}
return null;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy