Package uk.ac.starlink.ttools.task
Class TapServiceParams
java.lang.Object
uk.ac.starlink.ttools.task.TapServiceParams
Manages a collection of parameters used to generate a TapService.
- Since:
- 9 Aug 2016
- Author:
- Mark Taylor
-
Constructor Summary
ConstructorsConstructorDescriptionTapServiceParams
(String baseParamName, boolean readCapabilitiesDflt) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionuk.ac.starlink.task.Parameter
<Boolean> Note this is also included ingetInterfaceParameters()
uk.ac.starlink.task.URLParameter
Returns the parameter that supplies the base TAP service URL.List
<uk.ac.starlink.task.Parameter<?>> Returns the parameters used to select the TAP interface, including authentication options.List
<uk.ac.starlink.task.URLParameter> Returns a list of other parameters managed by this object that specify endpoints for TAP-related services.uk.ac.starlink.util.IOSupplier
<uk.ac.starlink.vo.TapService> getServiceSupplier
(uk.ac.starlink.task.Environment env) Manages acquisition of a TapService instance from the environment using the parameters managed by this object.uk.ac.starlink.task.Parameter
<String> Note this is also included ingetInterfaceParameters()
-
Constructor Details
-
TapServiceParams
Constructor.- Parameters:
baseParamName
- name of the parameter that specifies the base TAP URLreadCapabilitiesDflt
- if true, the default behaviour involves reading the service's capabilities document; if false, the default behaviour assumes standard endpoints
-
-
Method Details
-
getBaseParameter
public uk.ac.starlink.task.URLParameter getBaseParameter()Returns the parameter that supplies the base TAP service URL.- Returns:
- service URL parameter
-
getInterfaceParameters
Returns the parameters used to select the TAP interface, including authentication options.- Returns:
- TAP interface parameters
-
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
Note this is also included ingetInterfaceParameters()
-
getTapInterfaceParameter
Note this is also included ingetInterfaceParameters()
-
getServiceSupplier
public uk.ac.starlink.util.IOSupplier<uk.ac.starlink.vo.TapService> getServiceSupplier(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.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:
uk.ac.starlink.task.TaskException
-