de.cinovo.cloudconductor.api.interfaces.IUserGroup Maven / Gradle / Ivy

Go to download
package de.cinovo.cloudconductor.api.interfaces;

import de.cinovo.cloudconductor.api.MediaType;
import de.cinovo.cloudconductor.api.model.User;
import de.cinovo.cloudconductor.api.model.UserGroup;

import javax.annotation.security.RolesAllowed;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

/**
 * Copyright 2017 Cinovo AG

 * 

 *
 * @author psigloch
 */
@Path("/usergroup")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface IUserGroup {
	
	/**
	 * @return list of usergroups
	 */
	@GET
	@RolesAllowed({"VIEW_USERS", "EDIT_USERS"})
	UserGroup[] getUserGroups();
	
	/**
	 * @param userGroup the user group to save
	 */
	@PUT
	@RolesAllowed({"EDIT_USERS"})
	void save(UserGroup userGroup);
	
	/**
	 * 
	 * @param userGroupName the name of the user group
	 * @return the requested user group
	 */
	@GET
	@Path("/{usergroupname}")
	@RolesAllowed({"VIEW_USERS", "EDIT_USERS"})
	UserGroup getUserGroup(@PathParam("usergroupname") String userGroupName);
	
	/**
	 * @param userGroupName the user group name
	 */
	@DELETE
	@Path("/{usergroupname}")
	@RolesAllowed({"EDIT_USERS"})
	void delete(@PathParam("usergroupname") String userGroupName);
	
	/**
	 * 
	 * @param userGroupName the usergroup name
	 * @return list of group members
	 */
	@GET
	@Path("/{usergroupname}/members")
	@RolesAllowed({"VIEW_USERS", "EDIT_USERS"})
	User[] getGroupMembers(@PathParam("usergroupname") String userGroupName);
	
}