LdifAnonymizer

java.lang.Object
- org.apache.directory.ldap.client.api.LdifAnonymizer

```
public class LdifAnonymizer
extends java.lang.Object
```
Anonymize the content of a LDIF file. We will replace the values of the defined attributes with random chars. There are a default list of attributes that are going to be anonymized :
- userPassword
- displayName
- givenName
- surName
- homePhone
- homePostalAddress
- jpegPhoto
- labeledURI
- mail
- manager
- mobile
- organizationName
- pager
- photo
- secretary
- uid
- userCertificate
- userPKCS12
- userSMIMECertificate
- x500UniqueIdentifier
- carLicense
- host
- locality
- organizationName
- organizationalUnitName
- seelAlso
- homeDirectory
- uidNumber
- gidNumber
- commonName
- gecos
- description
- memberUid

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<java.lang.String,Anonymizer>`	`attributeAnonymizers` The map of AttributeType'sOID we want to anonymize.
`private java.util.Set<Dn>`	`namingContexts` The list of existing NamingContexts
`private java.io.PrintStream`	`out` The PrintStream used to write informations about the processing
`private SchemaManager`	`schemaManager` The schemaManager
`private java.util.Map<Value<?>,Value<?>>`	`valueMap` The map that stores the anonymized values associated to the original value

Constructor Summary

Constructors
Constructor and Description
`LdifAnonymizer()` Creates a default instance of LdifAnonymizer.
`LdifAnonymizer(SchemaManager schemaManager)` Creates a default instance of LdifAnonymizer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnonAttributeType(AttributeType attributeType)` Add an attributeType that has to be anonymized
`void`	`addAnonAttributeType(AttributeType attributeType, Anonymizer<?> anonymizer)` Add an attributeType that has to be anonymized, with its associated anonymizer.
`void`	`addNamingContext(java.lang.String dn)` Add a new NamingContext
`java.lang.String`	`anonymize(java.lang.String ldif)` Anonymize a LDIF
`private Ava`	`anonymizeAva(Ava ava)` Anonymize an AVA
`private LdifEntry`	`anonymizeChangeAdd(LdifEntry ldifEntry)` Anonymize a Add change
`private LdifEntry`	`anonymizeChangeDelete(LdifEntry ldifEntry)` Anonymize a Delete change
`private LdifEntry`	`anonymizeChangeModDn(LdifEntry ldifEntry)` Anonymize a Delete change
`private LdifEntry`	`anonymizeChangeModify(LdifEntry ldifEntry)` Anonymize a Modify change
`private Dn`	`anonymizeDn(Dn entryDn)` Anonymize the entry's DN
`private Entry`	`anonymizeEntry(LdifEntry ldifEntry)` Anonymize the full entry
`void`	`anonymizeFile(java.lang.String ldifFile, java.io.Writer writer)` Anonymize a LDIF
`java.util.Map<java.lang.String,Anonymizer>`	`getAttributeAnonymizers()`
`java.util.Map<Value<?>,Value<?>>`	`getValueMap()`
`private void`	`init()` Initialize the anonymizer, filling the maps we use.
`static void`	`main(java.lang.String[] args)` The entry point, when used as a standalone application.
`private void`	`print(java.lang.String str)` Print the string into the PrintStream
`private void`	`println()` Print a nl into the PrintStream
`private void`	`println(java.lang.String str)` Print the string into the PrintStream, with a NL at the end
`void`	`removeAnonAttributeType(AttributeType attributeType)` Remove an attributeType that has to be anonymized
`void`	`setOut(java.io.PrintStream out)` Set the PrintStream to use to print information about the processing
`void`	`setValueMap(java.util.Map<Value<?>,Value<?>> valueMap)`

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

- Field Detail
  - valueMap
```
private java.util.Map<Value<?>,Value<?>> valueMap
```
    The map that stores the anonymized values associated to the original value
  - attributeAnonymizers
```
private java.util.Map<java.lang.String,Anonymizer> attributeAnonymizers
```
    The map of AttributeType'sOID we want to anonymize. They are all associated with anonymizers
  - namingContexts
```
private java.util.Set<Dn> namingContexts
```
    The list of existing NamingContexts
  - schemaManager
```
private SchemaManager schemaManager
```
    The schemaManager
  - out
```
private java.io.PrintStream out
```
    The PrintStream used to write informations about the processing
- Constructor Detail
  - LdifAnonymizer
```
public LdifAnonymizer()
```
    Creates a default instance of LdifAnonymizer. The list of anonymized attribute is set to a default value.
  - LdifAnonymizer
```
public LdifAnonymizer(SchemaManager schemaManager)
```
    Creates a default instance of LdifAnonymizer. The list of anonymized attribute is set to a default value.
    
    Parameters:
    
    schemaManager - The SchemaManager instance we will use
- Method Detail
  - setOut
```
public void setOut(java.io.PrintStream out)
```
    Set the PrintStream to use to print information about the processing
    
    Parameters:
    
    out - The PrintStream to use
  - print
```
private void print(java.lang.String str)
```
    Print the string into the PrintStream
  - println
```
private void println(java.lang.String str)
```
    Print the string into the PrintStream, with a NL at the end
  - println
