| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| package org.apache.guacamole.net.auth; |
| |
| import java.util.Date; |
| import java.util.List; |
| import java.util.Set; |
| import org.apache.guacamole.GuacamoleException; |
| import org.apache.guacamole.protocol.GuacamoleConfiguration; |
| |
| /** |
| * Represents a pairing of a GuacamoleConfiguration with a unique, |
| * human-readable identifier, and abstracts the connection process. The |
| * backing GuacamoleConfiguration may be intentionally obfuscated or tokenized |
| * to protect sensitive configuration information. |
| */ |
| public interface Connection extends Identifiable, Connectable, Attributes { |
| |
| /** |
| * Returns the name assigned to this Connection. |
| * @return The name assigned to this Connection. |
| */ |
| public String getName(); |
| |
| /** |
| * Sets the name assigned to this Connection. |
| * |
| * @param name The name to assign. |
| */ |
| public void setName(String name); |
| |
| /** |
| * Returns the unique identifier of the parent ConnectionGroup for |
| * this Connection. |
| * |
| * @return The unique identifier of the parent ConnectionGroup for |
| * this Connection. |
| */ |
| public String getParentIdentifier(); |
| |
| /** |
| * Sets the unique identifier of the parent ConnectionGroup for |
| * this Connection. |
| * |
| * @param parentIdentifier The unique identifier of the parent |
| * ConnectionGroup for this Connection. |
| */ |
| public void setParentIdentifier(String parentIdentifier); |
| |
| /** |
| * Returns the GuacamoleConfiguration associated with this Connection. Note |
| * that because configurations may contain sensitive information, some data |
| * in this configuration may be omitted or tokenized. |
| * |
| * @return The GuacamoleConfiguration associated with this Connection. |
| */ |
| public GuacamoleConfiguration getConfiguration(); |
| |
| /** |
| * Sets the GuacamoleConfiguration associated with this Connection. |
| * |
| * @param config The GuacamoleConfiguration to associate with this |
| * Connection. |
| */ |
| public void setConfiguration(GuacamoleConfiguration config); |
| |
| /** |
| * Returns the date and time that this connection was last used. If the |
| * connection was never used, the time that the connection was last used is |
| * unknown, or this information is not visible to the current user, this |
| * may be null. |
| * |
| * @return |
| * The date and time this connection was last used, or null if this |
| * information is unavailable or inapplicable. |
| */ |
| Date getLastActive(); |
| |
| /** |
| * Returns a list of ConnectionRecords representing the usage history |
| * of this Connection, including any active users. ConnectionRecords |
| * in this list will be sorted in descending order of end time (active |
| * connections are first), and then in descending order of start time |
| * (newer connections are first). |
| * |
| * @return A list of ConnectionRecrods representing the usage history |
| * of this Connection. |
| * |
| * @throws GuacamoleException If an error occurs while reading the history |
| * of this connection, or if permission is |
| * denied. |
| */ |
| public List<? extends ConnectionRecord> getHistory() throws GuacamoleException; |
| |
| /** |
| * Returns identifiers of all readable sharing profiles that can be used to |
| * join this connection when it is active. The level of access granted to a |
| * joining user is dictated by the connection parameters associated with |
| * the sharing profile, not necessarily the parameters of the primary |
| * connection being joined. |
| * |
| * @return |
| * A Set of identifiers representing the sharing profiles for this |
| * connection. |
| * |
| * @throws GuacamoleException |
| * If an error occurs while fetching the sharing profiles for this |
| * connection. |
| */ |
| public Set<String> getSharingProfileIdentifiers() throws GuacamoleException; |
| |
| } |