public abstract class TunnelRequest extends Object
Modifier and Type | Class and Description |
---|---|
static class |
TunnelRequest.Type
All supported object types that can be used as the destination of a
tunnel.
|
Modifier and Type | Field and Description |
---|---|
static String |
AUDIO_PARAMETER
The name of the parameter specifying one supported audio mimetype.
|
static String |
AUTH_PROVIDER_IDENTIFIER_PARAMETER
The name of the parameter containing the identifier of the
AuthenticationProvider associated with the UserContext containing the
object to which a tunnel is being requested.
|
static String |
AUTH_TOKEN_PARAMETER
The name of the request parameter containing the user's authentication
token.
|
static String |
DPI_PARAMETER
The name of the parameter containing the desired display resolution, in
DPI.
|
static String |
HEIGHT_PARAMETER
The name of the parameter containing the desired display height, in
pixels.
|
static String |
IDENTIFIER_PARAMETER
The name of the parameter containing the unique identifier of the object
to which a tunnel is being requested.
|
static String |
TYPE_PARAMETER
The name of the parameter specifying the type of object to which a
tunnel is being requested.
|
static String |
VIDEO_PARAMETER
The name of the parameter specifying one supported video mimetype.
|
static String |
WIDTH_PARAMETER
The name of the parameter containing the desired display width, in
pixels.
|
Constructor and Description |
---|
TunnelRequest() |
Modifier and Type | Method and Description |
---|---|
List<String> |
getAudioMimetypes()
Returns a list of all audio mimetypes declared as supported within the
tunnel request.
|
String |
getAuthenticationProviderIdentifier()
Returns the identifier of the AuthenticationProvider associated with the
UserContext from which the connection or connection group is to be
retrieved when the tunnel is created.
|
String |
getAuthenticationToken()
Returns the authentication token associated with this tunnel request.
|
Integer |
getDPI()
Returns the display resolution desired for the Guacamole session over
the tunnel being requested, in DPI.
|
Integer |
getHeight()
Returns the display height desired for the Guacamole session over the
tunnel being requested.
|
String |
getIdentifier()
Returns the identifier of the destination of the tunnel being requested.
|
Integer |
getIntegerParameter(String name)
Returns the integer value of the parameter having the given name,
throwing an exception if the parameter cannot be parsed.
|
abstract String |
getParameter(String name)
Returns the value of the parameter having the given name.
|
abstract List<String> |
getParameterValues(String name)
Returns a list of all values specified for the given parameter.
|
String |
getRequiredParameter(String name)
Returns the value of the parameter having the given name, throwing an
exception if the parameter is missing.
|
TunnelRequest.Type |
getType()
Returns the type of object for which the tunnel is being requested.
|
List<String> |
getVideoMimetypes()
Returns a list of all video mimetypes declared as supported within the
tunnel request.
|
Integer |
getWidth()
Returns the display width desired for the Guacamole session over the
tunnel being requested.
|
public static final String AUTH_TOKEN_PARAMETER
public static final String AUTH_PROVIDER_IDENTIFIER_PARAMETER
public static final String TYPE_PARAMETER
public static final String IDENTIFIER_PARAMETER
public static final String WIDTH_PARAMETER
public static final String HEIGHT_PARAMETER
public static final String DPI_PARAMETER
public static final String AUDIO_PARAMETER
public static final String VIDEO_PARAMETER
public abstract String getParameter(String name)
name
- The name of the parameter to return.public abstract List<String> getParameterValues(String name)
name
- The name of the parameter to return.public String getRequiredParameter(String name) throws GuacamoleException
name
- The name of the parameter to return.GuacamoleException
- If the parameter is not present in the request.public Integer getIntegerParameter(String name) throws GuacamoleException
name
- The name of the parameter to return.GuacamoleException
- If the parameter is not a valid integer.public String getAuthenticationToken()
public String getAuthenticationProviderIdentifier() throws GuacamoleException
GuacamoleException
- If the identifier was not present in the request.public TunnelRequest.Type getType() throws GuacamoleException
GuacamoleException
- If the type was not present in the request, or if the type requested
is in the wrong format.public String getIdentifier() throws GuacamoleException
GuacamoleException
- If the identifier was not present in the request.public Integer getWidth() throws GuacamoleException
GuacamoleException
- If the width specified was not a valid integer.public Integer getHeight() throws GuacamoleException
GuacamoleException
- If the height specified was not a valid integer.public Integer getDPI() throws GuacamoleException
GuacamoleException
- If the resolution specified was not a valid integer.public List<String> getAudioMimetypes()
Copyright © 2017. All rights reserved.