mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-06 13:17:41 +00:00
GUACAMOLE-234: Clean up comments.
This commit is contained in:
committed by
Virtually Nick
parent
5777d93fdc
commit
41e3b8ca56
@@ -58,12 +58,14 @@ public class LDAPConnectionService {
|
||||
private ConfigurationService confService;
|
||||
|
||||
/**
|
||||
* Creates a new instance of LDAPConnection, configured as required to use
|
||||
* whichever encryption method is requested within guacamole.properties.
|
||||
* Creates a new instance of LdapNetworkConnection, configured as required
|
||||
* to use whichever encryption method is requested within
|
||||
* guacamole.properties.
|
||||
*
|
||||
* @return
|
||||
* A new LDAPConnection instance which has already been configured to
|
||||
* use the encryption method requested within guacamole.properties.
|
||||
* A new LdapNetworkConnection instance which has already been
|
||||
* configured to use the encryption method requested within
|
||||
* guacamole.properties.
|
||||
*
|
||||
* @throws GuacamoleException
|
||||
* If an error occurs while parsing guacamole.properties, or if the
|
||||
@@ -91,7 +93,7 @@ public class LDAPConnectionService {
|
||||
// LDAP + STARTTLS
|
||||
case STARTTLS:
|
||||
logger.debug("Connecting to LDAP server using STARTTLS.");
|
||||
return new LdapNetworkConnection(host, port, false);
|
||||
return new LdapNetworkConnection(host, port);
|
||||
|
||||
// The encryption method, though known, is not actually
|
||||
// implemented. If encountered, this would be a bug.
|
||||
@@ -122,7 +124,7 @@ public class LDAPConnectionService {
|
||||
public LdapConnection bindAs(Dn userDN, String password)
|
||||
throws GuacamoleException {
|
||||
|
||||
// Obtain appropriately-configured LdapConnection instance
|
||||
// Obtain appropriately-configured LdapNetworkConnection instance
|
||||
LdapNetworkConnection ldapConnection = createLDAPConnection();
|
||||
|
||||
try {
|
||||
@@ -171,7 +173,7 @@ public class LDAPConnectionService {
|
||||
* The LDAP URL to follow.
|
||||
*
|
||||
* @param ldapConfig
|
||||
* The connection config to use to retrieve username and
|
||||
* The connection configuration to use to retrieve username and
|
||||
* password.
|
||||
*
|
||||
* @param hop
|
||||
|
@@ -284,7 +284,8 @@ public class ConfigurationService {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the maximum number of referral hops to follow.
|
||||
* Returns the maximum number of referral hops to follow. By default
|
||||
* a maximum of 5 hops is allowed.
|
||||
*
|
||||
* @return
|
||||
* The maximum number of referral hops to follow
|
||||
@@ -338,7 +339,8 @@ public class ConfigurationService {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns names for custom LDAP user attributes.
|
||||
* Returns names for custom LDAP user attributes. By default no
|
||||
* attributes will be returned.
|
||||
*
|
||||
* @return
|
||||
* Custom LDAP user attributes as configured in guacamole.properties.
|
||||
|
@@ -26,8 +26,8 @@ import org.apache.guacamole.properties.GuacamoleProperty;
|
||||
|
||||
/**
|
||||
* A GuacamoleProperty with a value of AliasDerefMode. The possible strings
|
||||
* "never", "searching", "finding", and "always" are mapped to their values as a
|
||||
* AliasDerefMode object. Anything else results in a parse error.
|
||||
* "never", "searching", "finding", and "always" are mapped to their values as
|
||||
* an AliasDerefMode object. Anything else results in a parse error.
|
||||
*/
|
||||
public abstract class DereferenceAliasesProperty implements GuacamoleProperty<AliasDerefMode> {
|
||||
|
||||
|
@@ -27,7 +27,8 @@ import org.apache.guacamole.properties.GuacamoleProperty;
|
||||
|
||||
/**
|
||||
* A GuacamoleProperty that converts a string to a Dn that can be used
|
||||
* in LDAP connections.
|
||||
* in LDAP connections. An exception is thrown if the provided DN is invalid
|
||||
* and cannot be parsed.
|
||||
*/
|
||||
public abstract class LdapDnGuacamoleProperty implements GuacamoleProperty<Dn> {
|
||||
|
||||
|
@@ -27,9 +27,10 @@ import org.apache.guacamole.GuacamoleServerException;
|
||||
import org.apache.guacamole.properties.GuacamoleProperty;
|
||||
|
||||
/**
|
||||
* A GuacamoleProperty with a value of AliasDerefMode. The possible strings
|
||||
* "never", "searching", "finding", and "always" are mapped to their values as a
|
||||
* AliasDerefMode object. Anything else results in a parse error.
|
||||
* A GuacamoleProperty with a value of an ExprNode query filter. The string
|
||||
* provided is passed through the FilterParser returning the ExprNode object,
|
||||
* or an exception is thrown if the filter is invalid and cannot be correctly
|
||||
* parsed.
|
||||
*/
|
||||
public abstract class LdapFilterGuacamoleProperty implements GuacamoleProperty<ExprNode> {
|
||||
|
||||
|
@@ -102,7 +102,7 @@ public class LDAPUserContext extends AbstractUserContext {
|
||||
|
||||
/**
|
||||
* Initializes this UserContext using the provided AuthenticatedUser and
|
||||
* LDAPConnection.
|
||||
* LdapConnection.
|
||||
*
|
||||
* @param user
|
||||
* The AuthenticatedUser representing the user that authenticated. This
|
||||
|
Reference in New Issue
Block a user