Package io.jans.configapi.plugin.mgt.rest

Class UserResource

java.lang.Object

io.jans.configapi.core.rest.BaseResource

io.jans.configapi.plugin.mgt.rest.UserResource

@Path("/configuser")
@Produces("application/json")
@Consumes("application/json")
@ApplicationScoped
public class UserResource
extends io.jans.configapi.core.rest.BaseResource

Field Summary

Fields inherited from class io.jans.configapi.core.rest.BaseResource

FIELD_VALUE_SEPARATOR, MISSING_ATTRIBUTE_CODE, MISSING_ATTRIBUTE_MESSAGE, TOKEN_DELIMITER

Constructor Summary

Constructors

Constructor	Description
UserResource()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	createUser(@Valid CustomUser customUser, boolean removeNonLDAPAttributes)
jakarta.ws.rs.core.Response	deleteUser(@NotNull String inum)
jakarta.ws.rs.core.Response	getUserByInum(@NotNull String inum)
jakarta.ws.rs.core.Response	getUsers(int limit, String pattern, int startIndex, String sortBy, String sortOrder, String fieldValuePair)
jakarta.ws.rs.core.Response	patchUser(@NotNull String inum, @NotNull UserPatchRequest userPatchRequest, boolean removeNonLDAPAttributes)
CustomUser	setCustomUserAttributes(CustomUser customUser, io.jans.as.common.model.common.User user)
CustomUser	setParentAttributes(CustomUser customUser, io.jans.as.common.model.common.User user, boolean removeNonLDAPAttributes)
jakarta.ws.rs.core.Response	updateUser(@Valid CustomUser customUser, boolean removeNonLDAPAttributes)

Methods inherited from class io.jans.configapi.core.rest.BaseResource

checkNotEmpty, checkNotEmpty, checkNotNull, checkNotNull, checkNotNull, checkResourceNotNull, createSearchRequest, findRootError, getBadRequestException, getBadRequestException, getBadRequestException, getHttpHeaders, getHttpRequest, getInternalServerException, getMissingAttributeError, getNotAcceptableException, getNotFoundError, getUriInfo, throwBadRequestException, throwBadRequestException, throwBadRequestException, throwInternalServerException, throwInternalServerException, throwMissingAttributeError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserResource

public UserResource()

Method Detail

getUsers

@GET
public jakarta.ws.rs.core.Response getUsers(@DefaultValue("50") @QueryParam("limit")
                                            int limit,
                                            @DefaultValue("") @QueryParam("pattern")
                                            String pattern,
                                            @DefaultValue("0") @QueryParam("startIndex")
                                            int startIndex,
                                            @DefaultValue("inum") @QueryParam("sortBy")
                                            String sortBy,
                                            @DefaultValue("ascending") @QueryParam("sortOrder")
                                            String sortOrder,
                                            @DefaultValue("") @QueryParam("fieldValuePair")
                                            String fieldValuePair)
                                     throws IllegalAccessException,
                                            InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException

getUserByInum

@GET
@Path("{inum}")
public jakarta.ws.rs.core.Response getUserByInum(@PathParam("inum") @NotNull
                                                 @NotNull String inum)
                                          throws IllegalAccessException,
                                                 InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException

createUser

@POST
public jakarta.ws.rs.core.Response createUser(@Valid
                                              @Valid CustomUser customUser,
                                              @DefaultValue("true") @QueryParam("removeNonLDAPAttributes")
                                              boolean removeNonLDAPAttributes)
                                       throws NoSuchMethodException,
                                              IllegalAccessException,
                                              InvocationTargetException

Throws:

NoSuchMethodException

IllegalAccessException

InvocationTargetException

updateUser

@PUT
public jakarta.ws.rs.core.Response updateUser(@Valid
                                              @Valid CustomUser customUser,
                                              @DefaultValue("true") @QueryParam("removeNonLDAPAttributes")
                                              boolean removeNonLDAPAttributes)
                                       throws NoSuchMethodException,
                                              IllegalAccessException,
                                              InvocationTargetException

Throws:

NoSuchMethodException

IllegalAccessException

InvocationTargetException

patchUser

@PATCH
@Path("{inum}")
public jakarta.ws.rs.core.Response patchUser(@PathParam("inum") @NotNull
                                             @NotNull String inum,
                                             @NotNull
                                             @NotNull UserPatchRequest userPatchRequest,
                                             @DefaultValue("true") @QueryParam("removeNonLDAPAttributes")
                                             boolean removeNonLDAPAttributes)
                                      throws IllegalAccessException,
                                             InvocationTargetException,
                                             com.github.fge.jsonpatch.JsonPatchException,
                                             IOException

Throws:

IllegalAccessException

InvocationTargetException

com.github.fge.jsonpatch.JsonPatchException

IOException

deleteUser

@DELETE
@Path("{inum}")
public jakarta.ws.rs.core.Response deleteUser(@PathParam("inum") @NotNull
                                              @NotNull String inum)

setParentAttributes

public CustomUser setParentAttributes(CustomUser customUser,
                                      io.jans.as.common.model.common.User user,
                                      boolean removeNonLDAPAttributes)

setCustomUserAttributes

public CustomUser setCustomUserAttributes(CustomUser customUser,
                                          io.jans.as.common.model.common.User user)