Package org.neotropic.kuwaiba.northbound.rest.aem

Interface UserRestOpenApi

  • All Known Implementing Classes:
    UserRestController
    @RequestMapping("/v2.1.1/user-manager/")
public interface UserRestOpenApi
    Swagger documentation for user manager.
    Author:
    Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String PATH  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addUserToGroup​(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId, @NotNull @Valid String sessionId)  
      long createGroup​(@NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid Long[] users, @NotNull @Valid String sessionId)  
      long createUser​(@NotNull @Valid String userName, @NotNull @Valid String password, @NotNull @Valid String firstName, @NotNull @Valid String lastName, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled, @javax.validation.constraints.NotNull,@javax.validation.Valid int type, @NotNull @Valid String email, @NotNull @Valid List<Privilege> privileges, @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId, @NotNull @Valid String sessionId)  
      void deleteGroups​(@NotNull @Valid Long[] ids, @NotNull @Valid String sessionId)  
      void deleteUsers​(@NotNull @Valid Long[] ids, @NotNull @Valid String sessionId)  
      List<GroupProfile> getGroups​(@NotNull @Valid String sessionId)  
      List<GroupProfileLight> getGroupsForUser​(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String sessionId)  
      UserProfile getUserInSession​(@NotNull @Valid String sessionId)  
      List<UserProfile> getUsers​(@NotNull @Valid String sessionId)  
      List<UserProfile> getUsersInGroup​(@javax.validation.constraints.NotNull,@javax.validation.Valid long groupId, @NotNull @Valid String sessionId)  
      void removePrivilegeFromGroup​(@javax.validation.constraints.NotNull,@javax.validation.Valid long groupId, @NotNull @Valid String featureToken, @NotNull @Valid String sessionId)  
      void removePrivilegeFromUser​(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String featureToken, @NotNull @Valid String sessionId)  
      void removeUserFromGroup​(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId, @NotNull @Valid String sessionId)  
      void setGroupProperties​(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String sessionId)  
      void setPrivilegeToGroup​(@javax.validation.constraints.NotNull,@javax.validation.Valid long groupId, @NotNull @Valid String featureToken, @javax.validation.constraints.NotNull,@javax.validation.Valid int accessLevel, @NotNull @Valid String sessionId)  
      void setPrivilegeToUser​(@javax.validation.constraints.NotNull,@javax.validation.Valid long userId, @NotNull @Valid String featureToken, @javax.validation.constraints.NotNull,@javax.validation.Valid int accessLevel, @NotNull @Valid String sessionId)  
      void setUserProperties​(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String userName, @NotNull @Valid String password, @NotNull @Valid String firstName, @NotNull @Valid String lastName, @javax.validation.constraints.NotNull,@javax.validation.Valid int enabled, @javax.validation.constraints.NotNull,@javax.validation.Valid int type, @NotNull @Valid String email, @NotNull @Valid String sessionId)  

    • Method Detail

      • getUsers

        @RequestMapping(method=GET,
                value="getUsers/{sessionId}",
                produces="application/json")
