jaspi/modules/IDMAuthModule.java

	IDMAuthModule.java revision 194cdefb77cf5217ac87c29c6412db51bd6b8c8d
/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2013-2015 ForgeRock AS.
 */

package org.forgerock.openidm.jaspi.modules;

import org.forgerock.jaspi.modules.session.jwt.JwtSessionModule;
import org.forgerock.jaspi.modules.session.openam.OpenAMSessionModule;
import org.forgerock.jaspi.modules.iwa.IWAModule;
import org.forgerock.jaspi.modules.openid.OpenIdConnectModule;

import javax.security.auth.message.module.ServerAuthModule;

/**
 * Enum that represents all the core IDM Authentication modules.
 */
public enum IDMAuthModule {

    /** JWT Session Auth Module. */
    JWT_SESSION(JwtSessionModule.class),
    /** OpenAM Session Auth Module. */
    OPENAM_SESSION(OpenAMSessionModule.class),
    /** Client-cert Auth Module. */
    CLIENT_CERT(ClientCertAuthModule.class),
    /** Delegated auth module using an {@link org.forgerock.openidm.jaspi.auth.Authenticator} */
    DELEGATED(DelegatedAuthModule.class),
    /** Managed User Auth Module. */
    MANAGED_USER(DelegatedAuthModule.class),
    /** Internal User Auth Module. */
    INTERNAL_USER(DelegatedAuthModule.class),
    /** Static User Auth Module. */
    STATIC_USER(DelegatedAuthModule.class),
    /** Passthrough to OpenICF connector Auth Module. */
    PASSTHROUGH(DelegatedAuthModule.class),
    /** IWA Auth Module. */
    IWA(IWAModule.class),
    /** OpenID Connect Auth Module. */
    OPENID_CONNECT(OpenIdConnectModule.class);

    private Class<? extends ServerAuthModule> clazz;

    /**
     * Constructs a new IDMAuthModule.
     *
     * @param clazz The corresponding class of the authentication module.
     */
    private IDMAuthModule(Class<? extends ServerAuthModule> clazz) {
        this.clazz = clazz;
    }

    /**
     * Gets the corresponding class of the authentication module.
     *
     * @return The authentication modules class.
     */
    public Class<? extends ServerAuthModule> getAuthModuleClass() {
        return clazz;
    }
}