Class AttributesResource


  • @Path("/attributes")
    @Consumes("application/json")
    @Produces("application/json")
    public class AttributesResource
    extends ConfigBaseResource
    Author:
    Mougang T.Gasmyr
    • Field Summary

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

        FIELD_VALUE_SEPARATOR, MISSING_ATTRIBUTE_CODE, MISSING_ATTRIBUTE_MESSAGE, TOKEN_DELIMITER
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      jakarta.ws.rs.core.Response createAttribute​(@Valid io.jans.model.JansAttribute attribute)  
      jakarta.ws.rs.core.Response deleteAttribute​(@NotNull String inum)  
      jakarta.ws.rs.core.Response getAttributeByInum​(@NotNull String inum)  
      jakarta.ws.rs.core.Response getAttributes​(int limit, String pattern, String status, int startIndex, String sortBy, String sortOrder, String fieldValuePair)  
      jakarta.ws.rs.core.Response patchAtribute​(@NotNull String inum, @NotNull String pathString)  
      jakarta.ws.rs.core.Response updateAttribute​(@Valid io.jans.model.JansAttribute attribute)  
      • Methods inherited from class io.jans.configapi.core.rest.BaseResource

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

      • AttributesResource

        public AttributesResource()
    • Method Detail

      • getAttributes

        @GET
        public jakarta.ws.rs.core.Response getAttributes​(@DefaultValue("50") @QueryParam("limit")
                                                         int limit,
                                                         @DefaultValue("") @QueryParam("pattern")
                                                         String pattern,
                                                         @DefaultValue("all") @QueryParam("status")
                                                         String status,
                                                         @DefaultValue("0") @QueryParam("startIndex")
                                                         int startIndex,
                                                         @DefaultValue("inum") @QueryParam("sortBy")
                                                         String sortBy,
                                                         @DefaultValue("ascending") @QueryParam("sortOrder")
                                                         String sortOrder,
                                                         @DefaultValue("") @QueryParam("fieldValuePair")
                                                         String fieldValuePair)
      • getAttributeByInum

        @GET
        @Path("{inum}")
        public jakarta.ws.rs.core.Response getAttributeByInum​(@PathParam("inum") @NotNull
                                                              @NotNull String inum)
      • createAttribute

        @POST
        public jakarta.ws.rs.core.Response createAttribute​(@Valid
                                                           @Valid io.jans.model.JansAttribute attribute)
      • updateAttribute

        @PUT
        public jakarta.ws.rs.core.Response updateAttribute​(@Valid
                                                           @Valid io.jans.model.JansAttribute attribute)
      • patchAtribute

        @PATCH
        @Consumes("application/json-patch+json")
        @Path("{inum}")
        public jakarta.ws.rs.core.Response patchAtribute​(@PathParam("inum") @NotNull
                                                         @NotNull String inum,
                                                         @NotNull
                                                         @NotNull String pathString)
                                                  throws com.github.fge.jsonpatch.JsonPatchException,
                                                         IOException
        Throws:
        com.github.fge.jsonpatch.JsonPatchException
        IOException
      • deleteAttribute

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