Package google.registry.request

Annotation Interface Action

@Retention(RUNTIME)
@Target(TYPE)
public @interface Action

Annotation for Runnable actions accepting HTTP requests from RequestHandler.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Action.GaeService
static enum	Action.GkeService
static enum	Action.Method	HTTP methods recognized by the request processor.
static interface	Action.Service
static class	Action.ServiceGetter

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
Auth	auth	Authentication settings.
String	path	HTTP path to serve the action from.
Action.GaeService	service	Which App Engine service this action lives on.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	automaticallyPrintOk	Indicates request processor should print "OK" to the HTTP client on success.
Action.GkeService	gkeService	Which GKE service this action lives on.
boolean	isPrefix	Indicates all paths starting with this path should be accepted.
Action.Method[]	method	HTTP methods that request processor should allow.

Element Details

service

Action.GaeService service

Which App Engine service this action lives on.

gkeService

Action.GkeService gkeService

Which GKE service this action lives on.

Default:

SAME_AS_GAE

path

String path

HTTP path to serve the action from. The path components must be percent-escaped.

isPrefix

boolean isPrefix

Indicates all paths starting with this path should be accepted.

Default:

false

method

Action.Method[] method

HTTP methods that request processor should allow.

Default:

{GET}

automaticallyPrintOk

boolean automaticallyPrintOk

Indicates request processor should print "OK" to the HTTP client on success.

This is important because it's confusing to manually invoke a backend task and have a blank page show up. And it's not worth injecting a Response object just to do something so trivial.

Default:

false

auth

Auth auth

Authentication settings.