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 * A header parameter for HTTPServiceMethod.
028 * 
029 * Note that the both the method name and value MUST follow the HTTP header standard, as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
030 */
031@Retention(RUNTIME)
032@Target({PARAMETER})
033@Inherited
034@Documented
035public @interface HTTPHeaderParameter {
036  /**
037   * 
038   * @return name of the header
039   */
040  String name();
041  
042  /**
043   * 
044   * @return header value
045   */
046  String defaultValue() default "";
047  
048  /**
049   * 
050   * @return whether this parameter is required or not
051   */
052  boolean required() default true;
053}