Package io.jans.configapi.rest.resource.auth

Class CustomScriptResource

java.lang.Object

io.jans.configapi.core.rest.BaseResource

io.jans.configapi.rest.resource.auth.ConfigBaseResource

io.jans.configapi.rest.resource.auth.CustomScriptResource

@Path("/config/scripts")
@Consumes("application/json")
@Produces("application/json")
public class CustomScriptResource
extends ConfigBaseResource

Constructor Summary

Constructors

Constructor	Description
CustomScriptResource()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	createScript(@Valid io.jans.model.custom.script.model.CustomScript customScript, boolean addScriptTemplate)
jakarta.ws.rs.core.Response	deleteScript(@NotNull String inum)
jakarta.ws.rs.core.Response	getAllCustomScripts(int limit, String pattern, int startIndex, String sortBy, String sortOrder, String fieldValuePair)
jakarta.ws.rs.core.Response	getCustomScriptByInum(@NotNull String inum)
jakarta.ws.rs.core.Response	getCustomScriptByName(@NotNull String name)
jakarta.ws.rs.core.Response	getCustomScriptsByTypePattern(@NotNull String type, int limit, String pattern, int startIndex, String sortBy, String sortOrder, String fieldValuePair)
jakarta.ws.rs.core.Response	getCustomScriptTypes()
jakarta.ws.rs.core.Response	getCustomScriptTypesDetails()
jakarta.ws.rs.core.Response	patchScript(@NotNull String inum, @NotNull String pathString)
jakarta.ws.rs.core.Response	updateScript(@Valid @NotNull io.jans.model.custom.script.model.CustomScript customScript)

Methods inherited from class io.jans.configapi.rest.resource.auth.ConfigBaseResource

getMaxCount

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, throwInternalServerException, throwMissingAttributeError, throwNotFoundException, throwNotFoundException

Methods inherited from class java.lang.Object

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

Constructor Details

CustomScriptResource

public CustomScriptResource()

Method Details

getAllCustomScripts

@GET
public jakarta.ws.rs.core.Response getAllCustomScripts(@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)

getCustomScriptByName

@GET
@Path("/name/{name}")
public jakarta.ws.rs.core.Response getCustomScriptByName(@PathParam("name") @NotNull
 @NotNull String name)

getCustomScriptsByTypePattern

@GET
@Path("/type/{type}")
public jakarta.ws.rs.core.Response getCustomScriptsByTypePattern(@PathParam("type") @NotNull
 @NotNull String type,
 @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)

getCustomScriptByInum

@GET
@Path("/inum/{inum}")
public jakarta.ws.rs.core.Response getCustomScriptByInum(@PathParam("inum") @NotNull
 @NotNull String inum)

createScript

@POST
public jakarta.ws.rs.core.Response createScript(@Valid
 @Valid io.jans.model.custom.script.model.CustomScript customScript,
 @DefaultValue("false") @QueryParam("addScriptTemplate")
 boolean addScriptTemplate)

updateScript

@PUT
public jakarta.ws.rs.core.Response updateScript(@Valid @NotNull
 @Valid @NotNull io.jans.model.custom.script.model.CustomScript customScript)

deleteScript

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

patchScript

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

Throws:

com.github.fge.jsonpatch.JsonPatchException

IOException

getCustomScriptTypes

@GET
@Path("/types")
public jakarta.ws.rs.core.Response getCustomScriptTypes()

getCustomScriptTypesDetails

@GET
@Path("/script-types")
public jakarta.ws.rs.core.Response getCustomScriptTypesDetails()