mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-06 21:27:40 +00:00
GUACAMOLE-495: Merge remove parts of the API which have been deprecated for sufficiently long.
This commit is contained in:
Nick Couchman
@@ -350,31 +350,6 @@ Guacamole.Client = function(tunnel) {
|
|||||||
tunnel.sendMessage("mouse", Math.floor(mouseState.x), Math.floor(mouseState.y), buttonMask);
|
tunnel.sendMessage("mouse", Math.floor(mouseState.x), Math.floor(mouseState.y), buttonMask);
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the clipboard of the remote client to the given text data.
|
|
||||||
*
|
|
||||||
* @deprecated Use createClipboardStream() instead.
|
|
||||||
* @param {String} data The data to send as the clipboard contents.
|
|
||||||
*/
|
|
||||||
this.setClipboard = function(data) {
|
|
||||||
|
|
||||||
// Do not send requests if not connected
|
|
||||||
if (!isConnected())
|
|
||||||
return;
|
|
||||||
|
|
||||||
// Open stream
|
|
||||||
var stream = guac_client.createClipboardStream("text/plain");
|
|
||||||
var writer = new Guacamole.StringWriter(stream);
|
|
||||||
|
|
||||||
// Send text chunks
|
|
||||||
for (var i=0; i<data.length; i += 4096)
|
|
||||||
writer.sendText(data.substring(i, i+4096));
|
|
||||||
|
|
||||||
// Close stream
|
|
||||||
writer.sendEnd();
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Allocates an available stream index and creates a new
|
* Allocates an available stream index and creates a new
|
||||||
* Guacamole.OutputStream using that index, associating the resulting
|
* Guacamole.OutputStream using that index, associating the resulting
|
||||||
|
|||||||
@@ -1,96 +0,0 @@
|
|||||||
/*
|
|
||||||
* 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.servlet;
|
|
||||||
|
|
||||||
import javax.servlet.http.HttpSession;
|
|
||||||
import org.apache.guacamole.net.GuacamoleTunnel;
|
|
||||||
import org.slf4j.Logger;
|
|
||||||
import org.slf4j.LoggerFactory;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Provides abstract access to the tunnels associated with a Guacamole session.
|
|
||||||
*/
|
|
||||||
@Deprecated
|
|
||||||
public class GuacamoleSession {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Logger for this class.
|
|
||||||
*/
|
|
||||||
private final Logger logger = LoggerFactory.getLogger(GuacamoleSession.class);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates a new GuacamoleSession. In prior versions of Guacamole, the
|
|
||||||
* GuacamoleSession object stored the tunnels associated with a particular
|
|
||||||
* user's use of the HTTP tunnel. The HTTP tunnel now stores all of these
|
|
||||||
* tunnels itself, and thus this class is no longer necessary. Its use will
|
|
||||||
* result in a warning being logged, and its functions will have no effect.
|
|
||||||
*
|
|
||||||
* @param session
|
|
||||||
* The HttpSession that older versions of Guacamole would use as tunnel
|
|
||||||
* storage. This parameter is now ignored, and the GuacamoleSession
|
|
||||||
* class overall is deprecated.
|
|
||||||
*/
|
|
||||||
public GuacamoleSession(HttpSession session) {
|
|
||||||
logger.warn("GuacamoleSession is deprecated. It is no longer "
|
|
||||||
+ "necessary and its use will have no effect.");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Attaches the given tunnel to this GuacamoleSession. The GuacamoleSession
|
|
||||||
* class is now deprecated, and this function has no effect.
|
|
||||||
*
|
|
||||||
* @param tunnel
|
|
||||||
* The tunnel to attach to this GucacamoleSession.
|
|
||||||
*/
|
|
||||||
public void attachTunnel(GuacamoleTunnel tunnel) {
|
|
||||||
// Deprecated - no effect
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Detaches the given tunnel to this GuacamoleSession. The GuacamoleSession
|
|
||||||
* class is now deprecated, and this function has no effect.
|
|
||||||
*
|
|
||||||
* @param tunnel
|
|
||||||
* The tunnel to detach to this GucacamoleSession.
|
|
||||||
*/
|
|
||||||
public void detachTunnel(GuacamoleTunnel tunnel) {
|
|
||||||
// Deprecated - no effect
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the tunnel with the given UUID attached to this GuacamoleSession,
|
|
||||||
* if any. The GuacamoleSession class is now deprecated, and this function
|
|
||||||
* has no effect. It will ALWAYS return null.
|
|
||||||
*
|
|
||||||
* @param tunnelUUID
|
|
||||||
* The UUID of an attached tunnel.
|
|
||||||
*
|
|
||||||
* @return
|
|
||||||
* The tunnel corresponding to the given UUID, if attached, or null if
|
|
||||||
* if no such tunnel is attached.
|
|
||||||
*/
|
|
||||||
public GuacamoleTunnel getTunnel(String tunnelUUID) {
|
|
||||||
|
|
||||||
// Deprecated - no effect
|
|
||||||
return null;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
/*
|
|
||||||
* 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.properties;
|
|
||||||
|
|
||||||
import java.io.File;
|
|
||||||
import org.slf4j.Logger;
|
|
||||||
import org.slf4j.LoggerFactory;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Abstract representation of the Guacamole configuration directory.
|
|
||||||
*
|
|
||||||
* @deprecated
|
|
||||||
*/
|
|
||||||
public class GuacamoleHome {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Logger for this class.
|
|
||||||
*/
|
|
||||||
private static final Logger logger = LoggerFactory.getLogger(GuacamoleHome.class);
|
|
||||||
|
|
||||||
static {
|
|
||||||
// Warn about deprecation
|
|
||||||
logger.warn("GuacamoleHome is deprecated. Please use Environment instead.");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* GuacamoleHome is a utility class and cannot be instantiated.
|
|
||||||
*/
|
|
||||||
private GuacamoleHome() {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the Guacamole home directory by checking, in order:
|
|
||||||
* the guacamole.home system property, the GUACAMOLE_HOME environment
|
|
||||||
* variable, and finally the .guacamole directory in the home directory of
|
|
||||||
* the user running the servlet container.
|
|
||||||
*
|
|
||||||
* @return The File representing the Guacamole home directory, which may
|
|
||||||
* or may not exist, and may turn out to not be a directory.
|
|
||||||
*/
|
|
||||||
public static File getDirectory() {
|
|
||||||
|
|
||||||
// Attempt to find Guacamole home
|
|
||||||
File guacHome;
|
|
||||||
|
|
||||||
// Use system property by default
|
|
||||||
String desiredDir = System.getProperty("guacamole.home");
|
|
||||||
|
|
||||||
// Failing that, try the GUACAMOLE_HOME environment variable
|
|
||||||
if (desiredDir == null) desiredDir = System.getenv("GUACAMOLE_HOME");
|
|
||||||
|
|
||||||
// If successful, use explicitly specified directory
|
|
||||||
if (desiredDir != null)
|
|
||||||
guacHome = new File(desiredDir);
|
|
||||||
|
|
||||||
// If not explicitly specified, use ~/.guacamole
|
|
||||||
else
|
|
||||||
guacHome = new File(System.getProperty("user.home"), ".guacamole");
|
|
||||||
|
|
||||||
// Return discovered directory
|
|
||||||
return guacHome;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,214 +0,0 @@
|
|||||||
/*
|
|
||||||
* 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.properties;
|
|
||||||
|
|
||||||
import java.io.File;
|
|
||||||
import java.io.FileInputStream;
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.InputStream;
|
|
||||||
import java.util.Properties;
|
|
||||||
import org.apache.guacamole.GuacamoleException;
|
|
||||||
import org.apache.guacamole.GuacamoleServerException;
|
|
||||||
import org.slf4j.Logger;
|
|
||||||
import org.slf4j.LoggerFactory;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Simple utility class for reading properties from the guacamole.properties
|
|
||||||
* file. The guacamole.properties file is preferably located in the servlet
|
|
||||||
* container's user's home directory, in a subdirectory called .guacamole, or
|
|
||||||
* in the directory set by the system property: guacamole.home.
|
|
||||||
*
|
|
||||||
* If none of those locations are possible, guacamole.properties will also
|
|
||||||
* be read from the root of the classpath.
|
|
||||||
*
|
|
||||||
* @deprecated
|
|
||||||
*/
|
|
||||||
public class GuacamoleProperties {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Logger for this class.
|
|
||||||
*/
|
|
||||||
private static final Logger logger = LoggerFactory.getLogger(GuacamoleProperties.class);
|
|
||||||
|
|
||||||
static {
|
|
||||||
// Warn about deprecation
|
|
||||||
logger.warn("GuacamoleProperties is deprecated. Please use Environment instead.");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* GuacamoleProperties is a utility class and cannot be instantiated.
|
|
||||||
*/
|
|
||||||
private GuacamoleProperties() {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The hostname of the server where guacd (the Guacamole proxy server) is
|
|
||||||
* running.
|
|
||||||
*/
|
|
||||||
public static final StringGuacamoleProperty GUACD_HOSTNAME = new StringGuacamoleProperty() {
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public String getName() { return "guacd-hostname"; }
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The port that guacd (the Guacamole proxy server) is listening on.
|
|
||||||
*/
|
|
||||||
public static final IntegerGuacamoleProperty GUACD_PORT = new IntegerGuacamoleProperty() {
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public String getName() { return "guacd-port"; }
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Whether guacd requires SSL/TLS on connections.
|
|
||||||
*/
|
|
||||||
public static final BooleanGuacamoleProperty GUACD_SSL = new BooleanGuacamoleProperty() {
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public String getName() { return "guacd-ssl"; }
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* All properties read from guacamole.properties when this class was first
|
|
||||||
* used.
|
|
||||||
*/
|
|
||||||
private static final Properties properties;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Any error encountered when reading guacamole.properties was last
|
|
||||||
* attempted.
|
|
||||||
*/
|
|
||||||
private static GuacamoleException exception;
|
|
||||||
|
|
||||||
static {
|
|
||||||
|
|
||||||
properties = new Properties();
|
|
||||||
|
|
||||||
try {
|
|
||||||
|
|
||||||
// Attempt to find Guacamole home
|
|
||||||
File guacHome = GuacamoleHome.getDirectory();
|
|
||||||
|
|
||||||
InputStream stream;
|
|
||||||
|
|
||||||
// If not a directory, load from classpath
|
|
||||||
if (!guacHome.isDirectory()) {
|
|
||||||
|
|
||||||
// Read from classpath
|
|
||||||
stream = GuacamoleProperties.class.getResourceAsStream("/guacamole.properties");
|
|
||||||
if (stream == null)
|
|
||||||
throw new IOException(
|
|
||||||
"guacamole.properties not loaded from " + guacHome
|
|
||||||
+ " (not a directory), and guacamole.properties could"
|
|
||||||
+ " not be found as a resource in the classpath.");
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
// Otherwise, try to load from file
|
|
||||||
else
|
|
||||||
stream = new FileInputStream(new File(guacHome, "guacamole.properties"));
|
|
||||||
|
|
||||||
// Load properties, always close stream
|
|
||||||
try { properties.load(stream); }
|
|
||||||
finally { stream.close(); }
|
|
||||||
|
|
||||||
}
|
|
||||||
catch (IOException e) {
|
|
||||||
exception = new GuacamoleServerException("Error reading guacamole.properties", e);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Given a GuacamoleProperty, parses and returns the value set for that
|
|
||||||
* property in guacamole.properties, if any.
|
|
||||||
*
|
|
||||||
* @param <Type> The type that the given property is parsed into.
|
|
||||||
* @param property The property to read from guacamole.properties.
|
|
||||||
* @return The parsed value of the property as read from
|
|
||||||
* guacamole.properties.
|
|
||||||
* @throws GuacamoleException If an error occurs while parsing the value
|
|
||||||
* for the given property in
|
|
||||||
* guacamole.properties.
|
|
||||||
*/
|
|
||||||
public static <Type> Type getProperty(GuacamoleProperty<Type> property) throws GuacamoleException {
|
|
||||||
|
|
||||||
if (exception != null)
|
|
||||||
throw exception;
|
|
||||||
|
|
||||||
return property.parseValue(properties.getProperty(property.getName()));
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Given a GuacamoleProperty, parses and returns the value set for that
|
|
||||||
* property in guacamole.properties, if any. If no value is found, the
|
|
||||||
* provided default value is returned.
|
|
||||||
*
|
|
||||||
* @param <Type> The type that the given property is parsed into.
|
|
||||||
* @param property The property to read from guacamole.properties.
|
|
||||||
* @param defaultValue The value to return if no value was given in
|
|
||||||
* guacamole.properties.
|
|
||||||
* @return The parsed value of the property as read from
|
|
||||||
* guacamole.properties, or the provided default value if no value
|
|
||||||
* was found.
|
|
||||||
* @throws GuacamoleException If an error occurs while parsing the value
|
|
||||||
* for the given property in
|
|
||||||
* guacamole.properties.
|
|
||||||
*/
|
|
||||||
public static <Type> Type getProperty(GuacamoleProperty<Type> property,
|
|
||||||
Type defaultValue) throws GuacamoleException {
|
|
||||||
|
|
||||||
Type value = getProperty(property);
|
|
||||||
if (value == null)
|
|
||||||
return defaultValue;
|
|
||||||
|
|
||||||
return value;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Given a GuacamoleProperty, parses and returns the value set for that
|
|
||||||
* property in guacamole.properties. An exception is thrown if the value
|
|
||||||
* is not provided.
|
|
||||||
*
|
|
||||||
* @param <Type> The type that the given property is parsed into.
|
|
||||||
* @param property The property to read from guacamole.properties.
|
|
||||||
* @return The parsed value of the property as read from
|
|
||||||
* guacamole.properties.
|
|
||||||
* @throws GuacamoleException If an error occurs while parsing the value
|
|
||||||
* for the given property in
|
|
||||||
* guacamole.properties, or if the property is
|
|
||||||
* not specified.
|
|
||||||
*/
|
|
||||||
public static <Type> Type getRequiredProperty(GuacamoleProperty<Type> property)
|
|
||||||
throws GuacamoleException {
|
|
||||||
|
|
||||||
Type value = getProperty(property);
|
|
||||||
if (value == null)
|
|
||||||
throw new GuacamoleServerException("Property " + property.getName() + " is required.");
|
|
||||||
|
|
||||||
return value;
|
|
||||||
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user