org.apache.guacamole.net.auth

Interface Shareable<T>

Type Parameters:

T - The type of object which dictates the semantics/restrictions of shared objects.

All Known Subinterfaces:

ActiveConnection

All Known Implementing Classes:

AbstractActiveConnection

public interface Shareable<T>

An object which can be shared with others via specially-generated sets of credentials. It is expected, but not required, that these credentials are temporary.

Author:

Michael Jumper

Method Summary

Modifier and Type	Method and Description
UserCredentials	getSharingCredentials(String identifier) Returns a full set of credentials which can be used to authenticate as a user with access strictly to this object.

Method Detail

getSharingCredentials

UserCredentials getSharingCredentials(String identifier)
                               throws org.apache.guacamole.GuacamoleException

Returns a full set of credentials which can be used to authenticate as a user with access strictly to this object. The semantics and restrictions of the shared object (when accessed using the returned sharing credentials) are defined by the T associated with the given identifier and within the Directory<T> of the same UserContext that this Shareable was retrieved from.

Parameters:

identifier - The identifier of a T within the Directory<T> of the same UserContext that this Shareable was retrieved from.

Returns:

A full set of credentials which can be used to authenticate and obtain access to this object.

Throws:

org.apache.guacamole.GuacamoleException - If credentials could not be generated, or permission to share this object is denied.