List<UserProfile> getUsers​(@NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

      • getGroups

        @RequestMapping(method=GET,
                value="getGroups/{sessionId}",
                produces="application/json")
List<GroupProfile> getGroups​(@NotNull @Valid @PathVariable(value="sessionId",required=true)
                             @NotNull @Valid String sessionId)

      • getUserInSession

        @RequestMapping(method=GET,
                value="getUserInSession/{sessionId}",
                produces="application/json")
UserProfile getUserInSession​(@NotNull @Valid @PathVariable(value="sessionId",required=true)
                             @NotNull @Valid String sessionId)

      • getUsersInGroup

        @RequestMapping(method=GET,
                value="getUsersInGroup/{groupId}/{sessionId}",
                produces="application/json")
List<UserProfile> getUsersInGroup​(@NotNull @Valid @PathVariable(value="groupId",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)

      • getGroupsForUser

        @RequestMapping(method=GET,
                value="getGroupsForUser/{userId}/{sessionId}",
                produces="application/json")
List<GroupProfileLight> getGroupsForUser​(@NotNull @Valid @PathVariable(value="userId",required=true)
                                         @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                         @NotNull @Valid String sessionId)

      • setUserProperties

        @RequestMapping(method=PUT,
                value="setUserProperties/{id}/{userName}/{password}/{firstName}/{lastName}/{enabled}/{type}/{email}/{sessionId}",
                produces="application/json")
void setUserProperties​(@NotNull @Valid @PathVariable(value="id",required=true)
                       @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                       @NotNull @Valid @PathVariable(value="userName",required=true)
                       @NotNull @Valid String userName,
                       @NotNull @Valid @PathVariable(value="password",required=true)
                       @NotNull @Valid String password,
                       @NotNull @Valid @PathVariable(value="firstName",required=true)
                       @NotNull @Valid String firstName,
                       @NotNull @Valid @PathVariable(value="lastName",required=true)
                       @NotNull @Valid String lastName,
                       @NotNull @Valid @PathVariable(value="enabled",required=true)
                       @javax.validation.constraints.NotNull,@javax.validation.Valid int enabled,
                       @NotNull @Valid @PathVariable(value="type",required=true)
                       @javax.validation.constraints.NotNull,@javax.validation.Valid int type,
                       @NotNull @Valid @PathVariable(value="email",required=true)
                       @NotNull @Valid String email,
                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                       @NotNull @Valid String sessionId)

      • setPrivilegeToUser

        @RequestMapping(method=PUT,
                value="setPrivilegeToUser/{userId}/{featureToken}/{accessLevel}/{sessionId}",
                produces="application/json")
void setPrivilegeToUser​(@NotNull @Valid @PathVariable(value="userId",required=true)
                        @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                        @NotNull @Valid @PathVariable(value="featureToken",required=true)
                        @NotNull @Valid String featureToken,
                        @NotNull @Valid @PathVariable(value="accessLevel",required=true)
                        @javax.validation.constraints.NotNull,@javax.validation.Valid int accessLevel,
                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                        @NotNull @Valid String sessionId)

      • setPrivilegeToGroup

        @RequestMapping(method=PUT,
                value="setPrivilegeToGroup/{groupId}/{featureToken}/{accessLevel}/{sessionId}",
                produces="application/json")
void setPrivilegeToGroup​(@NotNull @Valid @PathVariable(value="groupId",required=true)
                         @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId,
                         @NotNull @Valid @PathVariable(value="featureToken",required=true)
                         @NotNull @Valid String featureToken,
                         @NotNull @Valid @PathVariable(value="accessLevel",required=true)
                         @javax.validation.constraints.NotNull,@javax.validation.Valid int accessLevel,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

      • setGroupProperties

        @RequestMapping(method=PUT,
                value="setGroupProperties/{id}/{name}/{description}/{sessionId}",
                produces="application/json")
void setGroupProperties​(@NotNull @Valid @PathVariable(value="id",required=true)
                        @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                        @NotNull @Valid @PathVariable(value="name",required=true)
                        @NotNull @Valid String name,
                        @NotNull @Valid @PathVariable(value="description",required=true)
                        @NotNull @Valid String description,
                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                        @NotNull @Valid String sessionId)

      • createUser

        @RequestMapping(method=POST,
                value="createUser/{userName}/{password}/{firstName}/{lastName}/{enabled}/{type}/{email}/{groupId}/{sessionId}",
                produces="application/json")
long createUser​(@NotNull @Valid @PathVariable(value="userName",required=true)
                @NotNull @Valid String userName,
                @NotNull @Valid @PathVariable(value="password",required=true)
                @NotNull @Valid String password,
                @NotNull @Valid @PathVariable(value="firstName",required=true)
                @NotNull @Valid String firstName,
                @NotNull @Valid @PathVariable(value="lastName",required=true)
                @NotNull @Valid String lastName,
                @NotNull @Valid @PathVariable(value="enabled",required=true)
                @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled,
                @NotNull @Valid @PathVariable(value="type",required=true)
                @javax.validation.constraints.NotNull,@javax.validation.Valid int type,
                @NotNull @Valid @PathVariable(value="email",required=true)
                @NotNull @Valid String email,
                @NotNull @Valid @RequestBody(required=true)
                @NotNull @Valid List<Privilege> privileges,
                @NotNull @Valid @PathVariable(value="groupId",required=true)
                @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId,
                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                @NotNull @Valid String sessionId)

      • createGroup

        @RequestMapping(method=POST,
                value="createGroup/{name}/{description}/{users}/{sessionId}",
                produces="application/json")
long createGroup​(@NotNull @Valid @PathVariable(value="name",required=true)
                 @NotNull @Valid String name,
                 @NotNull @Valid @PathVariable(value="description",required=true)
                 @NotNull @Valid String description,
                 @NotNull @Valid @PathVariable(value="users",required=true)
                 @NotNull @Valid Long[] users,
                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                 @NotNull @Valid String sessionId)

      • addUserToGroup

        @RequestMapping(method=POST,
                value="addUserToGroup/{userId}/{groupId}/{sessionId}",
                produces="application/json")
void addUserToGroup​(@NotNull @Valid @PathVariable(value="userId",required=true)
                    @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                    @NotNull @Valid @PathVariable(value="groupId",required=true)
                    @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId,
                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                    @NotNull @Valid String sessionId)

      • removeUserFromGroup

        @RequestMapping(method=DELETE,
                value="removeUserFromGroup/{userId}/{groupId}/{sessionId}",
                produces="application/json")
void removeUserFromGroup​(@NotNull @Valid @PathVariable(value="userId",required=true)
                         @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                         @NotNull @Valid @PathVariable(value="groupId",required=true)
                         @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

      • removePrivilegeFromUser

        @RequestMapping(method=DELETE,
                value="removePrivilegeFromUser/{userId}/{featureToken}/{sessionId}",
                produces="application/json")
void removePrivilegeFromUser​(@NotNull @Valid @PathVariable(value="userId",required=true)
                             @javax.validation.constraints.NotNull,@javax.validation.Valid long userId,
                             @NotNull @Valid @PathVariable(value="featureToken",required=true)
                             @NotNull @Valid String featureToken,
                             @NotNull @Valid @PathVariable(value="sessionId",required=true)
                             @NotNull @Valid String sessionId)

      • removePrivilegeFromGroup

        @RequestMapping(method=DELETE,
                value="removePrivilegeFromGroup/{groupId}/{featureToken}/{sessionId}",
                produces="application/json")
void removePrivilegeFromGroup​(@NotNull @Valid @PathVariable(value="groupId",required=true)
                              @javax.validation.constraints.NotNull,@javax.validation.Valid long groupId,
                              @NotNull @Valid @PathVariable(value="featureToken",required=true)
                              @NotNull @Valid String featureToken,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)

      • deleteUsers

        @RequestMapping(method=DELETE,
                value="deleteUsers/{ids}/{sessionId}",
                produces="application/json")
void deleteUsers​(@NotNull @Valid @PathVariable(value="ids",required=true)
                 @NotNull @Valid Long[] ids,
                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                 @NotNull @Valid String sessionId)

      • deleteGroups

        @RequestMapping(method=DELETE,
                value="deleteGroups/{ids}/{sessionId}",
                produces="application/json")
void deleteGroups​(@NotNull @Valid @PathVariable(value="ids",required=true)
                  @NotNull @Valid Long[] ids,
                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                  @NotNull @Valid String sessionId)