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.
AuthenticationPrincipal	Binds a handler parameter to the principal of whoever the request is from: the UserDetails the user store returned at sign-in, usually.
Autowired	Asks the build to inject this constructor, field or setter.
Bean	A method of a Configuration class whose return value is a bean.
Cacheable	Answers a call from the cache when the cache holds an answer for its key, and otherwise runs the method and keeps what it returned -- Spring's @Cacheable.
CacheEvict	Removes an entry from the cache when the method returns -- Spring's @CacheEvict.
CachePut	Always runs the method, then keeps what it returned under its key, so a later Cacheable call of the same key is answered with it -- Spring's @CachePut.
Component	Marks a class the build constructs and injects, once per server.
ConditionalOnExpression	Constructs this bean only when a boolean expression over the configuration is true.
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.
Controller	Build-time MVC declaration.
ControllerAdvice	A bean whose ExceptionHandler methods apply to every controller.
Counted	Counts the calls of this method, and separately the calls that threw.
CrossOrigin	A cross-origin policy for one controller or one handler, as Spring's @CrossOrigin is.
DeleteMapping	Maps an HTTP DELETE to this method.
DenyAll	Lets nobody call this method -- or any public method of this class.
EnableCaching	Accepted for Spring's sake and changes nothing: the build applies every Cacheable, CachePut and CacheEvict it finds, so caching needs no switch.
EventListener	Marks a bean method that runs when start-up is over, after every CommandLineRunner and ApplicationRunner.
ExceptionHandler	Marks a method that answers for an exception a controller method threw.
Generated	Marks a class the backend processors wrote, so a later pass knows its own work.
GetMapping	Maps an HTTP GET to this method.
Isolation	Isolation requested for one physical transaction.
JmsListener	Spring's @JmsListener, so a Spring listener ports by changing its import: the same as MessageListener, over whichever transport is configured.
KafkaListener	Spring Kafka's @KafkaListener, so a Spring listener ports by changing its import: the same as MessageListener, over whichever transport is configured.
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.
MessageListener	Receives the messages of a destination: the method runs once per message, on a consumer thread of the server, and the message is acknowledged when it returns.
ModelAttribute	Build-time MVC declaration.
OpenTelemetry	Traces this server with OpenTelemetry.
Order	Where a bean stands among the beans of its type: the lower the value, the earlier it comes in a List an injection point receives, and the earlier a SecurityFilterChain is asked whether a request is its own.
P	Names a parameter for a PreAuthorize expression, which refers to it as #name.
PatchMapping	Maps an HTTP PATCH to this method.
PathVariable	Binds a {name} segment of the path to this parameter.
PermitAll	Lets anyone call this method -- or every public method of this class.
PostConstruct	Called once the bean is constructed and every member is injected.
PostMapping	Maps an HTTP POST to this method.
PreAuthorize	Lets this method -- or every public method of this class -- run only when an expression about the caller holds.
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.
RabbitListener	Spring AMQP's @RabbitListener, so a Spring listener ports by changing its import: the same as MessageListener, over whichever transport is configured.
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 request parameter to this parameter: the query string's value, or, when the query has none, a field of the form the body carries -- application/x-www-form-urlencoded, or a multipart/form-data part that is not a file.
RequestPart	Binds one part of a multipart/form-data request body to this parameter.
ResponseBody	Build-time MVC declaration.
ResponseStatus	The status this method answers with when it returns normally.
RestController	Marks a class whose methods answer HTTP requests.
RestControllerAdvice	The same as ControllerAdvice; the name Spring applications use for advice whose handlers answer with data rather than views.
RolesAllowed	Lets this method -- or every public method of this class -- run only for a caller holding one of these roles: @RolesAllowed("ADMIN") asks for the authority ROLE_ADMIN.
Scheduled	Runs this method of a bean on a schedule.
Scope	How many instances of a bean there are, and how long each lives.
Secured	Lets this method -- or every public method of this class -- run only for a caller holding one of these authorities, each written in full: @Secured("ROLE_ADMIN").
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.
VirtualThreadStack	Gives every connection's virtual thread at least this much C stack.
WebSocketMapping	Marks a com.codename1.backend.WebSocket as the endpoint for a path.