A C D E F G H I L P S T U W

A

aroundReadFrom(ReaderInterceptorContext) - Method in class com.ibm.ecm.sample.webhook.util.HMACAuthenticationFilter

This method is the implementation of the aroundReadFrom method.

C

callGraphQLAPI(String) - Static method in class com.ibm.ecm.sample.webhook.util.GraphQLAPIUtil

Handles calls to the Content Services GraphQL API.

com.ibm.ecm.sample.webhook - package com.ibm.ecm.sample.webhook

com.ibm.ecm.sample.webhook.exception - package com.ibm.ecm.sample.webhook.exception

com.ibm.ecm.sample.webhook.util - package com.ibm.ecm.sample.webhook.util

Constants - Class in com.ibm.ecm.sample.webhook.util

General constants for the Content Event Webhook Receiver sample application, including constants to use for the Content Event Webhook External Event Actions and Subscriptions created by this sample application, as well as the key names for ServletContext attributes for sharing data across the sample application and the package name to use for logging.

Constants() - Constructor for class com.ibm.ecm.sample.webhook.util.Constants

contextDestroyed(ServletContextEvent) - Method in class com.ibm.ecm.sample.webhook.WebhookReceiverServletContextListener

Handles teardown for the Content Event Webhook Receiver sample application.

contextInitialized(ServletContextEvent) - Method in class com.ibm.ecm.sample.webhook.WebhookReceiverServletContextListener

Handles setup for the Content Event Webhook Receiver sample application.

CREATE_EVENTACTION_WITH_CLASSSUBSCRIPTION - Static variable in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Mutation for creating Webhook external event action and subscription.

CREATE_EVENTSUBSCRIPTION_DESCRIPTION - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

CREATE_EVENTSUBSCRIPTION_NAME - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

CS_SERVER_GRAPHQL_URL - Static variable in class com.ibm.ecm.sample.webhook.util.CSServerInfo

Content Services GraphQL API URL

CS_SERVER_OBJECTSTORE - Static variable in class com.ibm.ecm.sample.webhook.util.CSServerInfo

Object Store for Content Event Webhook Receiver sample

CS_SERVER_PASSWORD - Static variable in class com.ibm.ecm.sample.webhook.util.CSServerInfo

Content Platform Engine/Content Services password.

CS_SERVER_USERNAME - Static variable in class com.ibm.ecm.sample.webhook.util.CSServerInfo

Content Platform Engine/Content Services user.

CSServerInfo - Class in com.ibm.ecm.sample.webhook.util

This class is used for handling the Content Services server information, including the GraphQL server URL and login credentials for the user that will be used to configure the Content Event Webhook and handle callback requests to process the document that triggered the Webhook's subscription.

CSServerInfo() - Constructor for class com.ibm.ecm.sample.webhook.util.CSServerInfo

D

debug(String...) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message with the debug log level.

DELETE_DOCUMENT - Static variable in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Mutation for deleting a document.

DELETE_EVENTACTION_SUBSCRIPTIONS - Static variable in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Mutation for deleting existing Webhook external event action and associated subscriptions.

DOCUMENT_ID_LIST_ATTR_KEY - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

E

EEV_EVENT_ACTION_ID_ATTR_KEY - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

entering(String, String) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message with the trace log level.

error(String...) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message with the error log level.

error(String, Throwable) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message and a relevant exception that prompted the message with the error log level.

EVENTACTION_DESCRIPTION - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

EVENTACTION_NAME - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

EVENTS_JSON_ATTR_KEY - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

exiting(String, String) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message with the trace log level.

F

FETCH_EVENTACTION_WITH_CLASSSUBSCRIPTION - Static variable in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Query for retreiving the Webhook external event action and associated subscriptions.

G

GET_DOCUMENT - Static variable in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Query for retrieving a document.

getClasses() - Method in class com.ibm.ecm.sample.webhook.WebhookReceiverApplication

getString(String) - Static method in class com.ibm.ecm.sample.webhook.util.CSServerInfo

Get a property with the given key from CSServerInfo.properties.

getString(String) - Static method in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Get a property with the given key from GraphQLCallTemplate.properties.

GraphQLAPIUtil - Class in com.ibm.ecm.sample.webhook.util

Utility class for handling calls to the Content Services GraphQL API.

GraphQLAPIUtil() - Constructor for class com.ibm.ecm.sample.webhook.util.GraphQLAPIUtil

