com.eclipsesource.restfuse.annotation.Header Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.eclipsesource.restfuse Show documentation

An open-source JUnit extension for automated HTTP/REST Tests

There is a newer version: 1.2.0

Show newest version

/*******************************************************************************
 * Copyright (c) 2011 EclipseSource and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Holger Staudacher - initial API and implementation
 ******************************************************************************/ 
package com.eclipsesource.restfuse.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The Header annotation represents a single header attribute of an http request.
 * This headers can be set in a {@link HttpTest} annotation attached to a test method.
 *  
 *
 * @see HttpTest
 */
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.ANNOTATION_TYPE } )
public @interface Header {

  /**
   * The name attribute represents the name of the header element which comes before 
   * the ":" within a request header.
   */
  String name();

  /**
   * The value attribute represents the value of the header element which comes 
   * after the ":" within a request header.
   */
  String value();
}