step.handlers.javahandler.Keyword Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of step-api-keyword Show documentation
The newest version!
/*******************************************************************************
 * Copyright (C) 2020, exense GmbH
 *  
 * This file is part of STEP
 *  
 * STEP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *  
 * STEP 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 Affero General Public License for more details.
 *  
 * You should have received a copy of the GNU Affero General Public License
 * along with STEP.  If not, see .
 ******************************************************************************/
package step.handlers.javahandler;

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Keyword {

	/**
	 * @return the name of this keyword. If not specified the method name is 
	 * used as keyword name
	 */
	String name() default "";

	/**
	 * @return the description of this keyword.
	 */
	String description() default "";
	
	/**
	 * @return the list of properties required by this keyword
	 */
	String[] properties() default {};
	
	/**
	 * @return the list of optional properties which might be used by this keyword
	 */
	String[] optionalProperties() default {};
	
	/**
	 * @return the JSON schema of the input object. 
	 * @see  json-schema.org 
	 */
	String schema() default "";

	/**
	 * @return the call timeout for this keyword in milliseconds
	 */
	int timeout() default 180000;

	/**
	 * @return the reference to file with implementing plan (for composite keyword only)
	 */
	String planReference() default "";
}