public class HalConfiguration extends Object
Modifier and Type | Class and Description |
---|---|
static class |
HalConfiguration.RenderSingleLinks
Configuration option how to render single links of a given
LinkRelation . |
Constructor and Description |
---|
HalConfiguration()
Creates a new default
HalConfiguration rendering single links as immediate sub-document. |
Modifier and Type | Method and Description |
---|---|
HalConfiguration |
customize(com.fasterxml.jackson.databind.ObjectMapper mapper) |
HalConfiguration.RenderSingleLinks |
getRenderSingleLinks() |
boolean |
isApplyPropertyNamingStrategy() |
boolean |
isEnforceEmbeddedCollections() |
HalConfiguration |
withApplyPropertyNamingStrategy(boolean applyPropertyNamingStrategy)
Create a new
HalConfiguration by copying the attributes and replacing the
applyProperNamingStrategy. |
HalConfiguration |
withEnforceEmbeddedCollections(boolean enforceEmbeddedCollections)
Create a new
HalConfiguration by copying the attributes and replacing the
enforceEmbeddedCollections. |
HalConfiguration |
withMediaType(MediaType mediaType)
Registers additional media types that are supposed to be aliases to
MediaTypes.HAL_JSON . |
HalConfiguration |
withObjectMapperCustomizer(Consumer<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer)
Configures an
ObjectMapper customizer to tweak the instance after it has been pre-configured with all HAL
specific setup. |
HalConfiguration |
withRenderSingleLinks(HalConfiguration.RenderSingleLinks renderSingleLinks)
Create a new
HalConfiguration by copying the attributes and replacing the renderSingleLinks. |
HalConfiguration |
withRenderSingleLinksFor(LinkRelation relation,
HalConfiguration.RenderSingleLinks renderSingleLinks)
Configures how to render a single link for a given particular
LinkRelation . |
HalConfiguration |
withRenderSingleLinksFor(String pattern,
HalConfiguration.RenderSingleLinks renderSingleLinks)
Configures how to render a single link for the given link relation pattern, i.e. this can be either a fixed link
relation (like
search ), take wildcards to e.g. match links of a given curie (like acme:* ) or even
complete URIs (like https://api.acme.com/foo/** ). |
public HalConfiguration()
HalConfiguration
rendering single links as immediate sub-document.public HalConfiguration withRenderSingleLinksFor(LinkRelation relation, HalConfiguration.RenderSingleLinks renderSingleLinks)
LinkRelation
. This will override what has
been configured via withRenderSingleLinks(RenderSingleLinks)
for that particular link relation.relation
- must not be null.renderSingleLinks
- must not be null.public HalConfiguration withRenderSingleLinksFor(String pattern, HalConfiguration.RenderSingleLinks renderSingleLinks)
search
), take wildcards to e.g. match links of a given curie (like acme:*
) or even
complete URIs (like https://api.acme.com/foo/**
).pattern
- must not be null or empty.renderSingleLinks
- must not be null.public HalConfiguration withRenderSingleLinks(HalConfiguration.RenderSingleLinks renderSingleLinks)
HalConfiguration
by copying the attributes and replacing the renderSingleLinks.renderSingleLinks
- must not be null.public HalConfiguration withApplyPropertyNamingStrategy(boolean applyPropertyNamingStrategy)
HalConfiguration
by copying the attributes and replacing the
applyProperNamingStrategy.applyPropertyNamingStrategy
- public HalConfiguration withEnforceEmbeddedCollections(boolean enforceEmbeddedCollections)
HalConfiguration
by copying the attributes and replacing the
enforceEmbeddedCollections.enforceEmbeddedCollections
- public HalConfiguration withObjectMapperCustomizer(Consumer<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer)
ObjectMapper
customizer to tweak the instance after it has been pre-configured with all HAL
specific setup.objectMapperCustomizer
- must not be null.public HalConfiguration withMediaType(MediaType mediaType)
MediaTypes.HAL_JSON
. Registered
MediaType
s will be preferred over the default one, i.e. they'll be listed first in client's accept headers
etc.mediaType
- must not be null.public HalConfiguration.RenderSingleLinks getRenderSingleLinks()
public boolean isApplyPropertyNamingStrategy()
public boolean isEnforceEmbeddedCollections()
public HalConfiguration customize(com.fasterxml.jackson.databind.ObjectMapper mapper)
Copyright © 2011–2021 Pivotal, Inc.. All rights reserved.