org.picketlink.authorization.annotations.PartitionsAllowed Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of picketlink-deltaspike
The newest version!
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., 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.picketlink.authorization.annotations;

import org.apache.deltaspike.security.api.authorization.SecurityBindingType;
import org.picketlink.idm.model.Partition;

import javax.enterprise.util.Nonbinding;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Defines an authorization constraint that checks if the authenticated {@link org.picketlink.idm.model.Account} is
 * stored within a partition.
 *
 * The constraint is validated before method invocation.
 *
 * @author  Pedro Igor
 */
@Retention(value = RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@SecurityBindingType
public @interface PartitionsAllowed {

    /**
     * If defined, checks if the account's partition is the same or a subclass of the given {@link org.picketlink.idm.model.Partition} type.
     *
     * By default, any subclass of {@link org.picketlink.idm.model.Partition} type is supported.
     *
     * @return
     */
    @Nonbinding
    Class type() default Partition.class;

    /**
     * The name(s) of the partition(s) allowed to access.
     *
     * @return
     */
    @Nonbinding
    String[] name() default "";

}