public class GuacamoleConfiguration extends Object implements Serializable
Constructor and Description |
---|
GuacamoleConfiguration()
Creates a new, blank GuacamoleConfiguration with its protocol, connection
ID, and parameters unset.
|
GuacamoleConfiguration(GuacamoleConfiguration config)
Copies the given GuacamoleConfiguration, creating a new, indepedent
GuacamoleConfiguration containing the same protocol, connection ID,
and parameter values, if any.
|
Modifier and Type | Method and Description |
---|---|
String |
getConnectionID()
Returns the ID of the connection being joined, if any.
|
String |
getParameter(String name)
Returns the value set for the parameter with the given name, if any.
|
Set<String> |
getParameterNames()
Returns a set of all currently defined parameter names.
|
Map<String,String> |
getParameters()
Returns a map which contains parameter name/value pairs as key/value
pairs.
|
String |
getProtocol()
Returns the name of the protocol to be used.
|
void |
setConnectionID(String connectionID)
Sets the ID of the connection being joined, if any.
|
void |
setParameter(String name,
String value)
Sets the value for the parameter with the given name.
|
void |
setParameters(Map<String,String> parameters)
Replaces all current parameters with the parameters defined within the
given map.
|
void |
setProtocol(String protocol)
Sets the name of the protocol to be used.
|
void |
unsetParameter(String name)
Removes the value set for the parameter with the given name.
|
public GuacamoleConfiguration()
public GuacamoleConfiguration(GuacamoleConfiguration config)
config
- The GuacamoleConfiguration to copy.public String getConnectionID()
public void setConnectionID(String connectionID)
connectionID
- The ID of the connection being joined.public String getProtocol()
public void setProtocol(String protocol)
If a connection is being joined, this value should still be
set to ensure that protocol-specific responses like the
"required" and "argv" instructions can be understood in their proper
context by other code that may consume this GuacamoleConfiguration like
ConfiguredGuacamoleSocket
.
If this value is unavailable or remains unset, it is still possible
to join an established connection using
setConnectionID(java.lang.String)
, however protocol-specific
responses like the "required" and "argv" instructions might not be
possible to handle correctly if the underlying protocol is not made
available through some other means to the client receiving those
responses.
protocol
- The name of the protocol to be used.public String getParameter(String name)
name
- The name of the parameter to return the value for.public void setParameter(String name, String value)
name
- The name of the parameter to set the value for.value
- The value to set for the parameter with the given name.public void unsetParameter(String name)
name
- The name of the parameter to remove the value of.public Set<String> getParameterNames()
public Map<String,String> getParameters()
public void setParameters(Map<String,String> parameters)
parameters
- A map which contains all parameter name/value pairs as key/value
pairs.Copyright © 2020. All rights reserved.