safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-06 05:07:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

GUAC-800: Clarify semantics of getAttributes() / setAttributes().

Browse Source
This commit is contained in:
Michael Jumper
2015-05-26 11:16:09 -07:00
parent 1e0f194126
commit b64c4f3b94
3 changed files with 24 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/Connection.java
View File

@@ -86,21 +86,23 @@ public interface Connection extends Identifiable, Connectable {
public void setConfiguration(GuacamoleConfiguration config); public void setConfiguration(GuacamoleConfiguration config);
/** /**
* Returns all attributes associated with this connection. * Returns all attributes associated with this connection. The returned map
* may not be modifiable.
* *
* @return * @return
* A map of all attribute identifiers to their corresponding values, * A map of all attribute identifiers to their corresponding values,
* for all attributes associated with this connection. * for all attributes associated with this connection, which may not be
* modifiable.
*/ */
Map<String, String> getAttributes(); Map<String, String> getAttributes();
/** /**
* Replaces all attributes associated with this connection with the * Sets the given attributes. If an attribute within the map is not
* attributes in the given map. * supported, it will simply be dropped. Any attributes not within the
* given map will be left untouched.
* *
* @param attributes * @param attributes
* A map of all attribute identifiers to their corresponding values, * A map of all attribute identifiers to their corresponding values.
* for all attributes associated with this connection.
*/ */
void setAttributes(Map<String, String> attributes); void setAttributes(Map<String, String> attributes);

14
guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/ConnectionGroup.java
View File

@@ -130,21 +130,23 @@ public interface ConnectionGroup extends Identifiable, Connectable {
throws GuacamoleException; throws GuacamoleException;
/** /**
* Returns all attributes associated with this connection group. * Returns all attributes associated with this connection group. The
* returned map may not be modifiable.
* *
* @return * @return
* A map of all attribute identifiers to their corresponding values, * A map of all attribute identifiers to their corresponding values,
* for all attributes associated with this connection group. * for all attributes associated with this connection group, which may
* not be modifiable.
*/ */
Map<String, String> getAttributes(); Map<String, String> getAttributes();
/** /**
* Replaces all attributes associated with this connection group with the * Sets the given attributes. If an attribute within the map is not
* attributes in the given map. * supported, it will simply be dropped. Any attributes not within the
* given map will be left untouched.
* *
* @param attributes * @param attributes
* A map of all attribute identifiers to their corresponding values, * A map of all attribute identifiers to their corresponding values.
* for all attributes associated with this connection group.
*/ */
void setAttributes(Map<String, String> attributes); void setAttributes(Map<String, String> attributes);

14
guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/User.java
View File

@@ -53,21 +53,23 @@ public interface User extends Identifiable {
public void setPassword(String password); public void setPassword(String password);
/** /**
* Returns all attributes associated with this user. * Returns all attributes associated with this user. The returned map may
* not be modifiable.
* *
* @return * @return
* A map of all attribute identifiers to their corresponding values, * A map of all attribute identifiers to their corresponding values,
* for all attributes associated with this user. * for all attributes associated with this user, which may not be
* modifiable.
*/ */
Map<String, String> getAttributes(); Map<String, String> getAttributes();
/** /**
* Replaces all attributes associated with this user with the attributes in * Sets the given attributes. If an attribute within the map is not
* the given map. * supported, it will simply be dropped. Any attributes not within the
* given map will be left untouched.
* *
* @param attributes * @param attributes
* A map of all attribute identifiers to their corresponding values, * A map of all attribute identifiers to their corresponding values.
* for all attributes associated with this user.
*/ */
void setAttributes(Map<String, String> attributes); void setAttributes(Map<String, String> attributes);