org.apache.directory.ldap.client.api

Class LdifAnonymizer

java.lang.Object

org.apache.directory.ldap.client.api.LdifAnonymizer

public class LdifAnonymizer
extends 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

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,org.apache.directory.api.ldap.model.ldif.anonymizer.Anonymizer>	attributeAnonymizers The map of AttributeType'sOID we want to anonymize.
private Map<Integer,byte[]>	latestBytesMap The latest anonymized byte[] value Map
private Map<Integer,String>	latestStringMap The latest anonymized String value Map
private Set<org.apache.directory.api.ldap.model.name.Dn>	namingContexts The list of existing NamingContexts
private PrintStream	out The PrintStream used to write informations about the processing
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The schemaManager
private Map<org.apache.directory.api.ldap.model.entry.Value<?>,org.apache.directory.api.ldap.model.entry.Value<?>>	valueMap The map that stores the anonymized values associated to the original value
private Set<org.apache.directory.api.ldap.model.entry.Value<?>>	valueSet The set that contains all the values we already have anonymized

Constructor Summary

Constructors

Constructor and Description
LdifAnonymizer() Creates a default instance of LdifAnonymizer.
LdifAnonymizer(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Creates a default instance of LdifAnonymizer.

Method Summary

Modifier and Type	Method and Description
void	addAnonAttributeType(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Add an attributeType that has to be anonymized
void	addAnonAttributeType(org.apache.directory.api.ldap.model.schema.AttributeType attributeType, org.apache.directory.api.ldap.model.ldif.anonymizer.Anonymizer<?> anonymizer) Add an attributeType that has to be anonymized, with its associated anonymizer.
void	addNamingContext(String dn) Add a new NamingContext
String	anonymize(String ldif) Anonymize a LDIF
private org.apache.directory.api.ldap.model.name.Ava	anonymizeAva(org.apache.directory.api.ldap.model.name.Ava ava) Anonymize an AVA
private org.apache.directory.api.ldap.model.ldif.LdifEntry	anonymizeChangeAdd(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry) Anonymize a Add change
private org.apache.directory.api.ldap.model.ldif.LdifEntry	anonymizeChangeDelete(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry) Anonymize a Delete change
private org.apache.directory.api.ldap.model.ldif.LdifEntry	anonymizeChangeModDn(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry) Anonymize a Delete change
private org.apache.directory.api.ldap.model.ldif.LdifEntry	anonymizeChangeModify(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry) Anonymize a Modify change
private org.apache.directory.api.ldap.model.name.Dn	anonymizeDn(org.apache.directory.api.ldap.model.name.Dn entryDn) Anonymize the entry's DN
private org.apache.directory.api.ldap.model.entry.Entry	anonymizeEntry(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry) Anonymize the full entry
void	anonymizeFile(String ldifFile, Writer writer) Anonymize a LDIF
Map<String,org.apache.directory.api.ldap.model.ldif.anonymizer.Anonymizer>	getAttributeAnonymizers()
Map<Integer,byte[]>	getLatestBytesMap()
Map<Integer,String>	getLatestStringMap()
Map<org.apache.directory.api.ldap.model.entry.Value<?>,org.apache.directory.api.ldap.model.entry.Value<?>>	getValueMap()
private void	init(Map<Integer,String> stringLatestValueMap, Map<Integer,byte[]> binaryLatestValueMap, Map<Integer,String> integerLatestValueMap, Map<Integer,String> telephoneNumberLatestValueMap) Initialize the anonymizer, filling the maps we use.
static void	main(String[] args) The entry point, when used as a standalone application.
private void	print(String str) Print the string into the PrintStream
private void	println() Print a nl into the PrintStream
private void	println(String str) Print the string into the PrintStream, with a NL at the end
void	removeAnonAttributeType(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Remove an attributeType that has to be anonymized
void	setAttributeLatestValueMap(org.apache.directory.api.ldap.model.schema.AttributeType attributeType, Map<Integer,?> latestValueMap) Set the latest value map to a defined anonymizer - if it exists -.
void	setLatestBytesMap(Map<Integer,byte[]> latestBytesMap)
void	setLatestStringMap(Map<Integer,String> latestStringMap)
void	setOut(PrintStream out) Set the PrintStream to use to print information about the processing
void	setValueMap(Map<org.apache.directory.api.ldap.model.entry.Value<?>,org.apache.directory.api.ldap.model.entry.Value<?>> valueMap)

Methods inherited from class java.lang.Object

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

Field Detail

valueMap

private Map<org.apache.directory.api.ldap.model.entry.Value<?>,org.apache.directory.api.ldap.model.entry.Value<?>> valueMap

The map that stores the anonymized values associated to the original value

valueSet

private Set<org.apache.directory.api.ldap.model.entry.Value<?>> valueSet

The set that contains all the values we already have anonymized

latestStringMap

private Map<Integer,String> latestStringMap

The latest anonymized String value Map

latestBytesMap

private Map<Integer,byte[]> latestBytesMap

The latest anonymized byte[] value Map

attributeAnonymizers

private Map<String,org.apache.directory.api.ldap.model.ldif.anonymizer.Anonymizer> attributeAnonymizers

The map of AttributeType'sOID we want to anonymize. They are all associated with anonymizers

namingContexts

private Set<org.apache.directory.api.ldap.model.name.Dn> namingContexts

The list of existing NamingContexts

schemaManager

private org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

The schemaManager

out

private 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(org.apache.directory.api.ldap.model.schema.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(PrintStream out)

Set the PrintStream to use to print information about the processing

Parameters:

out - The PrintStream to use

print

private void print(String str)

Print the string into the PrintStream

println

private void println(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(Map<Integer,String> stringLatestValueMap,
                  Map<Integer,byte[]> binaryLatestValueMap,
                  Map<Integer,String> integerLatestValueMap,
                  Map<Integer,String> telephoneNumberLatestValueMap)

Initialize the anonymizer, filling the maps we use.

setAttributeLatestValueMap

public void setAttributeLatestValueMap(org.apache.directory.api.ldap.model.schema.AttributeType attributeType,
                                       Map<Integer,?> latestValueMap)

Set the latest value map to a defined anonymizer - if it exists -.

Parameters:

attributeType - The AttributeType we are targetting

latestValueMap - The latest value map for this attribute

addAnonAttributeType

public void addAnonAttributeType(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                          throws org.apache.directory.api.ldap.model.exception.LdapException

Add an attributeType that has to be anonymized

Parameters:

attributeType - the AttributeType that has to be anonymized

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the attributeType cannot be added

addAnonAttributeType

public void addAnonAttributeType(org.apache.directory.api.ldap.model.schema.AttributeType attributeType,
                                 org.apache.directory.api.ldap.model.ldif.anonymizer.Anonymizer<?> anonymizer)
                          throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - If the attributeType cannot be added

removeAnonAttributeType

public void removeAnonAttributeType(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                             throws org.apache.directory.api.ldap.model.exception.LdapException

Remove an attributeType that has to be anonymized

Parameters:

attributeType - the AttributeType that we don't want to be anonymized

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the attributeType cannot be removed

getAttributeAnonymizers

public Map<String,org.apache.directory.api.ldap.model.ldif.anonymizer.Anonymizer> getAttributeAnonymizers()

Returns:

The list of configured anonymizers

addNamingContext

public void addNamingContext(String dn)
                      throws org.apache.directory.api.ldap.model.exception.LdapInvalidDnException

Add a new NamingContext

Parameters:

dn - The naming context to add

Throws:

org.apache.directory.api.ldap.model.exception.LdapInvalidDnException - if it's an invalid naming context

anonymizeAva

private org.apache.directory.api.ldap.model.name.Ava anonymizeAva(org.apache.directory.api.ldap.model.name.Ava ava)
                                                           throws org.apache.directory.api.ldap.model.exception.LdapInvalidDnException,
                                                                  org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

Anonymize an AVA

Throws:

org.apache.directory.api.ldap.model.exception.LdapInvalidDnException

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

anonymizeDn

private org.apache.directory.api.ldap.model.name.Dn anonymizeDn(org.apache.directory.api.ldap.model.name.Dn entryDn)
                                                         throws org.apache.directory.api.ldap.model.exception.LdapException

Anonymize the entry's DN

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

anonymizeFile

public void anonymizeFile(String ldifFile,
                          Writer writer)
                   throws org.apache.directory.api.ldap.model.exception.LdapException,
                          IOException

Anonymize a LDIF

Parameters:

ldifFile - The ldif file to anonymize

writer - The Writer to use to write the result

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If we got some LDAP related exception

IOException - If we had some issue during some IO operations

anonymizeChangeModify

private org.apache.directory.api.ldap.model.ldif.LdifEntry anonymizeChangeModify(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry)
                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Anonymize a Modify change

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

anonymizeChangeAdd

private org.apache.directory.api.ldap.model.ldif.LdifEntry anonymizeChangeAdd(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry)
                                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Anonymize a Add change

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

anonymizeChangeDelete

private org.apache.directory.api.ldap.model.ldif.LdifEntry anonymizeChangeDelete(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry)
                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Anonymize a Delete change

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

anonymizeChangeModDn

private org.apache.directory.api.ldap.model.ldif.LdifEntry anonymizeChangeModDn(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry)
                                                                         throws org.apache.directory.api.ldap.model.exception.LdapException

Anonymize a Delete change

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

anonymizeEntry

private org.apache.directory.api.ldap.model.entry.Entry anonymizeEntry(org.apache.directory.api.ldap.model.ldif.LdifEntry ldifEntry)
                                                                throws org.apache.directory.api.ldap.model.exception.LdapException

Anonymize the full entry

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

anonymize

public String anonymize(String ldif)
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        IOException

Anonymize a LDIF

Parameters:

ldif - The ldif content to anonymize

Returns:

an anonymized version of the given ldif

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If we got some LDAP related exception

IOException - If we had some issue during some IO operations

getValueMap

public Map<org.apache.directory.api.ldap.model.entry.Value<?>,org.apache.directory.api.ldap.model.entry.Value<?>> getValueMap()

Returns:

the valueMap

setValueMap

public void setValueMap(Map<org.apache.directory.api.ldap.model.entry.Value<?>,org.apache.directory.api.ldap.model.entry.Value<?>> valueMap)

Parameters:

valueMap - the valueMap to set

getLatestStringMap

public Map<Integer,String> getLatestStringMap()

Returns:

the latest String Value Map

setLatestStringMap

public void setLatestStringMap(Map<Integer,String> latestStringMap)

Parameters:

latestStringMap - the latest String Value Map to set

getLatestBytesMap

public Map<Integer,byte[]> getLatestBytesMap()

Returns:

the latest byte[] Value Map

setLatestBytesMap

public void setLatestBytesMap(Map<Integer,byte[]> latestBytesMap)

Parameters:

latestBytesMap - the latest byte[] Value Map to set

main

public static void main(String[] args)
                 throws IOException,
                        org.apache.directory.api.ldap.model.exception.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:

IOException - If we had an issue opening the file to anonymise ot writing the result

org.apache.directory.api.ldap.model.exception.LdapException - If we had some issue while processing the LDAP data