Class Webhooks
- java.lang.Object
-
- com.unboundid.directory.sdk.sync.api.SyncDestination
-
- com.pingidentity.sync.destination.Webhooks
-
- All Implemented Interfaces:
com.unboundid.directory.sdk.common.internal.Configurable
,com.unboundid.directory.sdk.common.internal.ExampleUsageProvider
,com.unboundid.directory.sdk.common.internal.UnboundIDExtension
public class Webhooks extends com.unboundid.directory.sdk.sync.api.SyncDestination
This class provides a simple Webhooks destination
-
-
Field Summary
Fields Modifier and Type Field Description static String
CREATE_SUCCESS_CODES_ARG
static String
DELETE_SUCCESS_CODES_ARG
static String
MODIFY_SUCCESS_CODES_ARG
static String
URL_ARG
-
Constructor Summary
Constructors Constructor Description Webhooks()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
createEntry(com.unboundid.ldap.sdk.Entry entryToCreate, com.unboundid.directory.sdk.sync.types.SyncOperation operation)
Performs the necessary processing to publish a creation event to a webhook targetvoid
defineConfigArguments(com.unboundid.util.args.ArgumentParser parser)
Performs the necessary processing to declare the arguments the extension requires in order to perform its task.void
deleteEntry(com.unboundid.ldap.sdk.Entry entryToDelete, com.unboundid.directory.sdk.sync.types.SyncOperation operation)
Performs the necessary processing to publish a deleting to a webhook targetString
getCurrentEndpointURL()
Provides a descriptive endpoint URL for the instance of the extensionString[]
getExtensionDescription()
Provides a description for the extension for display purpose such as in manage-extension and dsconfigString
getExtensionName()
Provides the extension name for display purpose such as in manage-extension and dsconfigvoid
initializeSyncDestination(com.unboundid.directory.sdk.sync.types.SyncServerContext serverContext, com.unboundid.directory.sdk.sync.config.SyncDestinationConfig config, com.unboundid.util.args.ArgumentParser parser)
void
modifyEntry(com.unboundid.ldap.sdk.Entry entryToModify, List<com.unboundid.ldap.sdk.Modification> modsToApply, com.unboundid.directory.sdk.sync.types.SyncOperation operation)
Performs the necessary processing to publish a modification even to a webhook target
-
-
-
Field Detail
-
URL_ARG
public static final String URL_ARG
- See Also:
- Constant Field Values
-
CREATE_SUCCESS_CODES_ARG
public static final String CREATE_SUCCESS_CODES_ARG
- See Also:
- Constant Field Values
-
MODIFY_SUCCESS_CODES_ARG
public static final String MODIFY_SUCCESS_CODES_ARG
- See Also:
- Constant Field Values
-
DELETE_SUCCESS_CODES_ARG
public static final String DELETE_SUCCESS_CODES_ARG
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Webhooks
public Webhooks()
-
-
Method Detail
-
getExtensionName
public String getExtensionName()
Provides the extension name for display purpose such as in manage-extension and dsconfig- Specified by:
getExtensionName
in interfacecom.unboundid.directory.sdk.common.internal.UnboundIDExtension
- Specified by:
getExtensionName
in classcom.unboundid.directory.sdk.sync.api.SyncDestination
- Returns:
- the extension name
-
getExtensionDescription
public String[] getExtensionDescription()
Provides a description for the extension for display purpose such as in manage-extension and dsconfig- Specified by:
getExtensionDescription
in interfacecom.unboundid.directory.sdk.common.internal.UnboundIDExtension
- Specified by:
getExtensionDescription
in classcom.unboundid.directory.sdk.sync.api.SyncDestination
- Returns:
- a list of descriptive paragraphs
-
getCurrentEndpointURL
public String getCurrentEndpointURL()
Provides a descriptive endpoint URL for the instance of the extension- Specified by:
getCurrentEndpointURL
in classcom.unboundid.directory.sdk.sync.api.SyncDestination
- Returns:
- the instance URL
-
defineConfigArguments
public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
Performs the necessary processing to declare the arguments the extension requires in order to perform its task.- Specified by:
defineConfigArguments
in interfacecom.unboundid.directory.sdk.common.internal.Configurable
- Overrides:
defineConfigArguments
in classcom.unboundid.directory.sdk.sync.api.SyncDestination
- Parameters:
parser
- the argument parse to which arguments are to be registered- Throws:
com.unboundid.util.args.ArgumentException
- in case any argument could not be registered
-
initializeSyncDestination
public void initializeSyncDestination(com.unboundid.directory.sdk.sync.types.SyncServerContext serverContext, com.unboundid.directory.sdk.sync.config.SyncDestinationConfig config, com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.directory.sdk.sync.types.EndpointException
- Overrides:
initializeSyncDestination
in classcom.unboundid.directory.sdk.sync.api.SyncDestination
- Throws:
com.unboundid.directory.sdk.sync.types.EndpointException
-
createEntry
public void createEntry(com.unboundid.ldap.sdk.Entry entryToCreate, com.unboundid.directory.sdk.sync.types.SyncOperation operation) throws com.unboundid.directory.sdk.sync.types.EndpointException
Performs the necessary processing to publish a creation event to a webhook target- Specified by:
createEntry
in classcom.unboundid.directory.sdk.sync.api.SyncDestination
- Parameters:
entryToCreate
- the entry to createoperation
- the sync operation- Throws:
com.unboundid.directory.sdk.sync.types.EndpointException
- if any issue is encountered in the process of publishing the event
-
modifyEntry
public void modifyEntry(com.unboundid.ldap.sdk.Entry entryToModify, List<com.unboundid.ldap.sdk.Modification> modsToApply, com.unboundid.directory.sdk.sync.types.SyncOperation operation) throws com.unboundid.directory.sdk.sync.types.EndpointException
Performs the necessary processing to publish a modification even to a webhook target- Specified by:
modifyEntry
in classcom.unboundid.directory.sdk.sync.api.SyncDestination
- Parameters:
entryToModify
- the entry to modifymodsToApply
- the modifications to publishoperation
- the sync operation- Throws:
com.unboundid.directory.sdk.sync.types.EndpointException
- if any issue is encountered in the process of publishing the event
-
deleteEntry
public void deleteEntry(com.unboundid.ldap.sdk.Entry entryToDelete, com.unboundid.directory.sdk.sync.types.SyncOperation operation) throws com.unboundid.directory.sdk.sync.types.EndpointException
Performs the necessary processing to publish a deleting to a webhook target- Specified by:
deleteEntry
in classcom.unboundid.directory.sdk.sync.api.SyncDestination
- Parameters:
entryToDelete
- the entry to deleteoperation
- the sync operation- Throws:
com.unboundid.directory.sdk.sync.types.EndpointException
- if any issue is encountered in the process of publishing the event
-
-