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

Class PluginResource

java.lang.Object
io.jans.configapi.core.rest.BaseResource
io.jans.configapi.rest.resource.auth.ConfigBaseResource
io.jans.configapi.rest.resource.auth.PluginResource
@Path("/plugin") @Consumes("application/json") @Produces("application/json") public class PluginResource extends ConfigBaseResource

  • Constructor Summary

    Constructors
    Constructor
    Description
    PluginResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    getPlugins()
    Retrieve summaries of deployed plugins.
    jakarta.ws.rs.core.Response
    isPluginDeployed(@NotNull String pluginName)
    Check whether a plugin with the given name is currently deployed.

    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

    • PluginResource

      public PluginResource()

  • Method Details

    • getPlugins

      @GET public jakarta.ws.rs.core.Response getPlugins()
      Retrieve summaries of deployed plugins.

      Each returned entry contains the plugin's name and description for plugins whose implementation classes are present on the classpath.

      Returns:
      a list of PluginConf objects containing the name and description of each deployed plugin

    • isPluginDeployed

      @GET @Path("{pluginName}") public jakarta.ws.rs.core.Response isPluginDeployed(@NotNull @PathParam("pluginName") @NotNull String pluginName)
      Check whether a plugin with the given name is currently deployed.
      Parameters:
      pluginName - the plugin name to check; comparison is case-insensitive
      Returns:
      `true` if a plugin with the given name is deployed, `false` otherwise