My previous restful client example <\/a>and server example <\/a>were perfect, well, not exactly. \u00a0They worked but they pretty much assuming a perfect world. \u00a0That is to say that there is never a communication error or a server error.<\/p>\n This small example will return one of the magazine objects. \u00a0Depending how you call it, it will return either the object directly or the xml that you can marshal into the object itself.<\/p>\n However, it should be pretty obvious in the previous simple server code that if for any reason the server cannot find the data it cannot really communicate that fact back to the client. \u00a0Well, it cannot if you are returning magazine objects or general strings.<\/p>\n The solution is to return a response record. \u00a0This record will contain both the error code as well as our object. \u00a0The code is actually not too different from from the previous example but there are some\u00a0major differences.<\/p>\n The first is that we are no longer returning either xml(string) nor magazine objects but rather we are\u00a0returning Response objects. \u00a0 \u00a0This allows us to set the status to one of the values that matches the result of the call.<\/p>\n It is possible to use one of the predefined values such as Response.Status.OK but it is just as acceptable to put the actual value of 200.<\/p>\n Here is a list of\u00a0the values that are defined for us to use.<\/p>\n\/\/ example 2\/3 setup\r\nClientConfig config1 = new ClientConfig();\r\nClient client1 = ClientBuilder.newClient(config1);\r\nWebTarget target1 = client1.target(uribase);\r\n\t\t\r\n\/\/ example 3\r\nmagazine xmlobj = target1.path(\"\/Communicate\/hello\").request().accept(MediaType.APPLICATION_XML).get(magazine.class);\r\nshowMagazine(\"pure xml object\", xmlobj);\r\n<\/pre>\n
New and better server<\/h2>\n
Response.Status.OK<\/pre>\n
| Response codes<\/th>\n | Description<\/th>\n<\/tr>\n |
|---|---|
| OK<\/td>\n | 200<\/td>\n<\/tr>\n |
| CREATED<\/td>\n | 201<\/td>\n<\/tr>\n |
| ACCEPTED<\/td>\n | 202<\/td>\n<\/tr>\n |
| NO_CONTENT<\/td>\n | 204<\/td>\n<\/tr>\n |
| MOVED_PERMANENTLY<\/td>\n | 301<\/td>\n<\/tr>\n |
| SEE_OTHER<\/td>\n | 303<\/td>\n<\/tr>\n |
| NOT_MODIFIED<\/td>\n | 304<\/td>\n<\/tr>\n |
| TEMPORARY_REDIRECT<\/td>\n | 307<\/td>\n<\/tr>\n |
| BAD_REQUEST<\/td>\n | 400<\/td>\n<\/tr>\n |
| UNAUTHORIZED<\/td>\n | 401<\/td>\n<\/tr>\n |
| FORBIDDEN<\/td>\n | 403<\/td>\n<\/tr>\n |
| NOT_FOUND<\/td>\n | 404<\/td>\n<\/tr>\n |
| NOT_ACCEPTABLE<\/td>\n | 406<\/td>\n<\/tr>\n |
| CONFLICT<\/td>\n | 409<\/td>\n<\/tr>\n |
| GONE<\/td>\n | 410<\/td>\n<\/tr>\n |
| PRECONDITION_FAILED<\/td>\n | 412<\/td>\n<\/tr>\n |
| UNSUPPORTED_MEDIA_TYPE<\/td>\n | 415<\/td>\n<\/tr>\n |
| INTERNAL_SERVER_ERROR<\/td>\n | 500<\/td>\n<\/tr>\n |
| SERVICE_UNAVAILABLE<\/td>\n | 503<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n The code in this “server code” is not much larger than the original code.<\/p>\n Another one of the changes is that the URI is returned as part of the response object. \u00a0This URI should point to the the data in the server. \u00a0This is especially interesting if a new object is created on your server. \u00a0The server then will return the URI to reference that object.<\/p>\n The final difference is that we pass back our object as part of the Response object. \u00a0In the below code this is done as a simple string but it could just as easily be a your own Java object.<\/p>\n package com.acmesoft;\r\n\r\nimport java.net.URI;\r\nimport java.net.URISyntaxException;\r\n\r\nimport javax.ws.rs.Consumes;\r\nimport javax.ws.rs.GET;\r\nimport javax.ws.rs.POST;\r\nimport javax.ws.rs.Path;\r\nimport javax.ws.rs.PathParam;\r\nimport javax.ws.rs.Produces;\r\nimport javax.ws.rs.core.Context;\r\nimport javax.ws.rs.core.MediaType;\r\nimport javax.ws.rs.core.Response;\r\nimport javax.ws.rs.core.UriInfo;\r\n\r\n@Path(\"\/Communicate\")\r\npublic class HelloWorldEx {\r\n\r\n\t\/* \r\n\t * http:\/\/192.168.178.70:8080\/SecondRestful\/Communicate\/mag\r\n\t *\/\t@GET\r\n\t@Path(\"\/mag\")\r\n\t@Produces( {MediaType.APPLICATION_XML})\r\n\tpublic Response sayHelloXml(@Context UriInfo ui) throws URISyntaxException\r\n\t{\r\n\t\tString retval = \"\" +\r\n\t\t\t\t\"2016\" +\r\n\t\t\t\t\"6\" +\r\n\t\t\t\t\"Economist\" +\r\n\t\t\t\t\"9.99\" +\r\n\t\t\t\t\"\";\r\n\t\tString path = ui.getAbsolutePath().toString() ;\r\n\t\tURI uri = new URI(path);\r\n\r\n\t\treturn Response.created(uri).contentLocation(uri).status(Response.Status.OK).entity(retval).build();\r\n\t}\r\n\r\n\t\/* \r\n\t * http:\/\/192.168.178.70:8080\/SecondRestful\/Communicate\/mag\r\n\t *\/\r\n\t@GET\r\n\t@Path(\"\/mag\")\r\n\t@Produces( {MediaType.APPLICATION_JSON})\r\n\tpublic Response sayHelloJSON(@Context UriInfo ui) throws URISyntaxException\r\n\t{\r\n\t\tString retval = \"{ \\\"magazine\\\": {\\\"year\\\":2016,\\\"month\\\":6,\\\"title\\\":\\\"Economist\\\",\\\"price\\\":9.99} }\";\r\n\t\t\r\n\t\tString path = ui.getAbsolutePath().toString() ;\r\n\t\tURI uri = new URI(path);\r\n\r\n\t\treturn Response.created(uri).contentLocation(uri).status(Response.Status.OK).entity(retval).build();\r\n\t}\r\n\r\n\t\/* \r\n\t * http:\/\/192.168.178.70:8080\/SecondRestful\/Communicate\/oucha_bunga\r\n\t *\/\r\n\t@Path(\"{c}\")\r\n\t@GET\r\n\t@Produces( {MediaType.APPLICATION_XML})\r\n\tpublic Response complexURI(@Context UriInfo ui, @PathParam(\"c\") String msg) throws URISyntaxException\r\n\t{\r\n\t\tString mymsg = \"Thinkin about \" + msg;\r\n\t\tString xmlStr = \"\" + mymsg + \"\";\r\n\r\n\t\t\/\/ this is a really clever way to get the URI but\r\n\t\t\/\/ if you pass in a string, it will throw an error.\r\n\t\t\/\/ and it all comes down to the URI that is added to the\r\n\t\t\/\/ response object (below)\r\n\t\tString path = ui.getAbsolutePath().toString() ;\r\n\t\tURI uri = new URI(path);\r\n\r\n\t\treturn Response.created(uri).contentLocation(uri).status(Response.Status.OK).entity(xmlStr).build();\r\n\t}\r\n}\r\n<\/pre>\n |