Class MappingVaultConverter

java.lang.Object

org.springframework.vault.repository.convert.AbstractVaultConverter

org.springframework.vault.repository.convert.MappingVaultConverter

All Implemented Interfaces:

InitializingBean, EntityConverter<VaultPersistentEntity<?>, VaultPersistentProperty, Object, SecretDocument>, EntityReader<Object, SecretDocument>, EntityWriter<Object, SecretDocument>, VaultConverter

public class MappingVaultConverter
extends AbstractVaultConverter

VaultConverter that uses a MappingContext to do sophisticated mapping of domain objects to SecretDocument. This converter converts between Map-typed representations and domain objects without use of a JSON library. SecretDocument is the input to JSON mapping to exchange secrets with Vault.

Since:

2.0

Author:

Mark Paluch

Field Summary

Fields inherited from class AbstractVaultConverter

conversions, conversionService, instantiators

Constructor Summary

Constructors

Constructor	Description
MappingVaultConverter(MappingContext<? extends VaultPersistentEntity<?>, VaultPersistentProperty> mappingContext)

Method Summary

Modifier and Type	Method	Description
protected void	addCustomTypeKeyIfNecessary(@Nullable TypeInformation<?> type, Object value, SecretDocumentAccessor accessor)	Adds custom type information to the given SecretDocument if necessary.
protected List<Object>	createCollection(Collection<?> collection, VaultPersistentProperty property)	Writes the given Collection using the given VaultPersistentProperty information.
protected Map<String,Object>	createMap(Map<Object,Object> map, VaultPersistentProperty property)	Writes the given Map using the given VaultPersistentProperty information.
MappingContext<? extends VaultPersistentEntity<?>, VaultPersistentProperty>	getMappingContext()
<S> S	read(Class<S> type, SecretDocument source)
protected Map<@Nullable Object, @Nullable Object>	readMap(TypeInformation<?> type, Map<String,Object> sourceMap)	Reads the given Map into a Map. will recursively resolve nested Maps as well.
void	setTypeMapper(VaultTypeMapper typeMapper)	Configures the VaultTypeMapper to be used to add type information to SecretDocuments created by the converter and how to lookup type information from SecretDocuments when reading them.
void	write(Object source, SecretDocument sink)
protected void	writeInternal(Object obj, SecretDocumentAccessor sink, @Nullable TypeInformation<?> typeHint)	Internal write conversion method which should be used for nested invocations.
protected void	writeInternal(Object obj, SecretDocumentAccessor sink, VaultPersistentEntity<?> entity)
protected Map<String,Object>	writeMapInternal(Map<Object,Object> obj, Map<String,Object> bson, TypeInformation<?> propertyType)	Writes the given Map to the given Map considering the given TypeInformation.
protected void	writePropertyInternal(@Nullable Object obj, SecretDocumentAccessor accessor, VaultPersistentProperty prop)

Methods inherited from class AbstractVaultConverter

afterPropertiesSet, getConversionService, setCustomConversions, setInstantiators

Methods inherited from class Object

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

Constructor Details

MappingVaultConverter

public MappingVaultConverter(MappingContext<? extends VaultPersistentEntity<?>, VaultPersistentProperty> mappingContext)

Method Details

setTypeMapper

public void setTypeMapper(VaultTypeMapper typeMapper)

Configures the VaultTypeMapper to be used to add type information to SecretDocuments created by the converter and how to lookup type information from SecretDocuments when reading them. Uses a DefaultVaultTypeMapper by default. Setting this to null will reset the TypeMapper to the default one.

Parameters:

typeMapper - the typeMapper to set, must not be null.

getMappingContext

public MappingContext<? extends VaultPersistentEntity<?>, VaultPersistentProperty> getMappingContext()

read

public <S> S read(Class<S> type,
 SecretDocument source)

readMap

protected Map<@Nullable Object, @Nullable Object> readMap(TypeInformation<?> type,
 Map<String,Object> sourceMap)

Reads the given Map into a Map. will recursively resolve nested Maps as well.

Parameters:

type - the Map TypeInformation to be used to unmarshal this Map.

sourceMap - must not be null

Returns:

the converted Map.

write

public void write(Object source,
 SecretDocument sink)

writeInternal

protected void writeInternal(Object obj,
 SecretDocumentAccessor sink,
 @Nullable TypeInformation<?> typeHint)

Internal write conversion method which should be used for nested invocations.

Parameters:

obj -

sink -

typeHint -

writeInternal

protected void writeInternal(Object obj,
 SecretDocumentAccessor sink,
 VaultPersistentEntity<?> entity)

writePropertyInternal

protected void writePropertyInternal(@Nullable Object obj,
 SecretDocumentAccessor accessor,
 VaultPersistentProperty prop)

createCollection

protected List<Object> createCollection(Collection<?> collection,
 VaultPersistentProperty property)

Writes the given Collection using the given VaultPersistentProperty information.

Parameters:

collection - must not be null.

property - must not be null.

Returns:

the converted List.

createMap

protected Map<String,Object> createMap(Map<Object,Object> map,
 VaultPersistentProperty property)

Writes the given Map using the given VaultPersistentProperty information.

Parameters:

map - must not null.

property - must not be null.

Returns:

the converted Map.

writeMapInternal

protected Map<String,Object> writeMapInternal(Map<Object,Object> obj,
 Map<String,Object> bson,
 TypeInformation<?> propertyType)

Writes the given Map to the given Map considering the given TypeInformation.

Parameters:

obj - must not be null.

bson - must not be null.

propertyType - must not be null.

Returns:

the converted Map.

addCustomTypeKeyIfNecessary

protected void addCustomTypeKeyIfNecessary(@Nullable TypeInformation<?> type,
 Object value,
 SecretDocumentAccessor accessor)

Adds custom type information to the given SecretDocument if necessary. That is if the value is not the same as the one given. This is usually the case if you store a subtype of the actual declared type of the property.

Parameters:

type - type hint.

value - must not be null.

accessor - must not be null.