Github user mike-jumper commented on a diff in the pull request:
https://github.com/apache/incubator-guacamole-client/pull/131#discussion_r107026057
--- Diff:
extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/DereferenceAliases.java
---
@@ -0,0 +1,71 @@
+/*
+ * 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.guacamole.auth.ldap;
+
+/**
+ * Acceptable values for configuring the dereferencing of aliases in
+ * talking to LDAP servers.
+ */
+public enum DereferenceAliases {
+
+ /**
+ * Never dereference aliases. This is the default.
+ */
+ NEVER(0),
+
+ /**
+ * Aliases are dereferenced below the base object, but not to locate
+ * the base object itself. So, if the base object is itself an alias
+ * the search will not complete.
+ */
+ SEARCHING(1),
+
+ /**
+ * Aliases are only dereferenced to locate the base object, but not
+ * after that. So, a search against a base object that is an alias
will
+ * find any subordinates of the real object the aliase references, but
+ * further aliases in the search will not be dereferenced.
+ */
+ FINDING(2),
+
+ /**
+ * Aliases will always be dereferenced, both to locate the base object
+ * and when handling results returned by the search.
+ */
+ ALWAYS(3);
+
+ /**
+ * The integer value that the enum represents, which is used in
--- End diff --
"The integer value that the enum represents" is vague, even with the added
context that it's used in configuring JLDAP. Ultimately all this says is that
it's a number that will be given to JLDAP; it doesn't describe the semantics
behind that number.
Should probably reference that this is the integer constant required by
`LDAPSearchConstraints` to define alias dereferencing behavior.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
