001/**
002 * Copyright 2014 Tampere University of Technology, Pori Department
003 * 
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * 
008 *   http://www.apache.org/licenses/LICENSE-2.0
009 * 
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package core.tut.pori.http.annotations;
017
018import static java.lang.annotation.ElementType.PARAMETER;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.lang.annotation.Documented;
022import java.lang.annotation.Inherited;
023import java.lang.annotation.Retention;
024import java.lang.annotation.Target;
025
026/**
027 * Define the method parameter to be a special authentication parameter.
028 * 
029 * Note that this annotation can only be used in combination with classes or subclass of AuthenticationParameter, 
030 * an attempt to the contrary will result in an error on web application context initialization.
031 */
032@Retention(RUNTIME)
033@Target({PARAMETER})
034@Inherited
035@Documented
036public @interface HTTPAuthenticationParameter { 
037  /**
038   * 
039   * @return whether authenticated user is required
040   */
041  boolean required() default true;
042  /**
043   * 
044   * @return whether login prompt should be shown (with 401 Unauthorized), if false, this will simply return 403 FORBIDDEN
045   */
046  boolean showLoginPrompt() default false;
047}