com.docdoku.core.services

Interface IWebhookManagerLocal

public interface IWebhookManagerLocal

Author:

Morgan Guimard

Method Summary

Modifier and Type	Method and Description
SimpleWebhookApp	configureSimpleWebhook(String workspaceId, int webhookId, String method, String uri, String authorization)
SNSWebhookApp	configureSNSWebhook(String workspaceId, int webhookId, String topicArn, String region, String awsAccount, String awsSecret)
Webhook	createWebhook(String workspaceId, String name, boolean active)
void	deleteWebhook(String workspaceId, int id)
List<Webhook>	getActiveWebHooks(String workspaceId)
Webhook	getWebHook(String workspaceId, int id)
List<Webhook>	getWebHooks(String workspaceId)
Webhook	updateWebHook(String workspaceId, int id, String name, boolean active)

Method Detail

createWebhook

Webhook createWebhook(String workspaceId,
                      String name,
                      boolean active)
               throws UserNotFoundException,
                      WorkspaceNotFoundException,
                      UserNotActiveException,
                      WorkspaceNotEnabledException,
                      AccessRightException,
                      AccountNotFoundException

Throws:

UserNotFoundException

WorkspaceNotFoundException

UserNotActiveException

WorkspaceNotEnabledException

AccessRightException

AccountNotFoundException

getWebHooks

List<Webhook> getWebHooks(String workspaceId)
                   throws WorkspaceNotFoundException,
                          AccountNotFoundException,
                          AccessRightException

Throws:

WorkspaceNotFoundException

AccountNotFoundException

AccessRightException

getWebHook

Webhook getWebHook(String workspaceId,
                   int id)
            throws WorkspaceNotFoundException,
                   AccountNotFoundException,
                   AccessRightException,
                   WebhookNotFoundException

Throws:

WorkspaceNotFoundException

AccountNotFoundException

AccessRightException

WebhookNotFoundException

updateWebHook

Webhook updateWebHook(String workspaceId,
                      int id,
                      String name,
                      boolean active)
               throws WorkspaceNotFoundException,
                      AccessRightException,
                      WebhookNotFoundException,
                      AccountNotFoundException

Throws:

WorkspaceNotFoundException

AccessRightException

WebhookNotFoundException

AccountNotFoundException

deleteWebhook

void deleteWebhook(String workspaceId,
                   int id)
            throws WorkspaceNotFoundException,
                   AccountNotFoundException,
                   AccessRightException,
                   WebhookNotFoundException

Throws:

WorkspaceNotFoundException

AccountNotFoundException

AccessRightException

WebhookNotFoundException

configureSimpleWebhook

SimpleWebhookApp configureSimpleWebhook(String workspaceId,
                                        int webhookId,
                                        String method,
                                        String uri,
                                        String authorization)
                                 throws WorkspaceNotFoundException,
                                        AccessRightException,
                                        WebhookNotFoundException,
                                        AccountNotFoundException

Throws:

WorkspaceNotFoundException

AccessRightException

WebhookNotFoundException

AccountNotFoundException

configureSNSWebhook

SNSWebhookApp configureSNSWebhook(String workspaceId,
                                  int webhookId,
                                  String topicArn,
                                  String region,
                                  String awsAccount,
                                  String awsSecret)
                           throws WorkspaceNotFoundException,
                                  AccessRightException,
                                  WebhookNotFoundException,
                                  AccountNotFoundException

Throws:

WorkspaceNotFoundException

AccessRightException

WebhookNotFoundException

AccountNotFoundException

getActiveWebHooks

List<Webhook> getActiveWebHooks(String workspaceId)
                         throws UserNotFoundException,
                                WorkspaceNotFoundException,
                                UserNotActiveException,
                                WorkspaceNotEnabledException

Throws:

UserNotFoundException

WorkspaceNotFoundException

UserNotActiveException

WorkspaceNotEnabledException