gCube eXtensions to REST
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Luca Frosini b4bbaf8816 Fixed gcube-bom version 5 months ago
.idea Add CHANGELOG, README and LICENSE files to each module (as requested by the maven-parent). 1 year ago
.settings Aligning pom artifactId to svn location 3 years ago
gxHTTP Fixed versions for release 5 months ago
gxJRS Fixed gcube-bom version 5 months ago
idea/.idea Add REAME.md 3 years ago
.classpath Aligning pom artifactId to svn location 3 years ago
.gitignore Add target to gitignore. 3 years ago
.project Aligning pom artifactId to eclipse project name 3 years ago
CHANGELOG.md Removed -SNAPSHOT for release 5 months ago
LICENSE.md Add CHANGELOG, README and LICENSE files to each module (as requested by the maven-parent). 1 year ago
README.md Switched JSON Management to gcube-jackson 1 year ago
pom.xml Fixed gcube-bom version 5 months ago

README.md

gxREST

The gCube eXtensions to the Rest Protocol (gxRest) is a set of Java libraries designed to provide convenient round-trip interaction between a Restful web application (also known as "service") and its clients.

gxRest has the flexibility for different degrees of exploitation:

  • it can be entirely adopted both at client and service side with full benefit of its conventions;
  • it can be used to send REST requests based only on plain HTTP;
  • it can be used only to return HTTP code/messagess from the service;
  • it can be used only to throw Exceptions from the service to the client.

Examples of use

Sending a request:

GXHTTPRequest request = GXHTTPRequest.newRequest("http://host:port/service/").from("GXRequestTest");
 
//prepare some parameters
String context ="...";
Map<String,String> queryParams = new WeakHashMap<>();
queryParams.put("param name", "param value");
GXInboundResponse response = request.path("context")
	  .queryParams(queryParams).withBody(context).post();

Returning a success response:

 @POST
  public Response create(...) {
 
    //Resource successfully created 
    
    URI location = ... //URI of the new resource
    return GXOutboundSuccessResponse.newCREATEResponse(location)
              .withMessage("Resource successfully created.")
	      .ofType(MediaType.APPLICATION_JSON)
              .build();
  }

Throwing an exception:

@POST
  public Response create(...) {
 
    //Oh no, something failed here
    GXOutboundErrorResponse.throwException(new MyCustomException("Resource already exists."));
    
  }   

Parsing a response

// invoke the remote method and get a response.
GXInboundResponse response = ...;
if (response.hasException()) 
    throw response.getException();
//assuming a created (200) code was expected 
if (response.hasCREATEDCode()) {
		System.out.println("Resource successfully created!");
}
//access content as string
String value = response.getStreamedContentAsString();
//unmasharll content as json
Context returnedContext = response.tryConvertStreamedContentFromJson(Context.class);

Modules

Deployment

Notes about how to deploy this component on an infrastructure or link to wiki doc (if any).

Documentation

See gxRest on Wiki.

Built With

  • JAX-RS - Java™ API for RESTful Web Services
  • Jersey - JAX-RS runtime
  • Maven - Dependency Management

License

TBP