javax.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 Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging 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: 35.0.0.Beta1

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2008-2009, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package javax.resource.spi;

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

/**
 * An annotation used to specify the authentication mechanism 
 * supported by the resource adapter.
 *
 * @since 1.6
 * @version Java EE Connector Architecture 1.6
 */
@Documented
@Retention(RUNTIME)
@Target({ })
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
    * @version Java EE Connector Architecture 1.6
    */
   public enum CredentialInterface 
   {
      /**
       * Corresponds to 
       * javax.resource.spi.security.PasswordCredential.
       * This is the default credential interface
       */
      PasswordCredential, 
        
      /**
       * Corresponds to org.ietf.jgss.GSSCredential
       */
      GSSCredential,
        
      /**
       * Corresponds to 
       * javax.resource.spi.security.GenericCredential
       */
      GenericCredential 
   };

   /**
    * The authentication-mechanismType 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.
    *
    */
   String authMechanism() default  "BasicPassword";
   
   /**
    * The optional description specifies
    * any resource adapter specific requirement for the support of
    * security contract and authentication mechanism.
    */
   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
    * javax.resource.spi.security.PasswordCredential interface.
    * The Kerbv5 mechanism type should support the
    * org.ietf.jgss.GSSCredential interface or the deprecated
    * javax.resource.spi.security.GenericCredential interface.
    */
   CredentialInterface credentialInterface() default CredentialInterface.PasswordCredential;
}