org.alfasoftware.soapstone

Class SoapstoneService

java.lang.Object

org.alfasoftware.soapstone.SoapstoneService

@Path(value="")
public class SoapstoneService
extends java.lang.Object

Service to map incoming JSON HTTP requests to provided web service implementations

Author:

Copyright (c) Alfa Financial Software 2019

Method Summary

Modifier and Type	Method and Description
java.lang.String	delete(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, java.lang.String entity) Maps incoming JSON HTTP DELETE requests to web service implementations and executes the relevant method.
java.lang.String	get(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Maps incoming JSON HTTP GET requests to web service implementations and executes the relevant method.
java.lang.String	getOpenApiJson(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request, java.util.Set<java.lang.String> tags) Get an Open API document including all provided tags in JSON format.
java.util.Set<java.lang.String>	getOpenApiTags() Enumerate all tags available for inclusion in Open API documents
java.lang.String	getOpenApiYaml(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request, java.util.Set<java.lang.String> tags) Get an Open API document including all provided tags in YAML format.
java.lang.String	post(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, java.lang.String entity) Maps incoming JSON HTTP POST requests to web service implementations and executes the relevant method.
java.lang.String	put(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, java.lang.String entity) Maps incoming JSON HTTP PUT requests to web service implementations and executes the relevant method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

post

@POST
 @Path(value="/{s:.*}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public java.lang.String post(@Context
                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                     @Context
                                                                                                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                     java.lang.String entity)

Maps incoming JSON HTTP POST requests to web service implementations and executes the relevant method.

Parameters:

headers - The HTTP header information

uriInfo - The application and request URI information

entity - The entity to be parsed as a JSON object

Returns:

JSON representation of the underlying web service response

get

@GET
 @Path(value="/{s:.*}")
 @Produces(value="application/json")
public java.lang.String get(@Context
                                                                                              javax.ws.rs.core.HttpHeaders headers,
                                                                                              @Context
                                                                                              javax.ws.rs.core.UriInfo uriInfo)

Maps incoming JSON HTTP GET requests to web service implementations and executes the relevant method.

Parameters:

headers - The HTTP header information

uriInfo - The application and request URI information

Returns:

JSON representation of the underlying web service response

put

@PUT
 @Path(value="/{s:.*}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public java.lang.String put(@Context
                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                   @Context
                                                                                                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                   java.lang.String entity)

Maps incoming JSON HTTP PUT requests to web service implementations and executes the relevant method.

Parameters:

headers - The HTTP header information

uriInfo - The application and request URI information

entity - The entity to be parsed as a JSON object

Returns:

JSON representation of the underlying web service response

delete

@DELETE
 @Path(value="/{s:.*}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public java.lang.String delete(@Context
                                                                                                                                         javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                         @Context
                                                                                                                                         javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                         java.lang.String entity)

Maps incoming JSON HTTP DELETE requests to web service implementations and executes the relevant method.

Parameters:

headers - The HTTP header information

uriInfo - The application and request URI information

entity - The entity to be parsed as a JSON object

Returns:

JSON representation of the underlying web service response

getOpenApiTags

@GET
 @Path(value="openapi/tags")
 @Produces(value="application/json")
public java.util.Set<java.lang.String> getOpenApiTags()

Enumerate all tags available for inclusion in Open API documents

Returns:

set of tags

getOpenApiJson

@GET
 @Path(value="openapi.json")
 @Produces(value="application/json")
public java.lang.String getOpenApiJson(@Context
                                                                                                              javax.ws.rs.core.UriInfo uriInfo,
                                                                                                              @Context
                                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                                              @QueryParam(value="tag")
                                                                                                              java.util.Set<java.lang.String> tags)

Get an Open API document including all provided tags in JSON format.

If no tags are specified then all tags will be included.

Parameters:

uriInfo - The application and request URI information

request - The http servlet request (includes the hostname actually used for the request)

tags - set of tags to include in the document. If none provided then all tags will be used.

Returns:

Open API document as JSON

getOpenApiYaml

@GET
 @Path(value="openapi.yaml")
 @Produces(value="text/vnd.yaml")
public java.lang.String getOpenApiYaml(@Context
                                                                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                                                                           @Context
                                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                                           @QueryParam(value="tag")
                                                                                                           java.util.Set<java.lang.String> tags)

Get an Open API document including all provided tags in YAML format.

If no tags are specified then all tags will be included.

Parameters:

uriInfo - The application and request URI information

request - The http servlet request (includes the hostname actually used for the request)

tags - set of tags to include in the document. If none provided then all tags will be used.

Returns:

Open API document as YAML