RedactionPolicy
Leave feedback
On this page
Inheritance: java.lang.Object
public class RedactionPolicy
Represents a sanitization policy, containing a set of specific redactions to apply.
Learn more
- More details about policies: Use of redaction policies
- More details about applying redactions: Redaction basics
| Constructor | Description |
|---|---|
| RedactionPolicy() | Creates a new instance of Redaction policy. |
| RedactionPolicy(Redaction[] redactions) | Creates a new instance of Redaction policy with a specific list of redactions. |
| Method | Description |
|---|---|
| getRedactions() | Gets an array of fully configured Redaction -derived classes. |
| load(String filePath) | Loads an instance of RedactionPolicy from a file path. |
| load(InputStream input) | Loads an instance of RedactionPolicy from a stream. |
| save(String filePath) | Saves the redaction policy to a file. |
| save(OutputStream output) | Saves the redaction policy to a stream. |
public RedactionPolicy()
Creates a new instance of Redaction policy.
public RedactionPolicy(Redaction[] redactions)
Creates a new instance of Redaction policy with a specific list of redactions.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| redactions | Redaction[] | An array of redactions for the policy |
public final Redaction[] getRedactions()
Gets an array of fully configured Redaction -derived classes.
Returns: com.groupdocs.redaction.Redaction[] - An array of fully configured Redaction -derived classes.
public static RedactionPolicy load(String filePath)
Loads an instance of RedactionPolicy from a file path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| filePath | java.lang.String | Path to XML file |
Returns: RedactionPolicy - Redaction policy
public static RedactionPolicy load(InputStream input)
Loads an instance of RedactionPolicy from a stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| input | java.io.InputStream | Stream containing XML configuration |
Returns: RedactionPolicy - Redaction policy
public final void save(String filePath)
Saves the redaction policy to a file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| filePath | java.lang.String | Path to file. |
public final void save(OutputStream output)
Saves the redaction policy to a stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| output | java.io.OutputStream | Target stream to save the policy |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.