io.higgs.http.server.resource

Annotation Type template

@Retention(value=RUNTIME)
@Target(value={METHOD,TYPE})
public @interface template

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The following rules apply on how variable names are mapped in the template.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	fragments Allows multiple template files to be specified.

Element Detail

value

public abstract String value

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}
             
QueryParams
         
         

             
${_form}
             
FormParams
         
         

             
${_files}
             
FormFiles
         
         

             
${_session}
             
io.higgs.http.server.params.HttpSession
         
         

             
${_cookies}
             
HttpCookies
         
         

             
${_request}
             
HttpRequest
         
         

             
${_response}
             
Object - the object returned by the resource method
         
         

             
${_server}
             
N/A
         
 
 
 

 

Returns:

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).

fragments

public abstract String[] fragments

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 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 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

Returns:

an empty array or a list of template fragments to merge into one

Default:

{}