org.alfasoftware.soapstone

Class SoapstoneServiceBuilder

java.lang.Object

org.alfasoftware.soapstone.SoapstoneServiceBuilder

public class SoapstoneServiceBuilder
extends java.lang.Object

Builder for the SoapstoneService

This requires a map of URL paths to WebServiceClass. Optionally it can also be provided with an ExceptionMapper to map exceptions to WebApplicationException and a vendor name, for use in custom headers.

Author:

Copyright (c) Alfa Financial Software 2019

Constructor Summary

Constructors

Constructor and Description
SoapstoneServiceBuilder(java.util.Map<java.lang.String,WebServiceClass<?>> pathToWebServiceClassMap) Constructor

Method Summary

Modifier and Type	Method and Description
SoapstoneService	build() Builds the SoapstoneService.
SoapstoneServiceBuilder	withDocumentationProvider(DocumentationProvider documentationProvider) Provide a DocumentationProvider for extracting documentation for use in Open API documents
SoapstoneServiceBuilder	withExceptionMapper(ExceptionMapper exceptionMapper) Provide an ExceptionMapper to map exceptions caught during operation invocation to WebApplicationException
SoapstoneServiceBuilder	withObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Provide an ObjectMapper for mapping java objects to JSON and vice versa
SoapstoneServiceBuilder	withSupportedDeleteOperations(java.lang.String... regex) Provide a list of regular expressions for operation names which should be supported as DELETE methods
SoapstoneServiceBuilder	withSupportedGetOperations(java.lang.String... regex) Provide a list of regular expressions for operation names which should be supported as GET methods
SoapstoneServiceBuilder	withSupportedPutOperations(java.lang.String... regex) Provide a list of regular expressions for operation names which should be supported as PUT methods
SoapstoneServiceBuilder	withTagProvider(java.util.function.Function<java.lang.String,java.lang.String> tagProvider) Provide a function for assigning tags to web service operations based on path.
SoapstoneServiceBuilder	withTypeNameProvider(java.util.function.Function<java.lang.Class<?>,java.lang.String> typeNameProvider) Provide a function for assigning display names to types when generating schemas in Open API documents.
SoapstoneServiceBuilder	withVendor(java.lang.String vendor) Provide a vendor name

Methods inherited from class java.lang.Object

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

Constructor Detail

SoapstoneServiceBuilder

public SoapstoneServiceBuilder(java.util.Map<java.lang.String,WebServiceClass<?>> pathToWebServiceClassMap)

Constructor

Requires a map of URL paths to WebServiceClass. See WebServiceClass.forClass(Class, Supplier).

Parameters:

pathToWebServiceClassMap - map of paths to web service classes

Method Detail

withObjectMapper

public SoapstoneServiceBuilder withObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

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

This is optional. If not specified then a default mapper will be used which registers the com.fasterxml.jackson.module.jaxb.JaxbAnnotationModule and sets DeserializationFeature.FAIL_ON_IGNORED_PROPERTIES to false.

Parameters:

objectMapper - provided mapper

Returns:

this

withExceptionMapper

public SoapstoneServiceBuilder withExceptionMapper(ExceptionMapper exceptionMapper)

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

This is optional. If not specified then all invocation errors will be mapped to internal server errors (HTTP code 500).

Parameters:

exceptionMapper - provided mapper

Returns:

this

withVendor

public SoapstoneServiceBuilder withVendor(java.lang.String vendor)

Provide a vendor name

This will be used wherever the vendor would, by convention be used, e.g. for custom headers:

X-Vendor-Header

This is optional and will default to 'Soapstone'.

Parameters:

vendor - vendor name

Returns:

this

withSupportedGetOperations

public SoapstoneServiceBuilder withSupportedGetOperations(java.lang.String... regex)

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

Optional. All expressions will be treated as case-insensitive.

Parameters:

regex - regular expressions for matching operation names

Returns:

this

withSupportedDeleteOperations

public SoapstoneServiceBuilder withSupportedDeleteOperations(java.lang.String... regex)

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

Optional. All expressions will be treated as case-insensitive.

Parameters:

regex - regular expressions for matching operation names

Returns:

this

withSupportedPutOperations

public SoapstoneServiceBuilder withSupportedPutOperations(java.lang.String... regex)

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

Optional. All expressions will be treated as case-insensitive.

Parameters:

regex - regular expressions for matching operation names

Returns:

this

withDocumentationProvider

public SoapstoneServiceBuilder withDocumentationProvider(DocumentationProvider documentationProvider)

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

Use the DocumentationProviderBuilder to construct the provider.

This is optional. If not provided, no documentation will be added to Open API documents produced.

Parameters:

documentationProvider - documentation provider

Returns:

this

withTagProvider

public SoapstoneServiceBuilder withTagProvider(java.util.function.Function<java.lang.String,java.lang.String> tagProvider)

Provide a function for assigning tags to web service operations based on path. Tags are used to group operations when represented in Open API documents

The function should accept the path to a web service class (as provided in SoapstoneServiceBuilder(Map)) and return a tag as a string.

This is optional. If not provided, no tags will be added to Open API documents produced.

Parameters:

tagProvider - tag provider

Returns:

this

withTypeNameProvider

public SoapstoneServiceBuilder withTypeNameProvider(java.util.function.Function<java.lang.Class<?>,java.lang.String> typeNameProvider)

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

The default behaviour is to use the simple class name, which may result in clashes. Since the names are used as keys to identify the corresponding schemas, this in turn results in incorrect schemas being displayed. The names impact display only so it is safe to provide a custom name.

Parameters:

typeNameProvider - type name provider

Returns:

this

build

public SoapstoneService build()

Builds the SoapstoneService.

Returns:

a SoapstoneService with the appropriate fields set