Package com.codename1.backend.annotations

package com.codename1.backend.annotations

Annotations that turn an ordinary class into an HTTP or websocket endpoint.

Mark a class RestController and its methods with GetMapping, PostMapping and the other verb mappings; bind the request to parameters with PathVariable, RequestParam, RequestHeader and RequestBody. The build reads these annotations and generates the router, so routing is decided at build time rather than by reflection when the server starts. The names follow Spring's, so the shape reads without learning it first.

Server code: these annotations are read by the backend build and mean nothing in an app.

Related Packages

Package	Description
com.codename1.backend	The Codename One backend runtime: the server side of an application, written in the same Java as the app and compiled to a native server binary.

Class	Description
Async	Runs this method on another thread; the caller returns at once.
Autowired	Asks the build to inject this constructor, field or setter.
Bean	A method of a Configuration class whose return value is a bean.
Component	Marks a class the build constructs and injects, once per server.
ConditionalOnMissingBean	Constructs this bean only when no other bean has its type.
ConditionalOnProperty	Constructs this bean only when a configuration key has a value.
Configuration	A class whose Bean methods produce beans.
ConfigurationProperties	Binds a group of configuration keys to the setters of a bean.
Counted	Counts the calls of this method, and separately the calls that threw.
DataSourceConfig	Connection pool settings, compiled in.
DeleteMapping	Maps an HTTP DELETE to this method.
EnableAsync	Accepted for familiarity and otherwise ignored: Async works without it.
EnableManagement	Builds the management endpoints into the server: health, metrics, the Prometheus view, scheduled jobs and managed beans, under /manage.
EnableMcpServer	Builds the MCP endpoint into the server, serving the application's McpTool methods over Streamable HTTP at /mcp.
EnableScheduling	Accepted for familiarity and otherwise ignored: Scheduled works without it.
Generated	Marks a class the backend processors wrote, so a later pass knows its own work.
GetMapping	Maps an HTTP GET to this method.
Lazy	Constructs this bean the first time something calls it, instead of at start-up.
ManagedAttribute	A getter of a ManagedResource bean published as a gauge.
ManagedOperation	A method of a ManagedResource bean that the management endpoint and the development MCP server can invoke.
ManagedResource	Publishes this bean's ManagedAttribute getters as metrics and its ManagedOperation methods as operations -- the JMX model, over OpenTelemetry.
McpParam	Names and describes one parameter of an McpTool method.
McpTool	Publishes this method of a bean as a tool on the server's MCP endpoint, so an agent can call it.
OpenTelemetry	Traces this server with OpenTelemetry.
PatchMapping	Maps an HTTP PATCH to this method.
PathVariable	Binds a {name} segment of the path to this parameter.
PostConstruct	Called once the bean is constructed and every member is injected.
PostMapping	Maps an HTTP POST to this method.
PreDestroy	Called when the server stops, after it has finished the requests in flight and before the database closes.
Primary	The bean an injection point receives when several have its type and it names none.
Profile	Constructs this bean only when a profile is active.
Propagation	What a Transactional method does about a transaction that is already open on the calling thread.
PutMapping	Maps an HTTP PUT to this method.
Qualifier	Picks one bean by name where several have the type an injection point asks for.
Repository	A Component in the persistence layer.
RequestBody	Binds the decoded request body to this parameter.
RequestHeader	Binds a request header to this parameter.
RequestMapping	A path, and optionally a verb, for a controller or one of its methods.
RequestParam	Binds a query parameter to this parameter.
RequestScope	Shorthand for @Scope("request").
ResponseStatus	The status this method answers with when it returns normally.
RestController	Marks a class whose methods answer HTTP requests.
Scheduled	Runs this method of a bean on a schedule.
Scope	How many instances of a bean there are, and how long each lives.
ServerConfig	Listener settings, compiled in.
Service	A Component in the service layer.
SessionConfig	Session settings, compiled in.
SessionScope	Shorthand for @Scope("session").
StaticFilesConfig	Static file settings, compiled in.
ThreadKind	Which kind of thread runs background work: an Async method or a Scheduled job.
Timed	Records how long each call of this method takes, as a histogram.
Transactional	Runs this method -- or every public method of this class -- in a database transaction.
Value	Injects a configuration value.
WebSocketMapping	Marks a com.codename1.backend.WebSocket as the endpoint for a path.