org.wisdom.api.security.Authenticated Maven / Gradle / Ivy
/*
* #%L
* Wisdom-Framework
* %%
* Copyright (C) 2013 - 2014 Wisdom Framework
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.wisdom.api.security;
import org.wisdom.api.annotations.Interception;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation instructing Wisdom to check for the authentication of the user when calling annotated controller and
* action methods.
*
* The check relies on {@link org.wisdom.api.security.Authenticator} services. This means that if there are not
* providers of such service, the action cannot be called. When several providers are available,
* the {@link #value()} method let you specify the implementation to use.
*/
@Interception
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Authenticated {
/**
* @return the name of the authenticator to use. If not set, an implementation will be picked automatically.
*/
String value() default "";
}