REST with Java controllers

A 5-minute walkthrough: a Java @Controller with a JPA-style entity, an @Injected repository, and full CRUD.

1. Create a project

In the IDE, open the Workbench perspective. Right-click in the Projects view -> New -> Project. Name it countries-java.

2. Define an entity

Create countries-java/com/acme/Country.java:

package com.acme;

import org.eclipse.dirigible.sdk.db.*;

@Entity
@Table(name = "ACME_COUNTRY")
public class Country {

    @Id
    @GeneratedValue(GenerationType.IDENTITY)
    @Column(name = "ID")
    private Long id;

    @Column(name = "CODE", length = 3)
    private String code;

    @Column(name = "NAME", length = 200)
    private String name;

    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    public String getCode() { return code; }
    public void setCode(String code) { this.code = code; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
}

3. Add a repository

Create countries-java/com/acme/CountryRepository.java:

package com.acme;

import org.eclipse.dirigible.sdk.component.Repository;
import org.eclipse.dirigible.components.data.store.JavaEntityStore;
import org.eclipse.dirigible.components.base.spring.BeanProvider;

import java.util.List;

@Repository
public class CountryRepository {

    private final JavaEntityStore store = BeanProvider.getBean(JavaEntityStore.class);

    public Country save(Country c)        { store.save(c); return c; }
    public Country update(Country c)      { store.update(c); return c; }
    public Country get(Long id)           { return store.get(Country.class, id); }
    public List<Country> list()           { return store.list(Country.class); }
    public void delete(Long id)           { store.delete(Country.class, id); }
}

4. Add a controller

Create countries-java/com/acme/CountryController.java:

package com.acme;

import org.eclipse.dirigible.sdk.http.*;
import org.eclipse.dirigible.sdk.component.Inject;

import java.util.List;

@Controller("/countries")
public class CountryController {

    @Inject
    private CountryRepository repository;

    @Get
    public List<Country> list() { return repository.list(); }

    @Get("/{id}")
    public Country get(@PathParam("id") long id) { return repository.get(id); }

    @Post
    public Country create(@Body Country country) { return repository.save(country); }

    @Put("/{id}")
    public Country update(@PathParam("id") long id, @Body Country country) {
        country.setId(id);
        return repository.update(country);
    }

    @Delete("/{id}")
    public void remove(@PathParam("id") long id) { repository.delete(id); }
}

5. Publish

Right-click the project -> Publish. The Java synchronizer compiles every client .java in one cycle and installs the controller into the routing table.

6. Try it

curl -X POST http://localhost:8080/services/java/countries-java/com/acme/CountryController/countries \
     -H 'content-type: application/json' \
     -d '{"code":"FR","name":"France"}'

curl http://localhost:8080/services/java/countries-java/com/acme/CountryController/countries

7. OpenAPI

JavaControllerOpenApiPublisher emits an OpenAPI fragment at java-controller://countries-java::com.acme.CountryController. It joins the aggregated document at /services/openapi.

See also

• Languages: Java
• REST APIs (develop)
• org.eclipse.dirigible.sdk.http
• org.eclipse.dirigible.sdk.db
• REST with TypeScript decorators