B D E F G M O P S W

B

build() - Method in class org.alfasoftware.soapstone.DocumentationProviderBuilder

Build the DocumentationProvider

build() - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Builds the SoapstoneService.

D

delete(HttpHeaders, UriInfo, String) - Method in class org.alfasoftware.soapstone.SoapstoneService

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

DocumentationProvider - Class in org.alfasoftware.soapstone

Documentation provider for web service classes

DocumentationProviderBuilder - Class in org.alfasoftware.soapstone

Builder for DocumentationProvider

DocumentationProviderBuilder() - Constructor for class org.alfasoftware.soapstone.DocumentationProviderBuilder

E

ExceptionMapper - Interface in org.alfasoftware.soapstone

Mapper for converting throwables caught during the invocation of web service operation methods into instances of WebApplicationException which will be returned from the JSON HTTP service.

F

forClass(Class<U>, Supplier<U>) - Static method in class org.alfasoftware.soapstone.WebServiceClass

Create a new WebServiceClass for a class representing a web service endpoint

G

get(HttpHeaders, UriInfo) - Method in class org.alfasoftware.soapstone.SoapstoneService

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

getOpenApiJson(UriInfo, HttpServletRequest, Set<String>) - Method in class org.alfasoftware.soapstone.SoapstoneService

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

getOpenApiTags() - Method in class org.alfasoftware.soapstone.SoapstoneService

Enumerate all tags available for inclusion in Open API documents

getOpenApiYaml(UriInfo, HttpServletRequest, Set<String>) - Method in class org.alfasoftware.soapstone.SoapstoneService

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

M

mapThrowable(Throwable, ObjectMapper) - Method in interface org.alfasoftware.soapstone.ExceptionMapper

Map an exception to a WebApplicationException.

O

org.alfasoftware.soapstone - package org.alfasoftware.soapstone

P

post(HttpHeaders, UriInfo, String) - Method in class org.alfasoftware.soapstone.SoapstoneService

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

put(HttpHeaders, UriInfo, String) - Method in class org.alfasoftware.soapstone.SoapstoneService

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

S

SoapstoneService - Class in org.alfasoftware.soapstone

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

SoapstoneServiceBuilder - Class in org.alfasoftware.soapstone

Builder for the SoapstoneService

SoapstoneServiceBuilder(Map<String, WebServiceClass<?>>) - Constructor for class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Constructor

W

WebServiceClass<T> - Class in org.alfasoftware.soapstone

A wrapper around a class representing a web service endpoint

withClassDocumentationProvider(Function<Class<?>, Optional<String>>) - Method in class org.alfasoftware.soapstone.DocumentationProviderBuilder

Deprecated.

Use DocumentationProviderBuilder.withModelDocumentationProvider(Function) to provide documentation for models and members

withDocumentationProvider(DocumentationProvider) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide a DocumentationProvider for extracting documentation for use in Open API documents

withExceptionMapper(ExceptionMapper) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide an ExceptionMapper to map exceptions caught during operation invocation to WebApplicationException

withMemberDocumentationProvider(Function<AnnotatedMember, Optional<String>>) - Method in class org.alfasoftware.soapstone.DocumentationProviderBuilder

Deprecated.

Use DocumentationProviderBuilder.withModelDocumentationProvider(Function) to provide documentation for models and members

withMethodDocumentationProvider(Function<Method, Optional<String>>) - Method in class org.alfasoftware.soapstone.DocumentationProviderBuilder

Optional.

withMethodReturnDocumentationProvider(Function<Method, Optional<String>>) - Method in class org.alfasoftware.soapstone.DocumentationProviderBuilder

Optional.

withModelDocumentationProvider(Function<Collection<Annotation>, Optional<String>>) - Method in class org.alfasoftware.soapstone.DocumentationProviderBuilder

Optional.

withObjectMapper(ObjectMapper) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide an ObjectMapper for mapping java objects to JSON and vice versa

withParameterDocumentationProvider(Function<Parameter, Optional<String>>) - Method in class org.alfasoftware.soapstone.DocumentationProviderBuilder

Optional.

withSupportedDeleteOperations(String...) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide a list of regular expressions for operation names which should be supported as DELETE methods

withSupportedGetOperations(String...) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide a list of regular expressions for operation names which should be supported as GET methods

withSupportedPutOperations(String...) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide a list of regular expressions for operation names which should be supported as PUT methods

withTagProvider(Function<String, String>) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide a function for assigning tags to web service operations based on path.

withTypeNameProvider(Function<Class<?>, String>) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide a function for assigning display names to types when generating schemas in Open API documents.

withVendor(String) - Method in class org.alfasoftware.soapstone.SoapstoneServiceBuilder

Provide a vendor name

B D E F G M O P S W