io.higgs.http.server.resource.template Maven / Gradle / Ivy
The newest version!
package io.higgs.http.server.resource;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* If applied to a class then the same template is used for all methods in the class, UNLESS
* the method itself has given a different template. All methods can have their own template
*
* @author Courtney Robinson
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
public @interface template {
/**
* The following rules apply on how variable names are mapped in the template.
* * 1) If the response is a Map the map's keys become the variable names in the template and the
* map's respective values are the values to those names
*
* 2) If the response is any type, other than Map or POJOs the variable name in the template
* is "_response", i.e. if the method returns the number 100 in the template it can be accessed as
* ${_response}. Note, this variable is always available, even for POJOs and Maps.
*
* 3) For POJOs the field names will become the variable names
*
* 4) Reserved variable names that will be automatically available in the template include:
* ${_query} ,${_form},${_files},${_session},${_cookies},${_request},${_response},${_server}
* *
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
Template Variable name Class/Type ${_query} {@link io.higgs.http.server.params.QueryParams} ${_form} {@link io.higgs.http.server.params.FormParams} ${_files} {@link io.higgs.http.server.params.FormFiles} ${_session} {@link io.higgs.http.server.params.HttpSession} ${_cookies} {@link io.higgs.http.server.params.HttpCookies} ${_request} {@link io.higgs.http.server.HttpRequest} ${_response} {@link Object} - the object returned by the resource method ${_server} N/A
* *
* * @return The path to a template that the resource's response is mapped to. * The response can be any collection, POJO, array or primitive (inc strings). */ String value(); /** * Allows multiple template files to be specified. The files will be merged once at start up. * The resulting file will be passed through Thymeleaf as a single template. * If the array returned as any items then {@link #value()} is used as the name of the file to generate. * If a file exists with that name it will be replaced with the newly generated file. If {@link #value()} returns * null or an empty string then a random file name is used. The location of the generated files is determined by * the server config's temp_templates directory * * @return an empty array or a list of template fragments to merge into one */ String[] fragments() default { }; }