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.URLParameter
Returns the parameter that supplies the base TAP service URL.List
<uk.ac.starlink.task.Parameter<?>> Returns the parameter 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.vo.TapService
getTapService
(uk.ac.starlink.task.Environment env) Acquires a TapService instance from the environment using the parameters managed by this object.
-
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 parameter used to select the TAP interface, including authentication options.- Returns:
- TAP interface parameter
-
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
-
getTapService
public uk.ac.starlink.vo.TapService getTapService(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException Acquires a TapService instance from the environment using the parameters managed by this object.- Parameters:
env
- execution environment- Returns:
- TAP service description
- Throws:
uk.ac.starlink.task.TaskException
-