io.gravitee.rest.api.service.notification.PortalHook Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-rest-api-service Show documentation

Gravitee IO Manager Service

There is a newer version: 3.10.0

Show newest version

/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gravitee.rest.api.service.notification;

/**
 * @author Nicolas GERAUD (nicolas.geraud at graviteesource.com)
 * @author GraviteeSource Team
 */
public enum PortalHook implements Hook {
    USER_REGISTRATION_REQUEST(
        "User Registration Request",
        "Triggered when a new user is created and automatic validation is disabled",
        "USER"
    ),
    USER_REGISTERED("User Registered", "Triggered when an user is registered", "USER"),
    USER_CREATED("User Created", "Triggered when an user is created", "USER"),
    USER_FIRST_LOGIN("First Login", "Triggered when an user log in for the first time", "USER"),
    PASSWORD_RESET("Password Reset", "Triggered when a password is reset", "USER"),
    NEW_SUPPORT_TICKET("New Support Ticket", "Triggered when a new support ticket is created", "SUPPORT"),
    GROUP_INVITATION("Group invitation", "Triggered when an user is invited in a group", "GROUP"),
    MESSAGE("Message", "Used when sending a custom message to an Environment Role", null, true);

    private String label;
    private String description;
    private String category;
    private boolean hidden;

    PortalHook(String label, String description, String category) {
        this(label, description, category, false);
    }

    PortalHook(String label, String description, String category, boolean hidden) {
        this.label = label;
        this.description = description;
        this.category = category;
        this.hidden = hidden;
    }

    @Override
    public String getLabel() {
        return label;
    }

    @Override
    public String getDescription() {
        return description;
    }

    @Override
    public String getCategory() {
        return category;
    }

    @Override
    public HookScope getScope() {
        return HookScope.PORTAL;
    }

    @Override
    public boolean isHidden() {
        return hidden;
    }
}