/*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package scriptella.driver.ldap.ldif;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.BasicAttribute;
import javax.naming.directory.BasicAttributes;
import javax.naming.directory.DirContext;
import javax.naming.directory.ModificationItem;
import javax.naming.ldap.Control;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* A entry to be populated by an ldif parser.
*
* We will have different kind of entries : - added entries - deleted entries -
* modified entries - RDN modified entries - DN modified entries
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class Entry
{
/** the change type */
private int changeType=ADD;
/** the modification item list */
private List<ModificationItem> modificationList = new ArrayList<ModificationItem>();
private Map<String,ModificationItem> modificationItems = new HashMap<String, ModificationItem>();
/** the dn of the ldif entry */
private String dn;
/** The new superior */
private String newSuperior;
/** The new rdn */
private String newRdn;
/** The delete old rdn flag */
private boolean deleteOldRdn;
/** attributes of the entry */
private BasicAttributes attributeList = new BasicAttributes(true);
/** The possible change types */
public final static int ADD = 0;
public final static int MODIFY = 1;
public final static int MODDN = 2;
public final static int MODRDN = 3;
public final static int DELETE = 4;
/** The control */
private Control control;
/**
* Set the Distinguished Name
*
* @param dn
* The Distinguished Name
*/
public void setDn( String dn )
{
this.dn = dn;
}
/**
* Set the modification type
*
* @param changeType
* The change type
*
*/
public void setChangeType( int changeType )
{
this.changeType = changeType;
}
/**
* Set the change type
*
* @param changeType
* The change type
*/
public void setChangeType( String changeType )
{
if ( "add".equals( changeType ) )
{
this.changeType = ADD;
}
else if ( "modify".equals( changeType ) )
{
this.changeType = MODIFY;
}
else if ( "moddn".equals( changeType ) )
{
this.changeType = MODDN;
}
else if ( "modrdn".equals( changeType ) )
{
this.changeType = MODRDN;
}
else if ( "delete".equals( changeType ) )
{
this.changeType = DELETE;
}
}
/**
* Add a modification item
*
* @param modOp
* The operation. One of : DirContext.ADD_ATTRIBUTE
* DirContext.REMOVE_ATTRIBUTE DirContext.REPLACE_ATTRIBUTE
*
* @param id
* The attribute's ID
* @param value
* The attribute's value
*/
public void addModificationItem( int modOp, String id, Object value )
{
if ( changeType == MODIFY )
{
BasicAttribute attr = new BasicAttribute( id, value );
if ( modificationItems.containsKey( id ) )
{
ModificationItem item = modificationItems.get( id );
if ( item.getModificationOp() != modOp )
{
// This is an error : we can't have two different
// modifications of the same attribute for the same entry
throw new LdifParseException( "Bad modification" );
}
Attribute attribute = item.getAttribute();
attribute.add( value );
}
else
{
ModificationItem item = new ModificationItem( modOp, attr );
modificationList.add( item );
modificationItems.put( id, item );
}
}
}
/**
* Add an attribute to the entry
*
* @param attr
* The attribute to be added
*/
public void addAttribute( Attribute attr )
{
attributeList.put( attr );
}
/**
* Add an attribute to the entry
*
* @param id
* The attribute ID
*
* @param value
* The attribute value
*
*/
public void addAttribute( String id, Object value )
{
Attribute attr = get( id );
if ( attr != null )
{
attr.add( value );
}
else
{
attributeList.put( id, value );
}
}
/**
* Add an attribute value to an existing attribute
*
* @param id
* The attribute ID
*
* @param value
* The attribute value
*
*/
public void putAttribute( String id, Object value )
{
Attribute attribute = attributeList.get( id );
if ( attribute != null )
{
attribute.add( value );
}
else
{
attributeList.put( id, value );
}
}
/**
* Get the change type
*
* @return The change type. One of : ADD = 0; MODIFY = 1; MODDN = 2; MODRDN =
* 3; DELETE = 4;
*/
public int getChangeType()
{
return changeType;
}
/**
* @return The list of modification items
*/
public List<ModificationItem> getModificationItems()
{
return modificationList;
}
/**
* @return The entry Distinguished name
*/
public String getDn()
{
return dn;
}
/**
* @return The number of entry modifications
*/
public int size()
{
return modificationList.size();
}
/**
* Returns a attribute given it's id
*
* @param attributeId
* The attribute Id
* @return The attribute if it exists
*/
public Attribute get( String attributeId )
{
if ( "dn".equalsIgnoreCase( attributeId ) )
{
return new BasicAttribute( "dn", dn );
}
return attributeList.get( attributeId );
}
/**
* Get the entry's attributes
*
* @return An Attributes
*/
public Attributes getAttributes()
{
if ( isEntry() )
{
return attributeList;
}
else
{
return null;
}
}
/**
* @return True, if the old RDN should be deleted.
*/
public boolean isDeleteOldRdn()
{
return deleteOldRdn;
}
/**
* Set the flage deleteOldRdn
*
* @param deleteOldRdn
* True if the old RDN should be deleted
*/
public void setDeleteOldRdn( boolean deleteOldRdn )
{
this.deleteOldRdn = deleteOldRdn;
}
/**
* @return The new RDN
*/
public String getNewRdn()
{
return newRdn;
}
/**
* Set the new RDN
*
* @param newRdn
* The new RDN
*/
public void setNewRdn( String newRdn )
{
this.newRdn = newRdn;
}
/**
* @return The new superior
*/
public String getNewSuperior()
{
return newSuperior;
}
/**
* Set the new superior
*
* @param newSuperior
* The new Superior
*/
public void setNewSuperior( String newSuperior )
{
this.newSuperior = newSuperior;
}
/**
* @return True if the entry is an ADD entry
*/
public boolean isChangeAdd()
{
return changeType == ADD;
}
/**
* @return True if the entry is a DELETE entry
*/
public boolean isChangeDelete()
{
return changeType == DELETE;
}
/**
* @return True if the entry is a MODDN entry
*/
public boolean isChangeModDn()
{
return changeType == MODDN;
}
/**
* @return True if the entry is a MODRDN entry
*/
public boolean isChangeModRdn()
{
return changeType == MODRDN;
}
/**
* @return True if the entry is a MODIFY entry
*/
public boolean isChangeModify()
{
return changeType == MODIFY;
}
public boolean isEntry()
{
return changeType == ADD;
}
/**
* @return The associated control, if any
*/
public Control getControl()
{
return control;
}
/**
* Add a control to the entry
*
* @param control
* The control
*/
public void setControl( Control control )
{
this.control = control;
}
/**
* Dumps the attributes
*/
private String dumpAttributes()
{
StringBuffer sb = new StringBuffer();
try
{
for ( NamingEnumeration attrs = attributeList.getAll(); attrs.hasMoreElements(); )
{
Attribute attribute = (Attribute) attrs.nextElement();
sb.append( " ").append( attribute.getID() ).append( ":\n" );
for ( NamingEnumeration values = attribute.getAll(); values.hasMoreElements(); )
{
Object value = values.nextElement();
if ( value instanceof String )
{
sb.append( " " ).append( (String)value ).append('\n' );
}
else
{
sb.append( " " ).append( Utils.dumpBytes( (byte[]) value ) ).append('\n' );
}
}
}
}
catch ( NamingException ne )
{
return "";
}
return sb.toString();
}
/**
* Dumps the modifications
*/
private String dumpModificationItems()
{
StringBuffer sb = new StringBuffer();
for (ModificationItem modif : modificationList) {
sb.append(" Operation: ");
switch (modif.getModificationOp()) {
case DirContext.ADD_ATTRIBUTE :
sb.append("ADD\n");
break;
case DirContext.REMOVE_ATTRIBUTE :
sb.append("REMOVE\n");
break;
case DirContext.REPLACE_ATTRIBUTE :
sb.append("REPLACE \n");
break;
}
Attribute attribute = modif.getAttribute();
sb.append(" Attribute: ").append(attribute.getID()).append('\n');
if (attribute.size() != 0) {
try {
for (NamingEnumeration values = attribute.getAll(); values.hasMoreElements();) {
Object value = values.nextElement();
if (value instanceof String) {
sb.append(" ").append((String) value).append('\n');
} else {
sb.append(" ").append(Utils.dumpBytes((byte[]) value)).append('\n');
}
}
}
catch (NamingException ne) {
return "";
}
}
}
return sb.toString();
}
/**
* Return a String representing the Entry
*/
public String toString()
{
StringBuffer sb = new StringBuffer();
sb.append( "Entry : " ).append( dn ).append( '\n' );
if ( control != null )
{
sb.append( " Control : " ).append( control ).append( '\n' );
}
switch ( changeType )
{
case ADD :
sb.append( " Change type is ADD\n" );
sb.append( " Attributes : \n" );
sb.append( dumpAttributes() );
break;
case MODIFY :
sb.append( " Change type is MODIFY\n" );
sb.append( " Modifications : \n" );
sb.append( dumpModificationItems() );
break;
case DELETE :
sb.append( " Change type is DELETE\n" );
break;
case MODDN :
case MODRDN :
sb.append( " Change type is ").append( changeType == MODDN ? "MODDN\n" : "MODRDN\n" );
sb.append( " Delete old RDN : " ).append( deleteOldRdn ? "true\n" : "false\n" );
sb.append( " New RDN : " ).append( newRdn ).append( '\n' );
if ( newSuperior !=null )
{
sb.append( " New superior : " ).append( newSuperior ).append( '\n' );
}
break;
}
return sb.toString();
}
}