/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.directory.server.core.entry;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import javax.naming.NamingException;
import org.apache.directory.server.i18n.I18n;
import org.apache.directory.shared.ldap.entry.Entry;
import org.apache.directory.shared.ldap.entry.EntryAttribute;
import org.apache.directory.shared.ldap.entry.Value;
import org.apache.directory.shared.ldap.entry.client.DefaultClientEntry;
import org.apache.directory.shared.ldap.name.DN;
import org.apache.directory.shared.ldap.schema.AttributeType;
/**
* A ServerEntry refers to the original entry before being modified by
* EntryFilters or operations.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
*/
public class ClonedServerEntry implements ServerEntry
{
/** The original entry as returned by the backend */
private final ServerEntry originalEntry;
/** The copied entry */
private final ServerEntry clonedEntry;
/**
* Creates a new instance of ClonedServerEntry.
*
* The original entry is cloned in order to protect its content.
*
* @param originalEntry The original entry
*/
public ClonedServerEntry( ServerEntry originalEntry )
{
this.originalEntry = ( ServerEntry )originalEntry.clone();
this.clonedEntry = ( ServerEntry ) originalEntry.clone();
}
/**
* @return the originalEntry
*/
public ServerEntry getOriginalEntry()
{
return originalEntry;
}
/**
* @return the cloned Entry
*/
public Entry getClonedEntry()
{
return clonedEntry;
}
public void add( AttributeType attributeType, byte[]... values ) throws NamingException
{
clonedEntry.add( attributeType, values );
}
public void add( AttributeType attributeType, String... values ) throws NamingException
{
clonedEntry.add( attributeType, values );
}
public void add( AttributeType attributeType, Value<?>... values ) throws NamingException
{
clonedEntry.add( attributeType, values );
}
public void add( String upId, AttributeType attributeType, byte[]... values ) throws NamingException
{
clonedEntry.add( attributeType, values );
}
public void add( String upId, AttributeType attributeType, String... values ) throws NamingException
{
clonedEntry.add( attributeType, values );
}
public void add( String upId, AttributeType attributeType, Value<?>... values ) throws NamingException
{
clonedEntry.add( attributeType, values );
}
public boolean contains( AttributeType attributeType, byte[]... values )
{
return clonedEntry.contains( attributeType, values );
}
public boolean contains( AttributeType attributeType, String... values )
{
return clonedEntry.contains( attributeType, values );
}
public boolean contains( AttributeType attributeType, Value<?>... values )
{
return clonedEntry.contains( attributeType, values );
}
public boolean containsAttribute( AttributeType attributeType )
{
return clonedEntry.containsAttribute( attributeType );
}
public EntryAttribute get( AttributeType attributeType )
{
return clonedEntry.get( attributeType );
}
public Set<AttributeType> getAttributeTypes()
{
return clonedEntry.getAttributeTypes();
}
public boolean hasObjectClass( EntryAttribute objectClass )
{
return clonedEntry.hasObjectClass( objectClass );
}
public boolean isValid()
{
return clonedEntry.isValid();
}
public boolean isValid( String objectClass )
{
return clonedEntry.isValid( objectClass );
}
public boolean isValid( EntryAttribute objectClass )
{
return clonedEntry.isValid( objectClass );
}
public EntryAttribute put( AttributeType attributeType, byte[]... values ) throws NamingException
{
return clonedEntry.put( attributeType, values );
}
public EntryAttribute put( AttributeType attributeType, String... values ) throws NamingException
{
return clonedEntry.put( attributeType, values );
}
public EntryAttribute put( AttributeType attributeType, Value<?>... values ) throws NamingException
{
return clonedEntry.put( attributeType, values );
}
public EntryAttribute put( String upId, AttributeType attributeType, byte[]... values ) throws NamingException
{
return clonedEntry.put( attributeType, values );
}
public EntryAttribute put( String upId, AttributeType attributeType, String... values ) throws NamingException
{
return clonedEntry.put( upId, attributeType, values );
}
public EntryAttribute put( String upId, AttributeType attributeType, Value<?>... values ) throws NamingException
{
return clonedEntry.put( upId, attributeType, values );
}
public boolean remove( AttributeType attributeType, byte[]... values ) throws NamingException
{
return clonedEntry.remove( attributeType, values );
}
public boolean remove( AttributeType attributeType, String... values ) throws NamingException
{
return clonedEntry.remove( attributeType, values );
}
public boolean remove( AttributeType attributeType, Value<?>... values ) throws NamingException
{
return clonedEntry.remove( attributeType, values );
}
public List<EntryAttribute> remove( EntryAttribute... attributes ) throws NamingException
{
return clonedEntry.remove( attributes );
}
public List<EntryAttribute> removeAttributes( AttributeType... attributes )
{
return clonedEntry.removeAttributes( attributes );
}
public List<EntryAttribute> set( AttributeType... attributeTypes )
{
return clonedEntry.set( attributeTypes );
}
public void add( EntryAttribute... attributes ) throws NamingException
{
clonedEntry.add( attributes );
}
public void add( String upId, String... values ) throws NamingException
{
clonedEntry.add( upId, values );
}
public void add( String upId, byte[]... values ) throws NamingException
{
clonedEntry.add( upId, values );
}
public void add( String upId, Value<?>... values ) throws NamingException
{
clonedEntry.add( upId, values );
}
public void clear()
{
clonedEntry.clear();
}
public boolean contains( EntryAttribute... attributes ) throws NamingException
{
return clonedEntry.contains( attributes );
}
public boolean contains( String upId, byte[]... values )
{
return clonedEntry.contains( upId, values );
}
public boolean contains( String upId, String... values )
{
return clonedEntry.contains( upId, values );
}
public boolean contains( String upId, Value<?>... values )
{
return clonedEntry.contains( upId, values );
}
public boolean containsAttribute( String... attributes )
{
return clonedEntry.containsAttribute( attributes );
}
public EntryAttribute get( String alias )
{
return clonedEntry.get( alias );
}
public DN getDn()
{
return clonedEntry.getDn();
}
public boolean hasObjectClass( String objectClass )
{
return clonedEntry.hasObjectClass( objectClass );
}
public Iterator<EntryAttribute> iterator()
{
return clonedEntry.iterator();
}
public List<EntryAttribute> put( EntryAttribute... attributes ) throws NamingException
{
return clonedEntry.put( attributes );
}
public EntryAttribute put( String upId, byte[]... values )
{
return clonedEntry.put( upId, values );
}
public EntryAttribute put( String upId, String... values )
{
return clonedEntry.put( upId, values );
}
public EntryAttribute put( String upId, Value<?>... values )
{
return clonedEntry.put( upId, values );
}
public boolean remove( String upId, byte[]... values ) throws NamingException
{
return clonedEntry.remove( upId, values );
}
public boolean remove( String upId, String... values ) throws NamingException
{
return clonedEntry.remove( upId, values );
}
public boolean remove( String upId, Value<?>... values ) throws NamingException
{
return clonedEntry.remove( upId, values );
}
public List<EntryAttribute> removeAttributes( String... attributes )
{
return clonedEntry.removeAttributes( attributes );
}
public List<EntryAttribute> set( String... upIds )
{
return clonedEntry.set( upIds );
}
public void setDn( DN dn )
{
clonedEntry.setDn( dn );
}
public int size()
{
return clonedEntry.size();
}
public Entry toClientEntry() throws NamingException
{
// Copy the DN
Entry clientEntry = new DefaultClientEntry( clonedEntry.getDn() );
// Convert each attribute
for ( EntryAttribute clonedEntry:this )
{
EntryAttribute clientAttribute = ((ServerAttribute)clonedEntry).toClientAttribute();
clientEntry.add( clientAttribute );
}
return clientEntry;
}
/**
* @see java.io.Externalizable#readExternal(ObjectInput)
*
* We can't use this method for a ServerEntry
*/
public void readExternal( ObjectInput in ) throws IOException, ClassNotFoundException
{
throw new IllegalStateException( I18n.err( I18n.ERR_455 ) );
}
/**
* @see java.io.Externalizable#writeExternal(ObjectOutput)
*
* We can't use this method for a ServerEntry
*/
public void writeExternal( ObjectOutput out ) throws IOException
{
throw new IllegalStateException( I18n.err( I18n.ERR_456 ) );
}
public ServerEntry clone()
{
return ( ServerEntry ) clonedEntry.clone();
}
/**
* @see Object#equals(Object);
*/
public boolean equals( Object obj )
{
// Short circuit
if ( this == obj )
{
return true;
}
Entry other;
if ( obj instanceof ClonedServerEntry )
{
other = ((ClonedServerEntry)obj).getClonedEntry();
}
else if ( obj instanceof ServerEntry )
{
other = (ServerEntry)obj;
}
else
{
return false;
}
return clonedEntry.equals( other );
}
public String toString()
{
return clonedEntry.toString();
}
class EmptyEntry implements ServerEntry
{
DN dn;
EmptyEntry( DN dn )
{
this.dn = dn;
}
public void add( AttributeType attributeType, byte[]... values ) throws NamingException
{
}
public void add( AttributeType attributeType, String... values ) throws NamingException
{
}
public void add( AttributeType attributeType, Value<?>... values ) throws NamingException
{
}
public void add( String upId, AttributeType attributeType, byte[]... values ) throws NamingException
{
}
public void add( String upId, AttributeType attributeType, String... values ) throws NamingException
{
}
public void add( String upId, AttributeType attributeType, Value<?>... values ) throws NamingException
{
}
public boolean contains( AttributeType attributeType, byte[]... values )
{
return false;
}
public boolean contains( AttributeType attributeType, String... values )
{
return false;
}
public boolean contains( AttributeType attributeType, Value<?>... values )
{
return false;
}
public boolean containsAttribute( AttributeType attributeType )
{
return false;
}
public EntryAttribute get( AttributeType attributeType )
{
return null;
}
public Set<AttributeType> getAttributeTypes()
{
return null;
}
public boolean hasObjectClass( EntryAttribute objectClass )
{
return false;
}
public boolean isValid()
{
return false;
}
public boolean isValid( String objectClass )
{
return false;
}
public boolean isValid( EntryAttribute objectClass )
{
return false;
}
public EntryAttribute put( AttributeType attributeType, byte[]... values ) throws NamingException
{
return null;
}
public EntryAttribute put( AttributeType attributeType, String... values ) throws NamingException
{
return null;
}
public EntryAttribute put( AttributeType attributeType, Value<?>... values ) throws NamingException
{
return null;
}
public EntryAttribute put( String upId, AttributeType attributeType, byte[]... values ) throws NamingException
{
return null;
}
public EntryAttribute put( String upId, AttributeType attributeType, String... values ) throws NamingException
{
return null;
}
public EntryAttribute put( String upId, AttributeType attributeType, Value<?>... values )
throws NamingException
{
return null;
}
public boolean remove( AttributeType attributeType, byte[]... values ) throws NamingException
{
return false;
}
public boolean remove( AttributeType attributeType, String... values ) throws NamingException
{
return false;
}
public boolean remove( AttributeType attributeType, Value<?>... values ) throws NamingException
{
return false;
}
public List<EntryAttribute> remove( EntryAttribute... attributes ) throws NamingException
{
return Collections.emptyList();
}
public List<EntryAttribute> removeAttributes( AttributeType... attributes )
{
return Collections.emptyList();
}
public List<EntryAttribute> set( AttributeType... attributeTypes )
{
return Collections.emptyList();
}
public void add( EntryAttribute... attributes ) throws NamingException
{
}
public void add( String upId, String... values ) throws NamingException
{
}
public void add( String upId, byte[]... values ) throws NamingException
{
}
public void add( String upId, Value<?>... values ) throws NamingException
{
}
public void clear()
{
}
public boolean contains( EntryAttribute... attributes ) throws NamingException
{
return false;
}
public boolean contains( String upId, byte[]... values )
{
return false;
}
public boolean contains( String upId, String... values )
{
return false;
}
public boolean contains( String upId, Value<?>... values )
{
return false;
}
public boolean containsAttribute( String... attributes )
{
return false;
}
public EntryAttribute get( String alias )
{
return null;
}
public DN getDn()
{
return null;
}
public boolean hasObjectClass( String objectClass )
{
return false;
}
@SuppressWarnings("unchecked")
public Iterator<EntryAttribute> iterator()
{
return ( ( List <EntryAttribute> ) Collections.EMPTY_LIST ).iterator();
}
public List<EntryAttribute> put( EntryAttribute... attributes ) throws NamingException
{
return Collections.emptyList();
}
public EntryAttribute put( String upId, byte[]... values )
{
return null;
}
public EntryAttribute put( String upId, String... values )
{
return null;
}
public EntryAttribute put( String upId, Value<?>... values )
{
return null;
}
public boolean remove( String upId, byte[]... values ) throws NamingException
{
return false;
}
public boolean remove( String upId, String... values ) throws NamingException
{
return false;
}
public boolean remove( String upId, Value<?>... values ) throws NamingException
{
return false;
}
public List<EntryAttribute> removeAttributes( String... attributes )
{
return Collections.emptyList();
}
public List<EntryAttribute> set( String... upIds )
{
return Collections.emptyList();
}
public void setDn( DN dn )
{
this.dn = dn;
}
public int size()
{
return 0;
}
public ServerEntry clone()
{
return new EmptyEntry( dn );
}
public void readExternal( ObjectInput in ) throws IOException, ClassNotFoundException
{
}
public void writeExternal( ObjectOutput out ) throws IOException
{
}
public Entry toClientEntry() throws NamingException
{
// Copy the DN
Entry clientEntry = new DefaultClientEntry( dn );
// Convert each attribute
for ( EntryAttribute serverAttribute:this )
{
EntryAttribute clientAttribute = ((ServerAttribute)serverAttribute).toClientAttribute();
clientEntry.add( clientAttribute );
}
return clientEntry;
}
}
}