org.picketlink.authorization.annotations.LoggedIn Maven / Gradle / Ivy
/*
* 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.Account;
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 where only authenticated users are allowed to invoke a method.
*
* The constraint is validated before method invocation.
*
* @author Pedro Igor
*/
@Retention(value = RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@SecurityBindingType
public @interface LoggedIn {
/**
* If defined, checks if the authenticated account is the same or a subclass of the given {@link org.picketlink.idm.model.Account} type.
*
* By default, any subclass of {@link org.picketlink.idm.model.Account} type is supported.
*
* @return
*/
@Nonbinding
Class requiresAccount() default Account.class;
}