uk.ac.starlink.ttools.task

Class TapServiceParams

java.lang.Object

uk.ac.starlink.ttools.task.TapServiceParams

public class TapServiceParams
extends Object

Manages a collection of parameters used to generate a TapService.

Since:

9 Aug 2016

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
TapServiceParams(String baseParamName, boolean readCapabilitiesDflt) Constructor.

Method Summary

Modifier and Type	Method and Description
Parameter<Boolean>	getAuthParameter() Note this is also included in getInterfaceParameters()
URLParameter	getBaseParameter() Returns the parameter that supplies the base TAP service URL.
List<Parameter<?>>	getInterfaceParameters() Returns the parameters used to select the TAP interface, including authentication options.
List<URLParameter>	getOtherParameters() Returns a list of other parameters managed by this object that specify endpoints for TAP-related services.
IOSupplier<TapService>	getServiceSupplier(Environment env) Manages acquisition of a TapService instance from the environment using the parameters managed by this object.
Parameter<String>	getTapInterfaceParameter() Note this is also included in getInterfaceParameters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TapServiceParams

public TapServiceParams(String baseParamName,
                        boolean readCapabilitiesDflt)

Constructor.

Parameters:

baseParamName - name of the parameter that specifies the base TAP URL

readCapabilitiesDflt - if true, the default behaviour involves reading the service's capabilities document; if false, the default behaviour assumes standard endpoints

Method Detail

getBaseParameter

public URLParameter getBaseParameter()

Returns the parameter that supplies the base TAP service URL.

Returns:

service URL parameter

getInterfaceParameters

public List<Parameter<?>> getInterfaceParameters()

Returns the parameters used to select the TAP interface, including authentication options.

Returns:

TAP interface parameters

getOtherParameters

public List<URLParameter> getOtherParameters()

Returns a list of other parameters managed by this object that specify endpoints for TAP-related services.

Returns:

list of parameters excluding the service URL

getAuthParameter

public Parameter<Boolean> getAuthParameter()

Note this is also included in getInterfaceParameters()

getTapInterfaceParameter

public Parameter<String> getTapInterfaceParameter()

Note this is also included in getInterfaceParameters()

getServiceSupplier

public IOSupplier<TapService> getServiceSupplier(Environment env)
                                          throws TaskException

Manages acquisition of a TapService instance from the environment using the parameters managed by this object.

The idea is that all the environment interaction is done by this method, and all the service interaction is done when using the supplier's get method. This may not be perfectly true because of difficulties in arranging dynamic parameter defaulting based on contacting the service.

Parameters:

env - execution environment

Returns:

supplier for a TAP service description

Throws:

TaskException