From e82be50601836631bc9b061fe7b3f6060ba81f7f Mon Sep 17 00:00:00 2001 From: "Peng.Li" Date: Thu, 25 Feb 2016 20:59:45 +0800 Subject: [PATCH] change README to markdown format for better reading --- everrest-samples/book-service/README.html | 243 ---------------------- everrest-samples/book-service/README.md | 205 ++++++++++++++++++ 2 files changed, 205 insertions(+), 243 deletions(-) delete mode 100644 everrest-samples/book-service/README.html create mode 100644 everrest-samples/book-service/README.md diff --git a/everrest-samples/book-service/README.html b/everrest-samples/book-service/README.html deleted file mode 100644 index 8b2a5848..00000000 --- a/everrest-samples/book-service/README.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - EverRest Example - - -

EverRest Example

- -

This is sample of using EverRest to launch JAX-RS services.

- -

We will create simple books service. It should be able give access to books by id, get list all available books - and add new book in storage. Service supports JSON format for transfer data to/from client.

- - - \ No newline at end of file diff --git a/everrest-samples/book-service/README.md b/everrest-samples/book-service/README.md new file mode 100644 index 00000000..ea4a0c1b --- /dev/null +++ b/everrest-samples/book-service/README.md @@ -0,0 +1,205 @@ +EverRest Example +================= + +This is sample of using EverRest to launch JAX-RS services. + +We will create simple books service. It should be able give access to books by id, get list all available books and add new book in storage. Service supports JSON format for transfer data to/from client. + +Add required _context-param_ +--------------------------- + +```xml + + javax.ws.rs.Application + org.everrest.sample.book.BookApplication + +``` + +- `javax.ws.rs.Application`: This is FQN of Java class that extends _javax.ws.rs.core.Application_ and provides set of classes and(or) instances of JAX-RS components. + + +Add bootstrap listeners +----------------------- + +Need add two listeners. First one initializes BookStorage and adds it to servlet context. The second one initializes common components of EverRest frameworks. + +```xml + + org.everrest.sample.book.BookServiceBootstrap + + + org.everrest.core.servlet.EverrestInitializedListener + +``` + +Add EverrestServlet +------------------- + +```xml + + EverrestServlet + org.everrest.core.servlet.EverrestServlet + + + EverrestServlet + /* + +``` + +EverRest components +------------------ + +- `org.everrest.sample.book.BookApplication` - application deployer. + + ```java + public class BookApplication extends Application { + @Override + public Set> getClasses() { + Set> cls = new HashSet>(1); + cls.add(BookService.class); + return cls; + } + + @Override + public Set getSingletons() { + Set objs = new HashSet(1); + objs.add(new BookNotFoundExceptionMapper()); + return objs; + } + } + ``` + +- `org.everrest.sample.book.Book` - simple Java Bean that will be used to transfer data via JSON. + +- `org.everrest.sample.book.BookNotFoundException` - exception that will be thrown by `org.everrest.sample.book.BookService` if client requested book that does not exist in storage. + +- `org.everrest.sample.book.BookNotFoundExceptionMapper` - JAX-RS component that intercepts `org.everrest.sample.book.BookNotFoundException` and send correct response to client. + + ```java + @Provider + public class BookNotFoundExceptionMapper implements ExceptionMapper { + Response toResponse(BookNotFoundException exception) { + return Response.status(404).entity(exception.getMessage()).type("text/plain").build(); + } + } + ``` + +- `org.everrest.sample.book.BookService` - JAX-RS service that process client's requests. Instance of BookStorage will be injected automatically thanks to `org.everrest.core.Inject` annotation + + ```java + @Path("books") + public class BookService { + @Inject + private BookStorage bookStorage; + + @Path("{id}") + @GET + @Produces("application/json") + public Book get(@PathParam("id") String id) throws BookNotFoundException { + Book book = bookStorage.getBook(id); + if (book == null) + throw new BookNotFoundException(id); + return book; + } + + @GET + @Produces("application/json") + public Collection getAll() { + return bookStorage.getAll(); + } + + @PUT + @Consumes("application/json") + public Response put(Book book, @Context UriInfo uriInfo) { + String id = bookStorage.putBook(book); + URI location = uriInfo.getBaseUriBuilder().path(getClass()).path(id).build(); + return Response.created(location).entity(location.toString()).type("text/plain").build(); + } + } + ``` + +- `org.everrest.sample.book.BookStorage` - storage of Books. + + ```java + public class BookStorage { + + private static int idCounter = 100; + + public synchronized String generateId() { + idCounter++; + return Integer.toString(idCounter); + } + + private Map books = new ConcurrentHashMap(); + + public BookStorage() { + init(); + } + + private void init() { + Book book = new Book(); + book.setTitle("JUnit in Action"); + book.setAuthor("Vincent Masson"); + book.setPages(386); + book.setPrice(19.37); + putBook(book); + } + + public Book getBook(String id) { + return books.get(id); + } + + public String putBook(Book book) { + String id = book.getId(); + if (id == null || id.trim().length() == 0) + { + id = generateId(); + book.setId(id); + } + books.put(id, book); + return id; + } + + public Collection getAll() { + return books.values(); + } + + public int numberOfBooks() { + return books.size(); + } + } + ``` + +Request mapping +--------------- + +- **GET** `book-service/books/{id}`: get books with specified id. Just after server start only one book in storage and it can be accessed via id `101` +- **GET** `book-service/books/`: get all books from storage. +- **PUT** `book-service/books/`: add new book in storage. The body of request must contains book's description in JSON format. The `Content-type` header must be set to `application/json` + +How to try +----------- + +Build project. + +``` +mvn clean install +``` + +Run it with Jetty server. + +``` +mvn jetty:run +``` + +Point you web browser to + +If you are under linux or other unix like OS the you can use `curl` utility (often it is already installed). Binary build of this utility available for windows also at . With `curl` you able to add new book in storage via command: + +``` +curl -X PUT \ + -H "Content-type:application/json" \ + -d '{"author":"My Author","title":"My Title","price":1.00,"pages":100}' \ + http://localhost:8080/book-service/books/ + +``` \ No newline at end of file