```
private void println()
```
    Print a nl into the PrintStream
  - init
```
private void init()
```
    Initialize the anonymizer, filling the maps we use.
  - addAnonAttributeType
```
public void addAnonAttributeType(AttributeType attributeType)
                          throws LdapException
```
    Add an attributeType that has to be anonymized
    
    Parameters:
    
    attributeType - the AttributeType that has to be anonymized
    
    Throws:
    
    LdapException - If the attributeType cannot be added
  - addAnonAttributeType
```
public void addAnonAttributeType(AttributeType attributeType,
                                 Anonymizer<?> anonymizer)
                          throws LdapException
```
    Add an attributeType that has to be anonymized, with its associated anonymizer.
    
    Parameters:
    
    attributeType - the AttributeType that has to be anonymized
    
    anonymizer - the instance of anonymizer to use with this AttributeType
    
    Throws:
    
    LdapException - If the attributeType cannot be added
  - removeAnonAttributeType
```
public void removeAnonAttributeType(AttributeType attributeType)
                             throws LdapException
```
    Remove an attributeType that has to be anonymized
    
    Parameters:
    
    attributeType - the AttributeType that we don't want to be anonymized
    
    Throws:
    
    LdapException - If the attributeType cannot be removed
  - getAttributeAnonymizers
```
public java.util.Map<java.lang.String,Anonymizer> getAttributeAnonymizers()
```
    Returns:
    
    The list of configured anonymizers
  - addNamingContext
```
public void addNamingContext(java.lang.String dn)
                      throws LdapInvalidDnException
```
    Add a new NamingContext
    
    Parameters:
    
    dn - The naming context to add
    
    Throws:
    
    LdapInvalidDnException - if it's an invalid naming context
  - anonymizeAva
```
private Ava anonymizeAva(Ava ava)
                  throws LdapInvalidDnException,
                         LdapInvalidAttributeValueException
```
    Anonymize an AVA
    
    Throws:
    
    LdapInvalidDnException
    
    LdapInvalidAttributeValueException
  - anonymizeDn
```
private Dn anonymizeDn(Dn entryDn)
                throws LdapException
```
    Anonymize the entry's DN
    
    Throws:
    
    LdapException
  - anonymizeFile
```
public void anonymizeFile(java.lang.String ldifFile,
                          java.io.Writer writer)
                   throws LdapException,
                          java.io.IOException
```
    Anonymize a LDIF
    
    Parameters:
    
    ldif - The ldif content to anonymize
    
    Throws:
    
    LdapException - If we got some LDAP related exception
    
    java.io.IOException - If we had some issue during some IO operations
  - anonymizeChangeModify
```
private LdifEntry anonymizeChangeModify(LdifEntry ldifEntry)
                                 throws LdapException
```
    Anonymize a Modify change
    
    Throws:
    
    LdapException
  - anonymizeChangeAdd
```
private LdifEntry anonymizeChangeAdd(LdifEntry ldifEntry)
                              throws LdapException
```
    Anonymize a Add change
    
    Throws:
    
    LdapException
  - anonymizeChangeDelete
```
private LdifEntry anonymizeChangeDelete(LdifEntry ldifEntry)
                                 throws LdapException
```
    Anonymize a Delete change
    
    Throws:
    
    LdapException
  - anonymizeChangeModDn
```
private LdifEntry anonymizeChangeModDn(LdifEntry ldifEntry)
                                throws LdapException
```
    Anonymize a Delete change
    
    Throws:
    
    LdapException
  - anonymizeEntry
```
private Entry anonymizeEntry(LdifEntry ldifEntry)
                      throws LdapException
```
    Anonymize the full entry
    
    Throws:
    
    LdapException
  - anonymize
```
public java.lang.String anonymize(java.lang.String ldif)
                           throws LdapException,
                                  java.io.IOException
```
    Anonymize a LDIF
    
    Parameters:
    
    ldif - The ldif content to anonymize
    
    Returns:
    
    an anonymized version of the given ldif
    
    Throws:
    
    LdapException - If we got some LDAP related exception
    
    java.io.IOException - If we had some issue during some IO operations
  - getValueMap
```
public java.util.Map<Value<?>,Value<?>> getValueMap()
```
    Returns:
    
    the valueMap
  - setValueMap
```
public void setValueMap(java.util.Map<Value<?>,Value<?>> valueMap)
```
    Parameters:
    
    valueMap - the valueMap to set
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        LdapException
```
    The entry point, when used as a standalone application.
    
    Parameters:
    
    args - Contains the arguments : the file to convert. The anonymized LDIF will be printed on stdout
    
    Throws:
    
    java.io.IOException
    
    LdapException

Class LdifAnonymizer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

valueMap

attributeAnonymizers

namingContexts

schemaManager

out

Constructor Detail

LdifAnonymizer

LdifAnonymizer

Method Detail

setOut

print

println

println

init

addAnonAttributeType

addAnonAttributeType

removeAnonAttributeType

getAttributeAnonymizers

addNamingContext

anonymizeAva

anonymizeDn

anonymizeFile

anonymizeChangeModify

anonymizeChangeAdd

anonymizeChangeDelete

anonymizeChangeModDn

anonymizeEntry

anonymize

getValueMap

setValueMap

main