CompoundName is a series of string elements, and it represents
* a name in a naming service within a single namespace. Typically these
* names have a structure which is hierarchical.
*
* A CompoundName has a sequence of zero or more elements delimited
* by the char specified in the property "jndi.syntax.separator". This property
* is required except when the direction of the name is "flat"
* (see jndi.syntax.direction). The property "jndi.syntax.separator2" allows for
* the specification of an additional separator. A separator string will be
* treated as normal characters if it is preceded by the escape string or is
* within quotes.
* The property "jndi.syntax.direction" specifies the direction in which the name
* is read. Permitted values are "right_to_left", "left_to_right" and "flat". A
* flat name does not have a hierarchical structure. If this property is not
* specified then the default is "flat". If this property is specified with an
* invalid value then an IllegalArgumentException should be raised.
* Each element can be accessed using its position. The first element is at * position 0. The direction of the name is important. When direction is * "left_to_right" then the leftmost element is at position 0. Conversely when * the direction is "right_to_left" then the rightmost element is at position 0.
*
* There are other properties which affect the syntax of a CompoundName.
* The following properties are all optional:
*
* When a non-escaped quote appears at the start of an element it must be matched at the * end. That element can then be said to be quoted. When an escape sequence appears * within a quoted element then it is treated as normal characters unless it precedes * an occurrence of the quote in which case it is assumed that the quoted element * contains a quote which is escaped.
** If the element does not start with a quote, then any quote strings within that * element are just normal characters.
**
* These 2 properties relate to names where the syntax includes attribute/content * pairs. *
* The jndi.syntax.separator.ava is not used when manipulating CompoundName.
* The jndi.syntax.separator is still used to separate elements.
* The CompoundName needs to be aware of the jndi.syntax.separator.typeval
* in case of the instance where a quoted string is used to provide the content
* of a pair.
* Consider the string "CN=$Mandy Jennings, O=Apache, C=UK" with *
CompoundName
* with 3 elements.
* * If jndi.syntax.beginquote is then set to "$" the name becomes invalid as the * content part of the pair CN=$Mandy Jennings has a mismatched quote.
** The string "CN=$Mandy Jennings$, O=Apache, C=UK" would be fine as the $ quotes * round Mandy Jennings now balance.
*
* A CompoundName may be empty. An empty CompoundName has no elements.
* Elements may also be empty.
* Some Examples:
* ==============
*
* Consider the following compound name from the file system namespace:
* "home/jenningm-abc/.profile"
*
* jndi.syntax.separator is set to '/' as in the UNIX filesystem.
* This name has 3 elements:
* home jenningm-abc and .profile
* The direction should be left_to_right as in the UNIX filesystem
* The element at position 0 would be home.
*
*
* Consider if jndi.syntax.separator had been set to '-' then this name
* would have 2 elements:
* home/jenningm and abc/.profile
* If the direction was right_to_left then the element at position 0
* would be abc/.profile.
*
* Consider the name "<ab<cd>ef>" where jndi.syntax.beginquote is <
* and jndi.syntax.endquote is >. This will give rise to an
* InvalidNameException because a close quote was encountered before
* the end of an element. The same is also true for "<abcd>ef>".
* If the name was "ab<cd>ef" then this would be valid and there would
* be one element ab<cd>ef.
* However if the name was "<abcdef>" there would be one element abcdef.
*
* An empty CompoundName is the name "" and has no elements.
*
* When jndi.syntax.beginquote is set to " and beginquote2 is set to '
* the behaviour is similar to CompositeName -
* The name "\"abcd" gives an InvalidNameException as there is no closing quote.
* The name "'\"abcd'" gives one element of value "abcd.
* The name "\\abcd" gives one element of value \abcd.
*
* Assuming:
* jndi.syntax.separator is "/"
* jndi.syntax.direction is "left_to_right"
* then
* "" is empty. It has no elements.
* "/" has one empty element.
* "//" has 2 empty elements.
* "/a/" has 3 elements the middle one is set to a.
* "///" has 3 empty elements.
* "//a/" has 4 elements, the last but one is set to a.
*
*
* Assuming the only properties set are:
* jndi.syntax.separator is "/"
* jndi.syntax.direction is "left_to_right"
* then the String
* "\"" has one element with the value "
* "\\\"" has one element with the value \"
* "\\\"'" has one element with the value \"'
*
* Assuming the only properties set are:
* jndi.syntax.separator is "/"
* jndi.syntax.direction is "left_to_right"
* jndi.syntax.beginquote is "\""
*
* then the String
* "\"" is invalid because of no closing quote
* "\\\"" has one element with the value \"
* "\\\"'" has one element with the value \"'
*
*
* Assuming the only properties set are:
* jndi.syntax.separator is "/"
* jndi.syntax.direction is "left_to_right"
* jndi.syntax.beginquote is "\""
* jndi.syntax.beginquote2 is "\'"
* then the String
* "\"" is invalid because of no closing quote
* "\\\"" has one element with the value \"
* "\\\"'" has one element with the value \"'
* "'\\" is invalid because of no closing quote
*
*
*
*/
public class CompoundName implements Name {
/*
*Note: For serialization purposes, the specified serialVersionUID must be used.
*This class does not have serializable fields specified. Instead the readObject
*and writeObject methods are overridden.
*/
private static final long serialVersionUID = 3513100557083972036L; // J2SE 1.4.2
//const for property key
private static final String SEPARATOR = "jndi.syntax.separator"; //$NON-NLS-1$
private static final String SEPARATOR_AVA = "jndi.syntax.separator.ava"; //$NON-NLS-1$
private static final String SEPARATOR_TYPEVAL = "jndi.syntax.separator.typeval"; //$NON-NLS-1$
private static final String ESCAPE = "jndi.syntax.escape"; //$NON-NLS-1$
private static final String BEGIN_QUOTE = "jndi.syntax.beginquote"; //$NON-NLS-1$
private static final String END_QUOTE = "jndi.syntax.endquote"; //$NON-NLS-1$
private static final String BEGIN_QUOTE2 = "jndi.syntax.beginquote2"; //$NON-NLS-1$
private static final String END_QUOTE2 = "jndi.syntax.endquote2"; //$NON-NLS-1$
private static final String IGNORE_CASE = "jndi.syntax.ignorecase"; //$NON-NLS-1$
private static final String TRIM_BLANKS = "jndi.syntax.trimblanks"; //$NON-NLS-1$
private static final String DIRECTION = "jndi.syntax.direction"; //$NON-NLS-1$
private static final String SEPARATOR2 = "jndi.syntax.separator2"; //$NON-NLS-1$
//const for direction
private static final String LEFT_TO_RIGHT = "left_to_right"; //$NON-NLS-1$
private static final String RIGHT_TO_LEFT = "right_to_left"; //$NON-NLS-1$
private static final String FLAT = "flat"; //$NON-NLS-1$
// alphabets consts
private static final String NULL_STRING = ""; //$NON-NLS-1$
//states consts
private static final int NORMAL_STATUS = 0;
private static final int QUOTE1_STATUS = 1;
private static final int QUOTE2_STATUS = 2;
private static final int INIT_STATUS = 3;
private static final int QUOTEEND_STATUS = 4;
//properties variables
private transient String separatorString;
private transient String separatorString2;
private transient String escapeString;
private transient String endQuoteString;
private transient String endQuoteString2;
private transient String beginQuoteString;
private transient String beginQuoteString2;
private transient String sepAvaString;
private transient String sepTypeValString;
private transient String direction;
private transient boolean trimBlanks;
private transient boolean ignoreCase;
private transient boolean flat;
//elements of compound name
private transient VectorCompoundName with supplied Enumeration
* and Properties
*
* @param elements an enumeration of name elements, cannot be null
* @param props the properties, cannot be null but may be empty.
* If empty, the direction defaults to flat and no
* other properties are required.
*/
protected CompoundName(EnumerationCompoundName with supplied String
* and Properties, taking the supplied s and
* breaking it down into its elements.
*
* @param s a string containing the full compound name
* @param props the properties, cannot be null but may be empty for a flat name
* @throws InvalidNameException
* thrown if the supplied String s is invalid
* @throws NullPointerException
* thrown if the supplied String s is null
*/
public CompoundName(String s, Properties props) throws InvalidNameException {
if (null == s || null == props) {
throw new NullPointerException();
}
init(props);
parseName(s);
}
/**
* init instance variables
*/
private void init(Properties props) {
trimBlanks = false;
ignoreCase = false;
this.mySyntax = props;
String property;
//read property settings
// direction's default value is FLAT
direction = null == (property = props.getProperty(DIRECTION)) ? FLAT
: property;
//if direction value must equals to one of FLAT, LEFT_TO_RIGHT and RIGHT_TO_LEFT, exception threw
if (!LEFT_TO_RIGHT.equals(direction)
&& !RIGHT_TO_LEFT.equals(direction) && !FLAT.equals(direction)) {
// jndi.04=Illegal direction property value, which must be one of right_to_left, left_to_right or flat
throw new IllegalArgumentException(Messages.getString("jndi.04")); //$NON-NLS-1$
}
flat = FLAT.equals(direction);
separatorString = flat ? NULL_STRING : props.getProperty(SEPARATOR);
// if direction is not FLAT, separator must be set
if (null == separatorString && !flat) {
// jndi.05=jndi.syntax.separator property must be set when jndi.syntax.direction is not flat
throw new IllegalArgumentException(Messages.getString("jndi.05")); //$NON-NLS-1$
}
separatorString2 = (flat || null == (property = props
.getProperty(SEPARATOR2))) ? NULL_STRING : property;
//ignorecase default value is false
ignoreCase = null == (property = props.getProperty(IGNORE_CASE)) ? false
: Boolean.valueOf(property).booleanValue();
//trimblanks default value is false
trimBlanks = null == (property = props.getProperty(TRIM_BLANKS)) ? false
: Boolean.valueOf(property).booleanValue();
escapeString = null == (property = props.getProperty(ESCAPE)) ? NULL_STRING
: property;
beginQuoteString = null == (property = props.getProperty(BEGIN_QUOTE)) ? NULL_STRING
: property;
beginQuoteString2 = null == (property = props.getProperty(BEGIN_QUOTE2)) ? NULL_STRING
: property;
//end quote string default value is begin quote string
endQuoteString = null == (property = props.getProperty(END_QUOTE)) ? beginQuoteString
: property;
//begin quote string default value is end quote string
if (NULL_STRING.equals(beginQuoteString)) {
beginQuoteString = endQuoteString;
}
//end quote string2 default value is begin quote string2
endQuoteString2 = null == (property = props.getProperty(END_QUOTE2)) ? beginQuoteString2
: property;
//begin quote string2 default value is end quote string2
if (NULL_STRING.equals(beginQuoteString2)) {
beginQuoteString2 = endQuoteString2;
}
sepTypeValString = null == (property = props
.getProperty(SEPARATOR_TYPEVAL)) ? NULL_STRING : property;
sepAvaString = null == (property = props.getProperty(SEPARATOR_AVA)) ? NULL_STRING
: property;
}
/*
* parse name from string to elements
*/
private void parseName(String s) throws InvalidNameException {
this.elem = new VectorCompoundName.
* @param element the String to insert
* @param index the index of the element to insert - must be greater
* than or equal to 0 and less than size().
* @throws ArrayIndexOutOfBoundsException
* thrown when the index is invalid.
* @throws InvalidNameException
* thrown if the insertion of the element results in
* this CompoundName becoming invalid.
*/
public Name add(int index, String element) throws InvalidNameException {
if (element == null) {
// jndi.8C=component must not be null
throw new IllegalArgumentException(Messages.getString("jndi.8C")); //$NON-NLS-1$
}
if (FLAT.equals(direction) && (size() > 0)) {
// jndi.0A=A flat name can only have a single component
throw new InvalidNameException(Messages.getString("jndi.0A")); //$NON-NLS-1$
}
validateIndex(index, true);
elem.add(index, element);
return this;
}
/**
* Delete an element from this CompoundName.
*
* @return the deleted element
* @param index the index of the element to delete - must be greater
* than or equal to 0 and less than size().
* @throws ArrayIndexOutOfBoundsException
* thrown when the index is invalid.
* @throws InvalidNameException
* thrown if the deletion of the element results in
* this CompoundName becoming invalid.
*/
public Object remove(int index) throws InvalidNameException {
validateIndex(index, false);
return elem.remove(index);
}
@Override
public Object clone() {
return new CompoundName(getAll(), mySyntax);
}
public int size() {
return elem.size();
}
public boolean isEmpty() {
return elem.isEmpty();
}
public boolean startsWith(Name name) {
if (!(name instanceof CompoundName)) {
return false;
}
return equals(name, 0, name.size());
}
public boolean endsWith(Name name) {
if (!(name instanceof CompoundName)) {
return false;
}
return equals(name, this.size() - name.size(), name
.size());
}
/**
* preprocess string according to trimblank and ignorecase properties
*/
private String preProcess(String string, boolean caseInsensitive,
boolean removeBlanks) {
String result = string;
if (null != string && !"".equals(string)) { //$NON-NLS-1$
result = caseInsensitive ? result.toLowerCase() : result;
result = removeBlanks ? result.trim() : result;
}
return result;
}
/**
* Writes a serialized representation of the CompoundName. It starts with
* the properties, followed by an int which is the number of elements
* in the name, and is followed by a String for each element.
* @throws java.io.IOException if an error is encountered writing to the stream.
*/
private void writeObject(ObjectOutputStream oos) throws IOException {
oos.defaultWriteObject();
oos.writeObject(mySyntax);
oos.writeInt(elem.size());
for (int i = 0; i < elem.size(); i++) {
String element = elem.elementAt(i);
oos.writeObject(element);
}
}
/**
* Recreate a CompoundName from the data in the supplied stream.
* Additionally there are 2 protected fields which are not serializable.
* One of them is of a type which is a private class and cannot therefore
* be specified or implemented and so will be excluded from our deliverable.
* The one protected field which we can spec and implement is as follows:
* protected Properties mySyntax - The properties associated with a CompoundName.
*
* @throws java.io.IOException if an error is encountered reading from the stream.
* @throws ClassNotFoundException.
*/
private void readObject(ObjectInputStream ois)
throws ClassNotFoundException, IOException {
ois.defaultReadObject();
init(((Properties) ois.readObject()));
int size = ois.readInt();
elem = new VectorCompoundName with the one supplied as a param.
*
* See the definition of the equals() method to see how the
* direction, ignorecase and trimblanks properties affect the comparison of
* a CompoundName. Other than that the comparison is the same
* as that for a CompositeName.
o.
* a positive number means this is greater than the
* supplied Object o.
* zero means the two objects are equal.
* @param o the object to compare - cannot be null.
* @throws ClassCastException
* when o is not a compatible class that
* can be compared or if the object to compare
* o is null.
*/
public int compareTo(Object o) {
if (!(o instanceof CompoundName)) {
throw new ClassCastException();
}
int result = -1;
CompoundName otherName = (CompoundName) o;
EnumerationCompoundName by summing
* the hashcodes of all of its elements.
* * If jndi.syntax.trimblanks is set to true then remove any leading and * trailing blanks from the elements before calculating the hashcode.
** If jndi.syntax.ignorecase is set to true then use the lowercase version * of the element to calculate its hashcode.
* * @return the hashcode of this object. */ @Override public int hashCode() { int result = 0; EnumerationCompoundName.
*
* This is generated by concatenating the elements together with the
* separator string added as the separator between each of them. It may be
* necessary to add quotes and escape string to preserve the meaning. The
* resulting string should produce an equivalent CompoundName
* when used to create a new instance.
*
CompoundName.
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
String begin = NULL_STRING.equals(beginQuoteString) ? beginQuoteString2
: beginQuoteString;
String end = NULL_STRING.equals(endQuoteString) ? endQuoteString2
: endQuoteString;
String separator = NULL_STRING.equals(separatorString) ? separatorString2
: separatorString;
if(RIGHT_TO_LEFT.equals(direction)){
for (int i = elem.size() - 1; i >= 0; i--) {
addElement(sb, i, separator, begin, end);
}
}else{
for (int i = 0; i < elem.size(); i++) {
addElement(sb, i, separator, begin, end);
}
}
if (size() * separator.length() < sb.length()) {
//if the name contains non-empty element, delete the last separator char, which is abundant
sb.setLength(sb.length() - separator.length());
}
return sb.toString();
}
private void addElement(StringBuilder sb, int index, String separator, String begin, String end) {
String elemString = elem.get(index);
if (0 == elemString.length()) {
// if empty element, append a separator and continue
sb.append(separator);
return;
}
int pos = sb.length();
sb.append(elemString);
if (!NULL_STRING.equals(begin) && !NULL_STRING.equals(end)
&& !NULL_STRING.equals(separator)
&& (0 <= elemString.indexOf(separator))) {
// if contains separator string, quoted it
sb.insert(pos, begin);
pos += begin.length();
// if quoted, then every endquote char must be escaped
for (int i = 0, j = 0; 0 <= (j = elemString.indexOf(end, i)); i = j
+ end.length()) {
sb.insert(pos + j, escapeString);
pos += escapeString.length();
}
sb.append(end);
} else {
if (startsWithFromPos(elemString, 0, beginQuoteString)
|| startsWithFromPos(elemString, 0, beginQuoteString2)) {
// if not quoted and start with begin quote string, escape it
sb.insert(pos, escapeString);
pos += escapeString.length();
}
// if not quoted, escape all separator string and all escape string
for (int i = 0; i < elemString.length();) {
if (startsWithFromPos(elemString, i, separatorString)) {
sb.insert(pos + i, escapeString);
pos += escapeString.length();
i += separatorString.length();
} else if (startsWithFromPos(elemString, i, separatorString2)) {
sb.insert(pos + i, escapeString);
pos += escapeString.length();
i += separatorString2.length();
} else if (startsWithFromPos(elemString, i, escapeString)) {
sb.insert(pos + i, escapeString);
pos += escapeString.length();
i += escapeString.length();
} else {
i++;
}
}
}
sb.append(separator);
}
/**
* Check if the supplied object o is equal to this
* CompoundName.
*
* The supplied Object o may be null but that will cause
* false to be returned.
*
* The supplied Object o may be something other than a
* CompoundName but that will cause false to be returned.
*
* To be equal the supplied CompoundName must have the same
* number of elements and each element must match the corresponding element
* of this CompoundName. The properties
* jndi.syntax.ignorecase and jndi.syntax.trimblanks need to be considered
* if they have been set.
*
* The properties associated with the CompoundName must be
* taken into account but do not have to match. For example
* "home/jenningm-abc/.profile" with a direction of left to right is equal
* to ".profile/jenningm-abc/home" with a direction of right to left.
*
o is equals to this
* CompoundName, false otherwise
*/
@Override
public boolean equals(Object o) {
if (!(o instanceof CompoundName)) {
return false;
}
//compare size
CompoundName otherName = (CompoundName) o;
final int size = otherName.size();
if (size != this.size()) {
return false;
}
//compare every element
return equals(otherName, 0, size);
}
/**
* compare this name to the supplied name from position
* start to position start+
* length-1
*
*/
private boolean equals(Name name, int start, int length) {
if (length > this.size()) {
return false;
}
CompoundName otherName = (CompoundName) name;
Enumeration