Sanitizer (Spring Boot Docs 2.2.1.RELEASE API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.springframework.boot.actuate.endpoint.Sanitizer

```
public class Sanitizer
extends Object
```
Strategy that should be used by endpoint implementations to sanitize potentially sensitive keys.

Since:

2.0.0

Author:

Christian Dupuis, Toshiaki Maki, Phillip Webb, Nicolas Lejeune, Stephane Nicoll, HaiTao Zhang

Constructor Summary

Constructors
Constructor and Description

Sanitizer()

Sanitizer(String... keysToSanitize)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`sanitize(String key, Object value)` Sanitize the given value if necessary.
`void`	`setKeysToSanitize(String... keysToSanitize)` Keys that should be sanitized.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Sanitizer
```
public Sanitizer()
```
  - Sanitizer
```
public Sanitizer(String... keysToSanitize)
```
- Method Detail
  - setKeysToSanitize
```
public void setKeysToSanitize(String... keysToSanitize)
```
    Keys that should be sanitized. Keys can be simple strings that the property ends with or regular expressions.
    
    Parameters:
    
    keysToSanitize - the keys to sanitize
  - sanitize
```
public Object sanitize(String key,
                       Object value)
```
    Sanitize the given value if necessary.
    
    Parameters:
    
    key - the key to sanitize
    
    value - the value
    
    Returns:
    
    the potentially sanitized value

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2019 Pivotal Software, Inc.. All rights reserved.