Package io.jans.ca.plugin.adminui.rest.license

Class LicenseResource

  • @Path("/admin-ui/license")
public class LicenseResource
extends Object

    • Constructor Detail

      • LicenseResource

        public LicenseResource()

    • Method Detail

      • isActive

        @GET
@Path("/isActive")
@Produces("application/json")
public jakarta.ws.rs.core.Response isActive()
        Check whether an active admin‑ui license exists.

        Responds with a JSON payload describing the license check result.

        Returns:
        HTTP Response whose entity is a GenericResponse. The GenericResponse's `success` is `true` if an active license exists, `false` otherwise; the Response's HTTP status code reflects the result. On unexpected error the method returns a 500 server error and the entity may be null.

      • deleteLicenseConfiguration

        @DELETE
@Path("/deleteConfig")
@Produces("application/json")
public jakarta.ws.rs.core.Response deleteLicenseConfiguration()
        Delete license details from the admin UI configuration.
        Returns:
        a GenericResponse describing the operation result; its success flag indicates whether deletion succeeded and its responseCode contains the HTTP status to return

      • retrieveLicense

        @GET
@Path("/retrieve")
@Produces("application/json")
public jakarta.ws.rs.core.Response retrieveLicense()
        Retrieve the current license from SCAN.
        Returns:
        HTTP Response whose entity is a GenericResponse containing license details and an operation status; the HTTP status code reflects the operation result.

      • trial

        @GET
@Path("/trial")
@Produces("application/json")
public jakarta.ws.rs.core.Response trial()
        Generate a trial license for the admin UI.
        Returns:
        Response containing a GenericResponse describing the result of the trial license generation. On success the HTTP status equals the GenericResponse's responseCode and the entity contains details; on internal error the endpoint returns HTTP 500 with the GenericResponse entity (which may be null).

      • activate

        @POST
@Path("/activate")
@Produces("application/json")
public jakarta.ws.rs.core.Response activate​(@Valid @NotNull
                                            @Valid @NotNull LicenseRequest licenseRequest)
        Activate the admin UI license using the provided license key.
        Parameters:
        licenseRequest - request containing the license key and any related metadata
        Returns:
        a JAX-RS Response whose entity is a GenericResponse describing whether activation succeeded and carrying the appropriate response code

      • ssa

        @POST
@Path("/ssa")
@Produces("application/json")
public jakarta.ws.rs.core.Response ssa​(@Valid @NotNull
                                       @Valid @NotNull SSARequest ssaRequest)
        Save Single Sign-On (SSA) configuration. Persists the provided SSA configuration and returns the operation result.
        Parameters:
        ssaRequest - SSARequest payload containing SSA configuration; must be non-null and valid.
        Returns:
        a Response whose entity is a GenericResponse describing success and containing the HTTP response code.

      • isConfigValid

        @GET
@Path("/isConfigValid")
@Produces("application/json")
public jakarta.ws.rs.core.Response isConfigValid()
        Checks whether the stored Admin UI license configuration is valid.
        Returns:
        an HTTP Response containing a GenericResponse whose `success` is `true` if the configuration is valid and `false` otherwise; the response status code reflects the operation result

      • details

        @GET
@Path("/details")
@Produces("application/json")
public jakarta.ws.rs.core.Response details()
        Retrieves admin UI license details.
        Returns:
        LicenseResponse containing the current admin UI license details on success; a GenericResponse containing error information on failure.