Class TapServiceParams


  • public class TapServiceParams
    extends java.lang.Object
    Manages a collection of parameters used to generate a TapService.
    Since:
    9 Aug 2016
    Author:
    Mark Taylor
    • Constructor Summary

      Constructors 
      Constructor Description
      TapServiceParams​(java.lang.String baseParamName, boolean readCapabilitiesDflt)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      uk.ac.starlink.task.URLParameter getBaseParameter()
      Returns the parameter that supplies the base TAP service URL.
      java.util.List<uk.ac.starlink.task.Parameter<?>> getInterfaceParameters()
      Returns the parameter used to select the TAP interface, including authentication options.
      java.util.List<uk.ac.starlink.task.URLParameter> getOtherParameters()
      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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TapServiceParams

        public TapServiceParams​(java.lang.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 uk.ac.starlink.task.URLParameter getBaseParameter()
        Returns the parameter that supplies the base TAP service URL.
        Returns:
        service URL parameter
      • getInterfaceParameters

        public java.util.List<uk.ac.starlink.task.Parameter<?>> getInterfaceParameters()
        Returns the parameter used to select the TAP interface, including authentication options.
        Returns:
        TAP interface parameter
      • getOtherParameters

        public java.util.List<uk.ac.starlink.task.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
      • 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