001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 */
016package org.forgerock.opendj.rest2ldap;
017
018/**
019 * Represents an {@link org.forgerock.json.resource.ActionRequest action} that may be performed against a resource.
020 * Resources will only accept actions which have been {@link Resource#supportedAction(Action) registered} as being
021 * supported.
022 */
023public enum Action {
024    // Note: actions are likely to become an extension point in future versions of Rest2Ldap, in which case this enum
025    // will need to be converted into a regular class or interface,
026
027    /** An action that allows users to change their password. */
028    MODIFY_PASSWORD("modifyPassword"),
029
030    /** An action that allows users to reset their password. */
031    RESET_PASSWORD("resetPassword");
032
033    private final String actionId;
034
035    Action(final String actionId) {
036        this.actionId = actionId;
037    }
038
039    @Override
040    public String toString() {
041        return actionId;
042    }
043}