jakarta.resource.spi.AuthenticationMechanism Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 34.0.0.Final

Show newest version

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.resource.spi;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import java.lang.annotation.Documented;
import static java.lang.annotation.RetentionPolicy.*;

@Documented
@Retention(RUNTIME)
@Target({})
/* The AuthenticationMechanism declared type is intended 
solely for use as a member type in complex annotation type declarations
like Connector.
*/

/**
 * An annotation used to specify the authentication mechanism 
 * supported by the resource adapter.
 *
 * @since 1.6
 */
public @interface AuthenticationMechanism {

    /** 
     * An enumerated type that represents the various interfaces
     * that a resource adapter may support for the representation
     * of the credentials.
     *
     * @since 1.6
     */
    public enum CredentialInterface {
        /**
         * Corresponds to 
         * jakarta.resource.spi.security.PasswordCredential.
         * This is the default credential interface
         */
        PasswordCredential, 
        
        /**
         * Corresponds to org.ietf.jgss.GSSCredential
         */
        GSSCredential,
        
        /**
         * Corresponds to 
         * jakarta.resource.spi.security.GenericCredential
         */
        GenericCredential 
    }

    /**
     * The authentication-mechanism-type specifies an authentication
     * mechanism supported by the resource adapter. Note that this
     * support is for the resource adapter and not for the
     * underlying EIS instance.
     * @return authentication
     * mechanism supported by the resource adapter
     */
    String authMechanism() default  "BasicPassword";

    /**
     * The optional description specifies
     * any resource adapter specific requirement for the support of
     * security contract and authentication mechanism.
     * @return description
     */
    String[] description() default {};

    /**
     * Represents the interface that the resource adapter implementation
     * supports for the representation of the credentials.
     *
     * Note that BasicPassword mechanism type should support the
     * jakarta.resource.spi.security.PasswordCredential interface.
     * The Kerbv5 mechanism type should support the
     * org.ietf.jgss.GSSCredential interface or the deprecated
     * jakarta.resource.spi.security.GenericCredential interface.
     * @return interface that the resource adapter implementation
     * supports for the representation of the credentials
     */
    CredentialInterface credentialInterface() 
    					default CredentialInterface.PasswordCredential;
}