public abstract class SimpleAuthenticationProvider extends Object implements AuthenticationProvider
Constructor and Description |
---|
SimpleAuthenticationProvider() |
Modifier and Type | Method and Description |
---|---|
AuthenticatedUser |
authenticateUser(Credentials credentials)
Returns an AuthenticatedUser representing the user authenticated by the
given credentials, if any.
|
abstract Map<String,org.apache.guacamole.protocol.GuacamoleConfiguration> |
getAuthorizedConfigurations(Credentials credentials)
Given an arbitrary credentials object, returns a Map containing all
configurations authorized by those credentials.
|
UserContext |
getUserContext(AuthenticatedUser authenticatedUser)
Returns the UserContext of the user authenticated by the given
credentials.
|
AuthenticatedUser |
updateAuthenticatedUser(AuthenticatedUser authenticatedUser,
Credentials credentials)
Returns a new or updated AuthenticatedUser for the given credentials
already having produced the given AuthenticatedUser.
|
UserContext |
updateUserContext(UserContext context,
AuthenticatedUser authorizedUser,
Credentials credentials)
Returns a new or updated UserContext for the given AuthenticatedUser
already having the given UserContext.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getIdentifier
public abstract Map<String,org.apache.guacamole.protocol.GuacamoleConfiguration> getAuthorizedConfigurations(Credentials credentials) throws org.apache.guacamole.GuacamoleException
credentials
- The credentials to use to retrieve authorized
configurations.org.apache.guacamole.GuacamoleException
- If an error occurs while retrieving
configurations.public AuthenticatedUser authenticateUser(Credentials credentials) throws org.apache.guacamole.GuacamoleException
AuthenticationProvider
authenticateUser
in interface AuthenticationProvider
credentials
- The credentials to use for authentication.org.apache.guacamole.GuacamoleException
- If an error occurs while authenticating the user, or if access is
temporarily, permanently, or conditionally denied, such as if the
supplied credentials are insufficient or invalid.public UserContext getUserContext(AuthenticatedUser authenticatedUser) throws org.apache.guacamole.GuacamoleException
AuthenticationProvider
getUserContext
in interface AuthenticationProvider
authenticatedUser
- An AuthenticatedUser object representing the user authenticated by
an arbitrary set of credentials. The AuthenticatedUser may come from
this AuthenticationProvider or any other installed
AuthenticationProvider.org.apache.guacamole.GuacamoleException
- If an error occurs while creating the UserContext.public AuthenticatedUser updateAuthenticatedUser(AuthenticatedUser authenticatedUser, Credentials credentials) throws org.apache.guacamole.GuacamoleException
AuthenticationProvider
updateAuthenticatedUser
in interface AuthenticationProvider
authenticatedUser
- An AuthenticatedUser object representing the user authenticated by
an arbitrary set of credentials. The AuthenticatedUser may come from
this AuthenticationProvider or any other installed
AuthenticationProvider.credentials
- The credentials to use for authentication.org.apache.guacamole.GuacamoleException
- If an error occurs while updating the AuthenticatedUser.public UserContext updateUserContext(UserContext context, AuthenticatedUser authorizedUser, Credentials credentials) throws org.apache.guacamole.GuacamoleException
AuthenticationProvider
updateUserContext
in interface AuthenticationProvider
context
- The existing UserContext belonging to the user in question.authorizedUser
- An AuthenticatedUser object representing the user authenticated by
an arbitrary set of credentials. The AuthenticatedUser may come from
this AuthenticationProvider or any other installed
AuthenticationProvider.credentials
- The credentials which were most recently submitted. These are not
guaranteed to be the same as the credentials associated with the
AuthenticatedUser when they originally authenticated.org.apache.guacamole.GuacamoleException
- If an error occurs while updating the UserContext.Copyright © 2017. All rights reserved.