org.jboss.security.annotation.Module Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of picketbox

PicketBox is a security framework for Java Applications

There is a newer version: 5.1.0.Final

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2008, 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 org.jboss.security.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Represents a Module
 * @author [email protected]
 * @since Mar 2, 2010
 */ 
@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Module 
{
   /**
    * The FQN of the module
    * @return
    */
   Class code(); 
   
   /**
    * Get the FLAG (REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL)
    * satisfying the JAAS Configuration semantics
    * @return
    */
   String flag() default "REQUIRED";
   
   /**
    * Mainly used by mapping modules
    * @return
    */
   String type() default "";
   /**
    * Get an array of ModuleOption
    * @return
    */
   ModuleOption[] options();
}