com.novell.ldap.LDAPModification Maven / Gradle / Ivy
/* **************************************************************************
* $OpenLDAP$
*
* Copyright (C) 1999 - 2002 Novell, Inc. All Rights Reserved.
*
* THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND
* TREATIES. USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT
* TO VERSION 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS
* AVAILABLE AT HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE"
* IN THE TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION
* OF THIS WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP
* PUBLIC LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT
* THE PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
******************************************************************************/
package com.novell.ldap;
import java.io.BufferedInputStream;
import java.io.ByteArrayInputStream;
import java.io.Externalizable;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import com.novell.ldap.util.Base64;
import com.novell.ldap.util.LDAPXMLHandler;
import com.novell.ldap.util.SAXEventMultiplexer;
import com.novell.ldap.util.ValueXMLhandler;
/**
* A single add, delete, or replace operation to an LDAPAttribute.
*
* An LDAPModification contains information on the type of modification
* being performed, the name of the attribute to be replaced, and the new
* value. Multiple modifications are expressed as an array of modifications,
* i.e., LDAPModification[].
*
* An LDAPModification or an LDAPModification array enable you to modify
* an attribute of an LDAP entry. The entire array of modifications must
* be performed by the server as a single atomic operation in the order they
* are listed. No changes are made to the directory unless all the operations
* succeed. If all succeed, a success result is returned to the application.
* It should be noted that if the connection fails during a modification,
* it is indeterminate whether the modification occurred or not.
*
* There are three types of modification operations: Add, Delete,
* and Replace.
*
* Add: Creates the attribute if it doesn't exist, and adds
* the specified values. This operation must contain at least one value, and
* all values of the attribute must be unique.
*
* Delete: Deletes specified values from the attribute. If no
* values are specified, or if all existing values of the attribute are
* specified, the attribute is removed. Mandatory attributes cannot be
* removed.
*
* Replace: Creates the attribute if necessary, and replaces
* all existing values of the attribute with the specified values.
* If you wish to keep any existing values of a multi-valued attribute,
* you must include these values in the replace operation.
* A replace operation with no value will remove the entire attribute if it
* exists, and is ignored if the attribute does not exist.
*
* Additional information on LDAP modifications is available in section 4.6
* of rfc2251.txt
*
* Sample Code:
*
Adding, replacing, or deleting individual attribute values
* ModifyAttrs.java
*
* Deleting an attribute
* DeleteAttribute.java
*
* @see LDAPConnection#modify
* @see LDAPAttribute
*/
public class LDAPModification implements Externalizable {
private int op;
private LDAPAttribute attr;
/**
* Adds the listed values to the given attribute, creating
* the attribute if it does not already exist.
*
*ADD = 0
*/
public static final int ADD = 0;
/**
* Deletes the listed values from the given attribute,
* removing the entire attribute (1) if no values are listed or
* (2) if all current values of the attribute are listed for
* deletion.
*
*DELETE = 1
*/
public static final int DELETE = 1;
/**
* Replaces all existing values of the given attribute
* with the new values listed, creating the attribute if it
* does not already exist.
*
* A replace with no value deletes the entire attribute if it
* exists, and is ignored if the attribute does not exist.
*
*REPLACE = 2
*/
public static final int REPLACE = 2;
/**
* This constructor was added to support default Serialization
*
*/
public LDAPModification()
{
super();
}
/**
* Specifies a modification to be made to an attribute.
*
* @param op The type of modification to make, which can be
* one of the following:
*
* - LDAPModification.ADD - The value should be added to
* the attribute
*
* - LDAPModification.DELETE - The value should be removed
* from the attribute
*
* - LDAPModification.REPLACE - The value should replace all
* existing values of the
* attribute
*
* @param attr The attribute to modify.
*
*/
public LDAPModification(int op, LDAPAttribute attr)
{
this.op = op;
this.attr = attr;
return;
}
/**
* Returns the attribute to modify, with any existing values.
*
* @return The attribute to modify.
*/
public LDAPAttribute getAttribute()
{
return attr;
}
/**
* Returns the type of modification specified by this object.
*
* The type is one of the following:
*
* - LDAPModification.ADD
* - LDAPModification.DELETE
* - LDAPModification.REPLACE
*
*
* @return The type of modification specified by this object.
*/
public int getOp()
{
return op;
}
void newLine(int indentTabs,java.io.Writer out) throws java.io.IOException
{
String tabString = " ";
out.write("\n");
for (int i=0; i< indentTabs; i++){
out.write(tabString);
}
return;
}
/**
* This method does DSML serialization of the instance.
*
* @param oout Outputstream where the serialzed data has to be written
*
* @throws IOException if write fails on OutputStream
*/
public void writeDSML(java.io.OutputStream oout) throws java.io.IOException
{
java.io.Writer out=new java.io.OutputStreamWriter(oout,"UTF-8");
out.write("");
LDAPAttribute attr=getAttribute();
String values[] = attr.getStringValueArray();
byte bytevalues[][] = attr.getByteValueArray();
for(int j=0; j");
out.write(values[j]);
out.write("");
} else {
out.write("");
out.write(Base64.encode(bytevalues[j]));
out.write(" ");
}
}
newLine(0,out);
out.write(" ");
out.close();
}
/**
* This method is used to deserialize the DSML encoded representation of
* this class.
* @param input InputStream for the DSML formatted data.
* @return Deserialized form of this class.
* @throws IOException when serialization fails.
*/
public static Object readDSML(InputStream input)throws IOException
{
SAXEventMultiplexer xmlreader = new SAXEventMultiplexer();
xmlreader.setLDAPXMLHandler(getXMLHandler("modification",null));
return (LDAPModification) xmlreader.parseXML(input);
}
/**
* This method return the LDAPHandler which handles the XML (DSML) tags
* for this class
* @param tagname Name of the Root tag used to represent this class.
* @param parenthandler Parent LDAPXMLHandler for this tag.
* @return LDAPXMLHandler to handle this element.
*/
static LDAPXMLHandler getXMLHandler(String tagname,LDAPXMLHandler parenthandler) {
return new LDAPXMLHandler(tagname, parenthandler) {
String attrName;
int operation;
List valuelist = new ArrayList();
protected void initHandler() {
//set Value Handler .
setchildelement(new ValueXMLhandler(this));
}
protected void endElement() {
LDAPAttribute attr = new LDAPAttribute(attrName);
if (!valuelist.isEmpty())
{
Iterator valueiterator = valuelist.iterator();
while (valueiterator.hasNext())
{
attr.addValue((byte[])valueiterator.next());
}
}
LDAPModification mod = new LDAPModification(operation,attr);
setObject(mod);
}
protected void addValue(String tag, Object value) {
if (tag.equals("value")) {
valuelist.add(value);
}
}
protected void handleAttributes(Attributes attrs)throws SAXException {
String temp;
attrName = attrs.getValue("name");
temp = attrs.getValue("operation");
if (temp == null || attrName == null) {
throw new SAXException(
"Required attribute missing from tag "
+ ""
+ " (operation or name are required)");
} else if (temp.equals("add")) {
operation = LDAPModification.ADD;
} else if (temp.equals("replace")) {
operation = LDAPModification.REPLACE;
} else if (temp.equals("delete")) {
operation = LDAPModification.DELETE;
} else {
throw new SAXException(
"Invalid value for attribute 'operation': " + temp);
}
}
};
}
/**
* Returns a string representation of this class.
*
* @return The string representation of this class.
*/
public String toString()
{
StringBuffer result = new StringBuffer("LDAPModification: (operation=");
switch(getOp())
{
case LDAPModification.ADD:
result.append("add");
break;
case LDAPModification.DELETE:
result.append("delete");
break;
case LDAPModification.REPLACE:
result.append("replace");
break;
}
result.append(",("+getAttribute()+"))");
return result.toString();
}
/**
* Writes the object state to a stream in XML format
* @param out The ObjectOutput stream where the Object in XML format
* is being written to
* @throws IOException - If I/O errors occur
*/
public void writeExternal(ObjectOutput out) throws IOException
{
StringBuffer buff = new StringBuffer();
buff.append(ValueXMLhandler.newLine(0));
buff.append(ValueXMLhandler.newLine(0));
String header = "";
header += "*************************************************************************\n";
header += "** The encrypted data above and below is the Class definition and ******\n";
header += "** other data specific to Java Serialization Protocol. The data ********\n";
header += "** which is of most application specific interest is as follows... ******\n";
header += "*************************************************************************\n";
header += "****************** Start of application data ****************************\n";
header += "*************************************************************************\n";
buff.append(header);
buff.append(ValueXMLhandler.newLine(0));
buff.append("");
LDAPAttribute attr=getAttribute();
String values[] = attr.getStringValueArray();
byte bytevalues[][] = attr.getByteValueArray();
for(int j=0; j");
buff.append(values[j]);
buff.append("");
} else {
buff.append("");
buff.append(Base64.encode(bytevalues[j]));
buff.append(" ");
}
}
buff.append(ValueXMLhandler.newLine(0));
buff.append(" ");
buff.append(ValueXMLhandler.newLine(0));
buff.append(ValueXMLhandler.newLine(0));
String tail = "";
tail += "*************************************************************************\n";
tail += "****************** End of application data ******************************\n";
tail += "*************************************************************************\n";
buff.append(tail);
buff.append(ValueXMLhandler.newLine(0));
out.writeUTF(buff.toString());
}
/**
* Reads the serialized object from the underlying input stream.
* @param in The ObjectInput stream where the Serialized Object is being read from
* @throws IOException - If I/O errors occur
* @throws ClassNotFoundException - If the class for an object being restored
* cannot be found.
*/
public void readExternal(ObjectInput in)
throws IOException, ClassNotFoundException
{
String readData = in.readUTF();
String readProperties = readData.substring(readData.indexOf('<'),
(readData.lastIndexOf('>') + 1));
//Insert parsing logic here for separating whitespaces in non-text nodes
StringBuffer parsedBuff = new StringBuffer();
ValueXMLhandler.parseInput(readProperties, parsedBuff);
BufferedInputStream istream =
new BufferedInputStream(
new ByteArrayInputStream((parsedBuff.toString()).getBytes()));
LDAPModification readObject =
(LDAPModification)LDAPModification.readDSML(istream);
this.op = readObject.getOp();
this.attr = readObject.getAttribute();
//Garbage collect the readObject from readDSML()..
readObject = null;
}
}