com.tplan.robot.remoteclient.capabilities

Interface ClientSpecificParamsCapable

public interface ClientSpecificParamsCapable

Interface of a client supporting specific connection parameters.

Since:

4.1

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
List<String>	getClientParameters() Get the list of parameter names supported by the client implementing this interface.
List	getClientParameterValues(String parameterName) Get the list of acceptable values of a particular parameter (if known).
URI	getExtendedConnectString() Create the extended connect string including the client specific parameters embedded as the query.
void	setClientParameters(Map<String,String> paramsAndValues) Set parameters and their values in the client.It will be called by the command and the map will contain parameters parsed on the command line.

Method Detail

getClientParameters

List<String> getClientParameters()

Get the list of parameter names supported by the client implementing this interface.

Returns:

list of supported parameter names.

getClientParameterValues

List getClientParameterValues(String parameterName)

Get the list of acceptable values of a particular parameter (if known). The method should return null for parameters which are not enumerated "one of" type.

Parameters:

parameterName - parameter name

Returns:

list of acceptable parameter values or null if the parameter value is not limited to a particular value set.

setClientParameters

void setClientParameters(Map<String,String> paramsAndValues)
                  throws SyntaxErrorException

Set parameters and their values in the client.It will be called by the command and the map will contain parameters parsed on the command line. Parsing of the parameter values should be performed in a way which is not case sensitive (for example through encapsulating the map through the CaseTolerantHashMap class). The method should throw a SyntaxErrorException when one or more parameters and/or their values are not supported.

Parameters:

paramsAndValues - map of parameters and their values.

Throws:

SyntaxErrorException - on a syntax error in a parameter value.

getExtendedConnectString

URI getExtendedConnectString()

Create the extended connect string including the client specific parameters embedded as the query. For example, an iOS Mirror connection to a device called "My Device" will return something like apple://192.168.100.1:5909?device=My%20Device.

Returns:

the connection URI including the specific client parameters encoded in form of a query.