GraphQLCallTemplate - Class in com.ibm.ecm.sample.webhook.util

This class is used for keeping track of templates for various GraphQL calls.

GraphQLCallTemplate() - Constructor for class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

H

HMAC_CREDENTIAL_SECRET - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

HMACAuthenticationFilter - Class in com.ibm.ecm.sample.webhook.util

The HMACAuthenticationFilter class implements the ReaderInterceptor class, which combined with the @Provider annotation allows this class to automatically intercept any requests before they are accepted by the REST servlet.

HMACAuthenticationFilter() - Constructor for class com.ibm.ecm.sample.webhook.util.HMACAuthenticationFilter

HMACSecurityException - Exception in com.ibm.ecm.sample.webhook.exception

This class is a basic Runtime Exception class that is used by HMACAuthenticationFilter when there is a problem with the HMAC credential verification for the Content Event Webhook Receiver.

HMACSecurityException(String) - Constructor for exception com.ibm.ecm.sample.webhook.exception.HMACSecurityException

HMACSecurityException(String, Throwable) - Constructor for exception com.ibm.ecm.sample.webhook.exception.HMACSecurityException

I

info(String...) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message with the info log level.

L

listener(String) - Method in class com.ibm.ecm.sample.webhook.WebhookReceiver

This is the entry point for the Webhook Receiver to receive events from Content Platform Engine.

LOGGER_RECEIVER - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

P

PING_CONTENTSERVICE_SERVER - Static variable in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Query for pinging the Content Services server.

S

SUBSCRIPTION_ID_LIST_ATTR_KEY - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

T

throwing(String, Throwable) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a trace message when the code is about to throw an exception.

toResponse(Throwable) - Method in class com.ibm.ecm.sample.webhook.exception.WebhookReceiverExceptionMapper

trace(String...) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message with the trace log level.

U

UPDATE_DOCUMENT - Static variable in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Mutation for updating a document.

UPDATE_EVENTACTION_WITH_CLASSSUBSCRIPTION - Static variable in class com.ibm.ecm.sample.webhook.util.GraphQLCallTemplate

Mutation for updating an existing Webhook external event action and subscription.

UPDATE_EVENTSUBSCRIPTION_DESCRIPTION - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

UPDATE_EVENTSUBSCRIPTION_NAME - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

W

warn(String...) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message with the warn log level.

warn(String, Throwable) - Static method in class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

Logs a message and a relevant exception that prompted the message with the warn log level.

WEBHOOK_RECEIVER_REGISTRATION_ID - Static variable in class com.ibm.ecm.sample.webhook.util.Constants

WEBHOOK_RECEIVER_URL - Static variable in class com.ibm.ecm.sample.webhook.util.CSServerInfo

Content Event Webhook Receiver URL.

WebhookReceiver - Class in com.ibm.ecm.sample.webhook

Main servlet, which handles the logic for the Content Event Webhook Receiver.

WebhookReceiver() - Constructor for class com.ibm.ecm.sample.webhook.WebhookReceiver

WebhookReceiverApplication - Class in com.ibm.ecm.sample.webhook

Simple extension of the Application class for the Content Event Webhook Receiver sample application.

WebhookReceiverApplication() - Constructor for class com.ibm.ecm.sample.webhook.WebhookReceiverApplication

WebhookReceiverExceptionMapper - Class in com.ibm.ecm.sample.webhook.exception

In the event that the Content Event Webhook External Event action callout to the receiver sample application does not have the expected HMAC credential, HMACAuthenticationFilter will throw a HMACSecurityException.

WebhookReceiverExceptionMapper() - Constructor for class com.ibm.ecm.sample.webhook.exception.WebhookReceiverExceptionMapper

WebhookReceiverLogger - Class in com.ibm.ecm.sample.webhook.util

Collection of utility methods for handling logging with the Apache logger.

WebhookReceiverLogger() - Constructor for class com.ibm.ecm.sample.webhook.util.WebhookReceiverLogger

WebhookReceiverServletContextListener - Class in com.ibm.ecm.sample.webhook

Handles logic for startup and shutdown of the Content Event Webhook Receiver sample application.

WebhookReceiverServletContextListener() - Constructor for class com.ibm.ecm.sample.webhook.WebhookReceiverServletContextListener

A C D E F G H I L P S T U W