You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by vn...@apache.org on 2019/01/05 03:07:08 UTC
[03/10] guacamole-website git commit: Add links to documentation
where applicable.
Add links to documentation where applicable.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-website/commit/26d79b03
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-website/tree/26d79b03
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-website/diff/26d79b03
Branch: refs/heads/master
Commit: 26d79b03a48b321079ae196d6de9a82413528b22
Parents: 6f785e1
Author: Michael Jumper <mj...@apache.org>
Authored: Fri Jan 4 10:42:20 2019 -0800
Committer: Michael Jumper <mj...@apache.org>
Committed: Fri Jan 4 11:57:28 2019 -0800
----------------------------------------------------------------------
_releases/1.0.0.md | 134 +++++++++++++++++++++++++++---------------------
1 file changed, 76 insertions(+), 58 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-website/blob/26d79b03/_releases/1.0.0.md
----------------------------------------------------------------------
diff --git a/_releases/1.0.0.md b/_releases/1.0.0.md
index 08f33cc..111dc60 100644
--- a/_releases/1.0.0.md
+++ b/_releases/1.0.0.md
@@ -196,10 +196,10 @@ matches.
### Support for configuring Guacamole with environment variables
Support has been added for specifying any of the properties supported in the
-`GUACAMOLE_HOME/guacamole.properties` file by setting environment variables
-that correspond to those properties. The name of the environment variable for
-any particular property is the name of the property in uppercase with all
-dashes replaced with underscores.
+[`GUACAMOLE_HOME/guacamole.properties`](/doc/1.0.0/gug/configuring-guacamole.html#initial-setup)
+file by setting environment variables that correspond to those properties. The
+name of the environment variable for any particular property is the name of the
+property in uppercase with all dashes replaced with underscores.
For security reasons, the `enable-environment-properties` property must be set
to `true` for reading of properties from environment variables to be enabled.
@@ -378,9 +378,9 @@ that method.
### Incorrect documentation for RDP `load-balance-info` parameter
-The `load-balance-info` parameter was incorrectly documented as
-`load-balancing-info`. The correct parameter name is indeed
-`load-balance-info`. This has been fixed in the documentation.
+The [`load-balance-info` parameter](/doc/1.0.0/gug/configuring-guacamole.html#rdp-connection-broker)
+was incorrectly documented as `load-balancing-info`. The correct parameter name
+is indeed `load-balance-info`. This has been fixed in the documentation.
* [GUACAMOLE-427](https://issues.apache.org/jira/browse/GUACAMOLE-427) - RDP "load-balance-info" parameter incorrectly documented
@@ -432,9 +432,11 @@ extensions easier and more consistent. The error status codes sent by the REST
API are now derived from the exceptions thrown, allowing extensions to control
the exact code sent. Dependency precedence has been updated so that extensions
always see the classes they bundle, even if the web application bundles a
-different version of the same class. Base implementations of `UserContext` and
-`AuthenticationProvider` interfaces have been provided, removing the need to
-fully implement these interfaces when writing an extension.
+different version of the same class. Base implementations of the
+[`UserContext`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/UserContext.html)
+and [`AuthenticationProvider`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AuthenticationProvider.html)
+interfaces have been provided, removing the need to fully implement these
+interfaces when writing an extension.
* [GUACAMOLE-499](https://issues.apache.org/jira/browse/GUACAMOLE-499) - REST API Error Codes should come from GuacamoleStatus
* [GUACAMOLE-541](https://issues.apache.org/jira/browse/GUACAMOLE-541) - Webapp dependencies take precedence over bundled extension dependencies
@@ -491,8 +493,8 @@ required to support those within the database modules (including the
Users of any of the database authentication modules will need to run the
`upgrade-pre-1.0.0.sql` script specific to their chosen database as part
of the move from earlier versions of Guacamole to 1.0.0. More thorough
-instructions for this process can be found in the [`JDBC Authentication`]
-(http://guacamole.apache.org/doc/gug/jdbc-auth.html) documentation.
+instructions for this process can be found in the
+[database authentication documentation](/doc/gug/jdbc-auth.html).
Hostname logging within database
--------------------------------
@@ -543,18 +545,21 @@ Extension API changes
### Support for user groups
As noted above, one of the major changes in this release is the addition of
-support for user groups. These changes center around the new `UserGroup`
+support for user groups. These changes center around the new
+[`UserGroup`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/UserGroup.html)
interface and functions for accessing instances of that interface. Note that if
-you are using the abstract base classes `AbstractUserContext` and
-`AbstractUser`, little to no changes will be necessary as default
-implementations of the required new functions have been provided.
+you are using the abstract base classes [`AbstractUserContext`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AbstractUserContext.html)
+and [`AbstractUser`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AbstractUser.html),
+little to no changes will be necessary as default implementations of the
+required new functions have been provided.
#### Retrieval of user groups
-The `UserContext` interface now defines a
-`getUserGroupDirectory()` function which returns a `Directory<UserGroup>`
+The [`UserContext`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/UserContext.html)
+interface now defines a [`getUserGroupDirectory()`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/UserContext.html#getUserGroupDirectory--)
+function which returns a [`Directory<UserGroup>`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/Directory.html)
providing access to all user groups. If your extension does not provide user
-groups, it can simply return an empty `SimpleDirectory<UserGroup>`:
+groups, it can simply return an empty [`SimpleDirectory<UserGroup>`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleDirectory.html):
@Override
public Object getUserGroupDirectory() {
@@ -564,10 +569,12 @@ groups, it can simply return an empty `SimpleDirectory<UserGroup>`:
#### Effective group membership
To allow extensions to take group membership into account, even when that
-membership is dictated by a different extension, the `AuthenticatedUser` class
-now defines `getEffectiveGroups()` function. This function should return the
-identifiers of all user groups that apply to the current user. If support for
-user groups is not implemented by the extension, simply return an empty set of strings:
+membership is dictated by a different extension, the
+[`AuthenticatedUser`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AuthenticatedUser.html)
+class now defines a [`getEffectiveGroups()`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AuthenticatedUser.html#getEffectiveUserGroups--)
+function. This function should return the identifiers of all user groups that
+apply to the current user. If support for user groups is not implemented by the
+extension, simply return an empty set of strings:
@Override
public Set<String> getEffectiveUserGroups() {
@@ -576,12 +583,13 @@ user groups is not implemented by the extension, simply return an empty set of s
#### Effective permissions
-The `User` interface now provides a `getEffectivePermissions()` function which
-should return an implementation of `Permissions` which exposes the permissions
-that apply to the user, including permissions which may be inherited through
-group membership. If inheritence of permissions is not implemented by your
-extension, this function can simply return `this` (as `User` extends
-`Permissions`):
+The [`User`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/User.html)
+interface now provides a [`getEffectivePermissions()`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/User.html#getEffectivePermissions--)
+function which should return an implementation of [`Permissions`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/Permissions.html)
+which exposes the permissions that apply to the user, including permissions
+which may be inherited through group membership. If inheritance of permissions
+is not implemented by your extension, this function can simply return `this`
+(as `User` extends `Permissions`):
@Override
public Permissions getEffectivePermissions() {
@@ -590,14 +598,17 @@ extension, this function can simply return `this` (as `User` extends
#### Exposing group membership
-The `User` and `UserGroup` interfaces provide multiple functions for retrieving
-parent groups and child objects, if applicable. Existing implementations of the
-`User` interface which do not extend `AbstractUser` will need to implement
-`getUserGroups()`, a function which retrieves the immediate parent groups of
-the user. The returned `RelatedObjectSet` should allow for manipulation of the
-group relationship if the extension allows such manipulation (and if the
-current user has permission to do so). Extensions which do not implement user
-groups can simply return an empty set:
+The [`User`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/User.html)
+and [`UserGroup`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/UserGroup.html)
+interfaces provide multiple functions for retrieving parent groups and child
+objects, if applicable. Existing implementations of the `User` interface which
+do not extend [`AbstractUser`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AbstractUser.html)
+will need to implement [`getUserGroups()`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/User.html#getUserGroups--),
+a function which retrieves the immediate parent groups of the user. The
+returned [`RelatedObjectSet`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/RelatedObjectSet.html)
+should allow for manipulation of the group relationship if the extension allows
+such manipulation (and if the current user has permission to do so). Extensions
+which do not implement user groups can simply return an empty set:
@Override
public RelatedObjectSet getUserGroups() {
@@ -606,20 +617,23 @@ groups can simply return an empty set:
### The new decoration API
-The `AuthenticationProvider` interface now defines `decorate()` and `redecorate()`
+The [`AuthenticationProvider`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AuthenticationProvider.html)
+interface now defines [`decorate()`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AuthenticationProvider.html#decorate-org.apache.guacamole.net.auth.UserContext-org.apache.guacamole.net.auth.AuthenticatedUser-org.apache.guacamole.net.auth.Credentials-)
+and [`redecorate()`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AuthenticationProvider.html#redecorate-org.apache.guacamole.net.auth.UserContext-org.apache.guacamole.net.auth.UserContext-org.apache.guacamole.net.auth.AuthenticatedUser-org.apache.guacamole.net.auth.Credentials-)
functions which allow an implementation of `AuthenticationProvider` to decorate the
-`UserContext` instances of other extensions. After an extension returns a
-`UserContext` instance, the `decorate()` (if the `UserContext` is for a new
-session) or `redecorate()` (if the `UserContext` has been updated for an
-existing session) functions of all other extensions are invoked to give those
-extensions a chance to wrap the `UserContext`. This allows extensions to add
-functionality to the objects of other extensions which may not otherwise be
-possible.
-
-Implementations of `AuthenticationProvider` which extend `AbstractAuthenticationProvider` need not
-implement these functions as default implementations are provided.
-Implementations which do not extend `AbstractAuthenticationProvider` and which do not
-decorate the `UserContext` of other extensions should simply return the
+[`UserContext`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/UserContext.html)
+instances of other extensions. After an extension returns a `UserContext`
+instance, the `decorate()` (if the `UserContext` is for a new session) or
+`redecorate()` (if the `UserContext` has been updated for an existing session)
+functions of all other extensions are invoked to give those extensions a chance
+to wrap the `UserContext`. This allows extensions to add functionality to the
+objects of other extensions which may not otherwise be possible.
+
+Implementations of `AuthenticationProvider` which extend
+[`AbstractAuthenticationProvider`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/AbstractAuthenticationProvider.html)
+need not implement these functions as default implementations are provided.
+Implementations which do not extend `AbstractAuthenticationProvider` and which
+do not decorate the `UserContext` of other extensions should simply return the
original `UserContext`:
@Override
@@ -640,10 +654,13 @@ TODO
### Deprecation of `SimpleUserDirectory`, `SimpleConnectionDirectory`, and `SimpleConnectionGroupDirectory` classes
-The `SimpleUserDirectory`, `SimpleConnectionDirectory`, and
-`SimpleConnectionGroupDirectory` classes have been deprecated in favor of the
-`SimpleDirectory<T>` class. These classes can still be used, but will result in
-deprecation warnings, and will be removed in a future release.
+The [`SimpleUserDirectory`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUaweDirectory.html),
+[`SimpleConnectionDirectory`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnectionDirectory.html),
+and [`SimpleConnectionGroupDirectory`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnectionGroupDirectory.html)
+classes have been deprecated in favor of the
+[`SimpleDirectory<T>`](/doc/1.0.0/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleDirectory.html)
+class. These classes can still be used, but will result in deprecation
+warnings, and will be removed in a future release.
### Deprecation of `SimpleUser` convenience constructors
@@ -658,7 +675,7 @@ TODO
### `GUAC_INSTRUCTION_MAX_ELEMENTS` macro definition changed
-TODO (Affects size of `guac_parser` as well as any code referencing that macro)
+TODO (Affects size of [`guac_parser`](/doc/1.0.0/libguac/structguac__parser.html) as well as any code referencing that macro)
Java API (guacamole-common) changes
-----------------------------------
@@ -681,9 +698,10 @@ TODO
### Addition of `Guacamole.Tunnel.State.UNSTABLE` state
In order to support changes to detecting and handling network problems within
-the Guacamole connections, another tunnel state, `UNSTABLE`, has been added.
-The tunnel enters this state when it is still technically connected but the
-network connection appears unstable and may result in disconnection.
+the Guacamole connections, another tunnel state,
+`Guacamole.Tunnel.State.UNSTABLE`, has been added. The tunnel enters this
+state when it is still technically connected but the network connection appears
+unstable and may result in disconnection.
Code which handles changes in tunnel state may need to be updated to take this
additional state into account if it does not currently ignore unknown states,