xapi.server.annotation

Annotation Type XapiServlet

@Documented
@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface XapiServlet

An annotation for servlets to have their url mappings and general behavior automapped, in our xapi.test.server.TestServer, and to generate web.xml during mvn process-resources

Author:

"James X. Nelson (james@wetheinter.net)"

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	prefix Required attribute; this is the string prefix after /xapi in the servlet url.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends javax.servlet.http.HttpServlet>	servletType Optional attribute; an HttpServlet class to use as an ancestor to this servlet.

Element Detail

prefix

public abstract String prefix

Required attribute; this is the string prefix after /xapi in the servlet url.

Returns:

- http://host/xapi/${prefix}

servletType

public abstract Class<? extends javax.servlet.http.HttpServlet> servletType

Optional attribute; an HttpServlet class to use as an ancestor to this servlet. This field is available to make any arbitrary class available at build-time.

Returns:

- Any class that extends HttpServlet; to send hints to your generator / injector. Using ObjectServlet will give you a simple bean-model endpoint for an object.

  if prefix = "Bean",
  && servletType == ObjectServlet,
  /xapi/Bean/new/id -> new bean (never null)
  /xapi/Bean/get/id -> get bean (null if doesn't exist)
  /xapi/Bean/has/id -> check bean != null
  /xapi/Bean/del/id -> delete bean
  /xapi/Bean/set/id/data -> set bean
  /xapi/Bean/up/id/data -> update bean

 

Default:

xapi.server.ObjectServlet.class