/**
* Returns a key similar to the specified string, or {@code null}.
*
* @param key key to be found
* @return similar key
*/
public final synchronized String similar(final String key) {
final byte[] name = token(key);
final Levenshtein ls = new Levenshtein();
for (final String prop : props.keySet()) {
if (ls.similar(name, token(prop), 0)) return prop;
}
return null;
}
/**
* Retrieves the specified value. Throws an error if value cannot be read.
*
* @param key key
* @param c expected type
* @return result
*/
private Object get(final Object[] key, final Class<?> c) {
final Object entry = props.get(key[0].toString());
if (entry == null) Util.notexpected("Property " + key[0] + " not defined.");
final Class<?> cc = entry.getClass();
if (c != cc) Util.notexpected("Property '" + key[0] + "' is a " + Util.name(cc));
return entry;
}
@Override
public final synchronized String toString() {
final TokenBuilder tb = new TokenBuilder();
for (final Entry<String, Object> e : props.entrySet()) {
if (!tb.isEmpty()) tb.add(',');
tb.add(e.getKey()).add('=').addExt(e.getValue());
}
return tb.toString();
}
/** Constructor, initializing the default options. */
protected AProp() {
try {
for (final Field f : getClass().getFields()) {
final Object obj = f.get(null);
if (!(obj instanceof Object[])) continue;
final Object[] arr = (Object[]) obj;
props.put(arr[0].toString(), arr[1]);
}
} catch (final Exception ex) {
Util.notexpected(ex);
}
}
@SuppressWarnings("unchecked")
LDAPObjectHandler(final Class<T> type) throws LDAPPersistException {
this.type = type;
final Class<? super T> superclassType = type.getSuperclass();
if (superclassType == null) {
superclassHandler = null;
} else {
final LDAPObject superclassAnnotation = superclassType.getAnnotation(LDAPObject.class);
if (superclassAnnotation == null) {
superclassHandler = null;
} else {
superclassHandler = new LDAPObjectHandler(superclassType);
}
}
final TreeMap<String, FieldInfo> fields = new TreeMap<String, FieldInfo>();
final TreeMap<String, GetterInfo> getters = new TreeMap<String, GetterInfo>();
final TreeMap<String, SetterInfo> setters = new TreeMap<String, SetterInfo>();
ldapObject = type.getAnnotation(LDAPObject.class);
if (ldapObject == null) {
throw new LDAPPersistException(ERR_OBJECT_HANDLER_OBJECT_NOT_ANNOTATED.get(type.getName()));
}
final LinkedHashMap<String, String> objectClasses = new LinkedHashMap<String, String>(10);
final String oc = ldapObject.structuralClass();
if (oc.length() == 0) {
structuralClass = getUnqualifiedClassName(type);
} else {
structuralClass = oc;
}
final StringBuilder invalidReason = new StringBuilder();
if (PersistUtils.isValidLDAPName(structuralClass, invalidReason)) {
objectClasses.put(toLowerCase(structuralClass), structuralClass);
} else {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_INVALID_STRUCTURAL_CLASS.get(
type.getName(), structuralClass, invalidReason.toString()));
}
auxiliaryClasses = ldapObject.auxiliaryClass();
for (final String auxiliaryClass : auxiliaryClasses) {
if (PersistUtils.isValidLDAPName(auxiliaryClass, invalidReason)) {
objectClasses.put(toLowerCase(auxiliaryClass), auxiliaryClass);
} else {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_INVALID_AUXILIARY_CLASS.get(
type.getName(), auxiliaryClass, invalidReason.toString()));
}
}
superiorClasses = ldapObject.superiorClass();
for (final String superiorClass : superiorClasses) {
if (PersistUtils.isValidLDAPName(superiorClass, invalidReason)) {
objectClasses.put(toLowerCase(superiorClass), superiorClass);
} else {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_INVALID_SUPERIOR_CLASS.get(
type.getName(), superiorClass, invalidReason.toString()));
}
}
if (superclassHandler != null) {
for (final String s : superclassHandler.objectClassAttribute.getValues()) {
objectClasses.put(toLowerCase(s), s);
}
}
objectClassAttribute = new Attribute("objectClass", objectClasses.values());
final String parentDNStr = ldapObject.defaultParentDN();
try {
defaultParentDN = new DN(parentDNStr);
} catch (LDAPException le) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_INVALID_DEFAULT_PARENT.get(
type.getName(), parentDNStr, le.getMessage()),
le);
}
final String postDecodeMethodName = ldapObject.postDecodeMethod();
if (postDecodeMethodName.length() > 0) {
try {
postDecodeMethod = type.getDeclaredMethod(postDecodeMethodName);
postDecodeMethod.setAccessible(true);
} catch (Exception e) {
debugException(e);
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_INVALID_POST_DECODE_METHOD.get(
type.getName(), postDecodeMethodName, getExceptionMessage(e)),
e);
}
} else {
postDecodeMethod = null;
}
final String postEncodeMethodName = ldapObject.postEncodeMethod();
if (postEncodeMethodName.length() > 0) {
try {
postEncodeMethod = type.getDeclaredMethod(postEncodeMethodName, Entry.class);
postEncodeMethod.setAccessible(true);
} catch (Exception e) {
debugException(e);
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_INVALID_POST_ENCODE_METHOD.get(
type.getName(), postEncodeMethodName, getExceptionMessage(e)),
e);
}
} else {
postEncodeMethod = null;
}
try {
constructor = type.getDeclaredConstructor();
constructor.setAccessible(true);
} catch (Exception e) {
debugException(e);
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_NO_DEFAULT_CONSTRUCTOR.get(type.getName()), e);
}
Field tmpDNField = null;
Field tmpEntryField = null;
final LinkedList<FieldInfo> tmpRFilterFields = new LinkedList<FieldInfo>();
final LinkedList<FieldInfo> tmpAAFilterFields = new LinkedList<FieldInfo>();
final LinkedList<FieldInfo> tmpCAFilterFields = new LinkedList<FieldInfo>();
final LinkedList<FieldInfo> tmpRDNFields = new LinkedList<FieldInfo>();
for (final Field f : type.getDeclaredFields()) {
final LDAPField fieldAnnotation = f.getAnnotation(LDAPField.class);
final LDAPDNField dnFieldAnnotation = f.getAnnotation(LDAPDNField.class);
final LDAPEntryField entryFieldAnnotation = f.getAnnotation(LDAPEntryField.class);
if (fieldAnnotation != null) {
f.setAccessible(true);
final FieldInfo fieldInfo = new FieldInfo(f, type);
final String attrName = toLowerCase(fieldInfo.getAttributeName());
if (fields.containsKey(attrName)) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_ATTR_CONFLICT.get(type.getName(), fieldInfo.getAttributeName()));
} else {
fields.put(attrName, fieldInfo);
}
switch (fieldInfo.getFilterUsage()) {
case REQUIRED:
tmpRFilterFields.add(fieldInfo);
break;
case ALWAYS_ALLOWED:
tmpAAFilterFields.add(fieldInfo);
break;
case CONDITIONALLY_ALLOWED:
tmpCAFilterFields.add(fieldInfo);
break;
case EXCLUDED:
default:
break;
}
if (fieldInfo.includeInRDN()) {
tmpRDNFields.add(fieldInfo);
}
}
if (dnFieldAnnotation != null) {
f.setAccessible(true);
if (fieldAnnotation != null) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_CONFLICTING_FIELD_ANNOTATIONS.get(
type.getName(), "LDAPField", "LDAPDNField", f.getName()));
}
if (tmpDNField != null) {
throw new LDAPPersistException(ERR_OBJECT_HANDLER_MULTIPLE_DN_FIELDS.get(type.getName()));
}
final int modifiers = f.getModifiers();
if (Modifier.isFinal(modifiers)) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_DN_FIELD_FINAL.get(f.getName(), type.getName()));
} else if (Modifier.isStatic(modifiers)) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_DN_FIELD_STATIC.get(f.getName(), type.getName()));
}
final Class<?> fieldType = f.getType();
if (fieldType.equals(String.class)) {
tmpDNField = f;
} else {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_INVALID_DN_FIELD_TYPE.get(
type.getName(), f.getName(), fieldType.getName()));
}
}
if (entryFieldAnnotation != null) {
f.setAccessible(true);
if (fieldAnnotation != null) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_CONFLICTING_FIELD_ANNOTATIONS.get(
type.getName(), "LDAPField", "LDAPEntryField", f.getName()));
}
if (tmpEntryField != null) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_MULTIPLE_ENTRY_FIELDS.get(type.getName()));
}
final int modifiers = f.getModifiers();
if (Modifier.isFinal(modifiers)) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_ENTRY_FIELD_FINAL.get(f.getName(), type.getName()));
} else if (Modifier.isStatic(modifiers)) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_ENTRY_FIELD_STATIC.get(f.getName(), type.getName()));
}
final Class<?> fieldType = f.getType();
if (fieldType.equals(ReadOnlyEntry.class)) {
tmpEntryField = f;
} else {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_INVALID_ENTRY_FIELD_TYPE.get(
type.getName(), f.getName(), fieldType.getName()));
}
}
}
dnField = tmpDNField;
entryField = tmpEntryField;
requiredFilterFields = Collections.unmodifiableList(tmpRFilterFields);
alwaysAllowedFilterFields = Collections.unmodifiableList(tmpAAFilterFields);
conditionallyAllowedFilterFields = Collections.unmodifiableList(tmpCAFilterFields);
rdnFields = Collections.unmodifiableList(tmpRDNFields);
final LinkedList<GetterInfo> tmpRFilterGetters = new LinkedList<GetterInfo>();
final LinkedList<GetterInfo> tmpAAFilterGetters = new LinkedList<GetterInfo>();
final LinkedList<GetterInfo> tmpCAFilterGetters = new LinkedList<GetterInfo>();
final LinkedList<GetterInfo> tmpRDNGetters = new LinkedList<GetterInfo>();
for (final Method m : type.getDeclaredMethods()) {
final LDAPGetter getter = m.getAnnotation(LDAPGetter.class);
final LDAPSetter setter = m.getAnnotation(LDAPSetter.class);
if (getter != null) {
m.setAccessible(true);
if (setter != null) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_CONFLICTING_METHOD_ANNOTATIONS.get(
type.getName(), "LDAPGetter", "LDAPSetter", m.getName()));
}
final GetterInfo methodInfo = new GetterInfo(m, type);
final String attrName = toLowerCase(methodInfo.getAttributeName());
if (fields.containsKey(attrName) || getters.containsKey(attrName)) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_ATTR_CONFLICT.get(type.getName(), methodInfo.getAttributeName()));
} else {
getters.put(attrName, methodInfo);
}
switch (methodInfo.getFilterUsage()) {
case REQUIRED:
tmpRFilterGetters.add(methodInfo);
break;
case ALWAYS_ALLOWED:
tmpAAFilterGetters.add(methodInfo);
break;
case CONDITIONALLY_ALLOWED:
tmpCAFilterGetters.add(methodInfo);
break;
case EXCLUDED:
default:
// No action required.
break;
}
if (methodInfo.includeInRDN()) {
tmpRDNGetters.add(methodInfo);
}
}
if (setter != null) {
m.setAccessible(true);
final SetterInfo methodInfo = new SetterInfo(m, type);
final String attrName = toLowerCase(methodInfo.getAttributeName());
if (fields.containsKey(attrName) || setters.containsKey(attrName)) {
throw new LDAPPersistException(
ERR_OBJECT_HANDLER_ATTR_CONFLICT.get(type.getName(), methodInfo.getAttributeName()));
} else {
setters.put(attrName, methodInfo);
}
}
}
requiredFilterGetters = Collections.unmodifiableList(tmpRFilterGetters);
alwaysAllowedFilterGetters = Collections.unmodifiableList(tmpAAFilterGetters);
conditionallyAllowedFilterGetters = Collections.unmodifiableList(tmpCAFilterGetters);
rdnGetters = Collections.unmodifiableList(tmpRDNGetters);
if (rdnFields.isEmpty() && rdnGetters.isEmpty()) {
throw new LDAPPersistException(ERR_OBJECT_HANDLER_NO_RDN_DEFINED.get(type.getName()));
}
fieldMap = Collections.unmodifiableMap(fields);
getterMap = Collections.unmodifiableMap(getters);
setterMap = Collections.unmodifiableMap(setters);
final TreeSet<String> attrSet = new TreeSet<String>();
final TreeSet<String> lazySet = new TreeSet<String>();
if (ldapObject.requestAllAttributes()) {
attrSet.add("*");
attrSet.add("+");
} else {
for (final FieldInfo i : fields.values()) {
if (i.lazilyLoad()) {
lazySet.add(i.getAttributeName());
} else {
attrSet.add(i.getAttributeName());
}
}
for (final SetterInfo i : setters.values()) {
attrSet.add(i.getAttributeName());
}
}
attributesToRequest = new String[attrSet.size()];
attrSet.toArray(attributesToRequest);
lazilyLoadedAttributes = new String[lazySet.size()];
lazySet.toArray(lazilyLoadedAttributes);
}
ObjectClassDefinition constructObjectClass(
final String name, final String sup, final ObjectClassType type, final OIDAllocator a) {
final TreeMap<String, String> requiredAttrs = new TreeMap<String, String>();
final TreeMap<String, String> optionalAttrs = new TreeMap<String, String>();
for (final FieldInfo i : fieldMap.values()) {
boolean found = false;
for (final String s : i.getObjectClasses()) {
if (name.equalsIgnoreCase(s)) {
found = true;
break;
}
}
if (!found) {
continue;
}
final String attrName = i.getAttributeName();
final String lowerName = toLowerCase(attrName);
if (i.includeInRDN() || (i.isRequiredForDecode() && i.isRequiredForEncode())) {
requiredAttrs.put(lowerName, attrName);
} else {
optionalAttrs.put(lowerName, attrName);
}
}
for (final GetterInfo i : getterMap.values()) {
boolean found = false;
for (final String s : i.getObjectClasses()) {
if (name.equalsIgnoreCase(s)) {
found = true;
break;
}
}
if (!found) {
continue;
}
final String attrName = i.getAttributeName();
final String lowerName = toLowerCase(attrName);
if (i.includeInRDN()) {
requiredAttrs.put(lowerName, attrName);
} else {
optionalAttrs.put(lowerName, attrName);
}
}
if (name.equalsIgnoreCase(structuralClass)) {
for (final SetterInfo i : setterMap.values()) {
final String attrName = i.getAttributeName();
final String lowerName = toLowerCase(attrName);
if (requiredAttrs.containsKey(lowerName) || optionalAttrs.containsKey(lowerName)) {
continue;
}
optionalAttrs.put(lowerName, attrName);
}
}
final String[] reqArray = new String[requiredAttrs.size()];
requiredAttrs.values().toArray(reqArray);
final String[] optArray = new String[optionalAttrs.size()];
optionalAttrs.values().toArray(optArray);
return new ObjectClassDefinition(
a.allocateObjectClassOID(name),
new String[] {name},
null,
false,
new String[] {sup},
type,
reqArray,
optArray,
null);
}
/**
* Reads the configuration file and initializes the project properties. The file is located in the
* project home directory.
*
* @param prop property file extension
*/
protected synchronized void read(final String prop) {
file = new IOFile(HOME + IO.BASEXSUFFIX + prop);
final StringList read = new StringList();
final TokenBuilder err = new TokenBuilder();
if (!file.exists()) {
err.addExt("Saving properties in \"%\"..." + NL, file);
} else {
BufferedReader br = null;
try {
br = new BufferedReader(new FileReader(file.file()));
for (String line; (line = br.readLine()) != null; ) {
line = line.trim();
if (line.isEmpty() || line.charAt(0) == '#') continue;
final int d = line.indexOf('=');
if (d < 0) {
err.addExt("%: \"%\" ignored. " + NL, file, line);
continue;
}
final String val = line.substring(d + 1).trim();
String key = line.substring(0, d).trim();
// extract numeric value in key
int num = 0;
final int ss = key.length();
for (int s = 0; s < ss; ++s) {
if (Character.isDigit(key.charAt(s))) {
num = Integer.parseInt(key.substring(s));
key = key.substring(0, s);
break;
}
}
read.add(key);
final Object entry = props.get(key);
if (entry == null) {
err.addExt("%: \"%\" not found. " + NL, file, key);
} else if (entry instanceof String) {
props.put(key, val);
} else if (entry instanceof Integer) {
props.put(key, Integer.parseInt(val));
} else if (entry instanceof Boolean) {
props.put(key, Boolean.parseBoolean(val));
} else if (entry instanceof String[]) {
if (num == 0) {
props.put(key, new String[Integer.parseInt(val)]);
} else {
((String[]) entry)[num - 1] = val;
}
} else if (entry instanceof int[]) {
((int[]) entry)[num] = Integer.parseInt(val);
}
}
} catch (final Exception ex) {
err.addExt("% could not be parsed." + NL, file);
Util.debug(ex);
} finally {
if (br != null)
try {
br.close();
} catch (final IOException ex) {
}
}
}
// check if all mandatory files have been read
try {
if (err.isEmpty()) {
boolean ok = true;
for (final Field f : getClass().getFields()) {
final Object obj = f.get(null);
if (!(obj instanceof Object[])) continue;
final String key = ((Object[]) obj)[0].toString();
ok &= read.contains(key);
}
if (!ok) err.addExt("Saving properties in \"%\"..." + NL, file);
}
} catch (final IllegalAccessException ex) {
Util.notexpected(ex);
}
if (!err.isEmpty()) {
Util.err(err.toString());
write();
}
}
@Override
public final synchronized Iterator<String> iterator() {
return props.keySet().iterator();
}
/**
* Checks if the specified property has changed.
*
* @param key key
* @param val new value
* @return result of check
*/
public final synchronized boolean sameAs(final Object[] key, final Object val) {
return props.get(key[0].toString()).equals(val);
}
/**
* Assigns the specified object for the specified key.
*
* @param key key to be found
* @param val value to be written
*/
public final synchronized void setObject(final String key, final Object val) {
props.put(key, val);
finish();
}
/**
* Returns the requested object, or {@code null}.
*
* @param key key to be found
* @return value
*/
public final synchronized Object get(final String key) {
return props.get(key);
}
/** Writes the properties to disk. */
public final synchronized void write() {
final StringBuilder user = new StringBuilder();
BufferedReader br = null;
try {
// caches options specified by the user
if (file.exists()) {
br = new BufferedReader(new FileReader(file.file()));
for (String line; (line = br.readLine()) != null; ) {
if (line.equals(PROPUSER)) break;
}
for (String line; (line = br.readLine()) != null; ) {
user.append(line).append(NL);
}
}
} catch (final Exception ex) {
Util.debug(ex);
} finally {
if (br != null)
try {
br.close();
} catch (final IOException e) {
}
}
BufferedWriter bw = null;
try {
bw = new BufferedWriter(new FileWriter(file.file()));
bw.write(PROPHEADER + NL);
for (final Field f : getClass().getFields()) {
final Object obj = f.get(null);
if (!(obj instanceof Object[])) continue;
final String key = ((Object[]) obj)[0].toString();
final Object val = props.get(key);
if (val instanceof String[]) {
final String[] str = (String[]) val;
bw.write(key + " = " + str.length + NL);
final int is = str.length;
for (int i = 0; i < is; ++i) {
if (str[i] != null) bw.write(key + (i + 1) + " = " + str[i] + NL);
}
} else if (val instanceof int[]) {
final int[] num = (int[]) val;
final int ns = num.length;
for (int i = 0; i < ns; ++i) {
bw.write(key + i + " = " + num[i] + NL);
}
} else {
bw.write(key + " = " + val + NL);
}
}
bw.write(NL + PROPUSER + NL);
bw.write(user.toString());
} catch (final Exception ex) {
Util.errln("% could not be written.", file);
Util.debug(ex);
} finally {
if (bw != null)
try {
bw.close();
} catch (final IOException e) {
}
}
}
