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

Class WebhookResource

java.lang.Object

io.jans.configapi.core.rest.BaseResource

io.jans.ca.plugin.adminui.rest.webhook.WebhookResource

@Path("/admin-ui/webhook")
public class WebhookResource
extends io.jans.configapi.core.rest.BaseResource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN_UI_FEATURES
static final String	FEATURE_ID_PATH_VARIABLE
static final String	SCOPE_WEBHOOK_DELETE
static final String	SCOPE_WEBHOOK_READ
static final String	SCOPE_WEBHOOK_WRITE
static final String	TRIGGER_PATH
static final String	WEBHOOK
static final String	WEBHOOK_ID_PATH_VARIABLE

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

DEFAULT_SEARCH_PATTERN

Constructor Summary

Constructors

Constructor	Description
WebhookResource()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addWebhook(@Valid WebhookEntry webhook)
jakarta.ws.rs.core.Response	deleteWebhook(@NotNull String webhookId)
jakarta.ws.rs.core.Response	getAllAdminUIFeatures()
jakarta.ws.rs.core.Response	getAllAuiFeaturesByWebhookId(@NotNull String webhookId)
jakarta.ws.rs.core.Response	getAllWebhooksByFeatureId(@NotNull String featureId)
jakarta.ws.rs.core.Response	getWebhooks(int limit, String pattern, int startIndex, String sortBy, String sortOrder, String fieldValuePair)
jakarta.ws.rs.core.Response	triggerWebhook(@NotNull String featureId, @Valid @NotNull List<ShortCodeRequest> shortCodes)
jakarta.ws.rs.core.Response	updateWebhook(@Valid WebhookEntry webhook)

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, getRegexPattern, 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

Field Details

SCOPE_WEBHOOK_READ

public static final String SCOPE_WEBHOOK_READ

See Also:

• Constant Field Values

SCOPE_WEBHOOK_WRITE

public static final String SCOPE_WEBHOOK_WRITE

See Also:

• Constant Field Values

SCOPE_WEBHOOK_DELETE

public static final String SCOPE_WEBHOOK_DELETE

See Also:

• Constant Field Values

WEBHOOK

public static final String WEBHOOK

See Also:

• Constant Field Values

WEBHOOK_ID_PATH_VARIABLE

public static final String WEBHOOK_ID_PATH_VARIABLE

See Also:

• Constant Field Values

FEATURE_ID_PATH_VARIABLE

public static final String FEATURE_ID_PATH_VARIABLE

See Also:

• Constant Field Values

TRIGGER_PATH

public static final String TRIGGER_PATH

See Also:

• Constant Field Values

ADMIN_UI_FEATURES

public static final String ADMIN_UI_FEATURES

See Also:

• Constant Field Values

Constructor Details

WebhookResource

public WebhookResource()

Method Details

getAllAdminUIFeatures

@GET
@Path("/features")
@Produces("application/json")
public jakarta.ws.rs.core.Response getAllAdminUIFeatures()

getAllAuiFeaturesByWebhookId

@GET
@Path("/features/{webhookId}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getAllAuiFeaturesByWebhookId(@PathParam("webhookId") @NotNull
 @NotNull String webhookId)

getAllWebhooksByFeatureId

@GET
@Path("/{featureId}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getAllWebhooksByFeatureId(@PathParam("featureId") @NotNull
 @NotNull String featureId)

getWebhooks

@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response getWebhooks(@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)

addWebhook

@POST
@Produces("application/json")
public jakarta.ws.rs.core.Response addWebhook(@Valid
 @Valid WebhookEntry webhook)

updateWebhook

@PUT
@Produces("application/json")
public jakarta.ws.rs.core.Response updateWebhook(@Valid
 @Valid WebhookEntry webhook)

deleteWebhook

@DELETE
@Path("/{webhookId}")
@Produces("application/json")
public jakarta.ws.rs.core.Response deleteWebhook(@PathParam("webhookId") @NotNull
 @NotNull String webhookId)

triggerWebhook

@POST
@Path("/trigger/{featureId}")
@Produces("application/json")
public jakarta.ws.rs.core.Response triggerWebhook(@PathParam("featureId") @NotNull
 @NotNull String featureId,
 @Valid @NotNull
 @Valid @NotNull List<ShortCodeRequest> shortCodes)