com.github.dynamicextensionsalfresco.webscripts.annotations.RequestParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of annotations Show documentation

Adds an OSGi container to alfresco repository supporting dynamic code reloading, classpath isolation and a bunch of other useful features

The newest version!

package com.github.dynamicextensionsalfresco.webscripts.annotations;

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

@Target({ ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestParam {

	/**
	 * The request parameter name. If not specified, the parameter's Java variable name will be used instead. The
	 * variable name is only available if classes are compiled with debug info.
	 */
	String value() default "";

	/**
	 * The default value. If a default value is specified, the {@link #required()} setting has no effect.
	 */
	String defaultValue() default "";

	/**
	 * Indicates whether the parameter is required. This setting has no effect if {@link #defaultValue()} is specified
	 */
	boolean required() default true;

	/**
	 * Specifies the delimiter for splitting the request parameter into multiple values. This setting only has effect if
	 * the argument is an Array.
	 */
	String delimiter() default "";

	/**
	 * Specifies the status code to be returned when a required parameter is missing
	 */
	int missingParameterHttpStatusCode() default 400;
}