/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
*
*  (c) 2019.                            (c) 2019.
*  Government of Canada                 Gouvernement du Canada
*  National Research Council            Conseil national de recherches
*  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
*  All rights reserved                  Tous droits réservés
*
*  NRC disclaims any warranties,        Le CNRC dénie toute garantie
*  expressed, implied, or               énoncée, implicite ou légale,
*  statutory, of any kind with          de quelque nature que ce
*  respect to the software,             soit, concernant le logiciel,
*  including without limitation         y compris sans restriction
*  any warranty of merchantability      toute garantie de valeur
*  or fitness for a particular          marchande ou de pertinence
*  purpose. NRC shall not be            pour un usage particulier.
*  liable in any event for any          Le CNRC ne pourra en aucun cas
*  damages, whether direct or           être tenu responsable de tout
*  indirect, special or general,        dommage, direct ou indirect,
*  consequential or incidental,         particulier ou général,
*  arising from the use of the          accessoire ou fortuit, résultant
*  software.  Neither the name          de l'utilisation du logiciel. Ni
*  of the National Research             le nom du Conseil National de
*  Council of Canada nor the            Recherches du Canada ni les noms
*  names of its contributors may        de ses  participants ne peuvent
*  be used to endorse or promote        être utilisés pour approuver ou
*  products derived from this           promouvoir les produits dérivés
*  software without specific prior      de ce logiciel sans autorisation
*  written permission.                  préalable et particulière
*                                       par écrit.
*
*  This file is part of the             Ce fichier fait partie du projet
*  OpenCADC project.                    OpenCADC.
*
*  OpenCADC is free software:           OpenCADC est un logiciel libre ;
*  you can redistribute it and/or       vous pouvez le redistribuer ou le
*  modify it under the terms of         modifier suivant les termes de
*  the GNU Affero General Public        la “GNU Affero General Public
*  License as published by the          License” telle que publiée
*  Free Software Foundation,            par la Free Software Foundation
*  either version 3 of the              : soit la version 3 de cette
*  License, or (at your option)         licence, soit (à votre gré)
*  any later version.                   toute version ultérieure.
*
*  OpenCADC is distributed in the       OpenCADC est distribué
*  hope that it will be useful,         dans l’espoir qu’il vous
*  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
*  without even the implied             GARANTIE : sans même la garantie
*  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILITÉ
*  or FITNESS FOR A PARTICULAR          ni d’ADÉQUATION À UN OBJECTIF
*  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
*  General Public License for           Générale Publique GNU Affero
*  more details.                        pour plus de détails.
*
*  You should have received             Vous devriez avoir reçu une
*  a copy of the GNU Affero             copie de la Licence Générale
*  General Public License along         Publique GNU Affero avec
*  with OpenCADC.  If not, see          OpenCADC ; si ce n’est
*  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
*                                       <http://www.gnu.org/licenses/>.
*
************************************************************************
*/

package org.opencadc.tap;


import ca.nrc.cadc.auth.AuthMethod;
import ca.nrc.cadc.net.ResourceNotFoundException;
import ca.nrc.cadc.reg.Standards;
import ca.nrc.cadc.reg.client.RegistryClient;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import org.apache.log4j.Logger;

/**
 * Basic client for Table Access Protocol (TAP).
 * 
 * @author pdowler
 */
public class TapClient {
    private static final Logger log = Logger.getLogger(TapClient.class);

    private final URI resourceID;
    private final RegistryClient reg;
    
    /**
     * Constructor.
     * 
     * @param resourceID unique identifier for the TAP service
     */
    public TapClient(URI resourceID) {
        this.resourceID = resourceID;
        this.reg = new RegistryClient();
    }
    
    /**
     * Generate a usable async endpoint URL. This method only considers the specified
     * authentication method when performing the lookup of the base URL.
     * 
     * @param am
     * @return async URL
     * @throws ResourceNotFoundException 
     */
    public URL getAsyncURL(AuthMethod am) throws ResourceNotFoundException {
        URL base = reg.getServiceURL(resourceID, Standards.TAP_10, am);
        if (base == null) {
            throw new ResourceNotFoundException("not found: " + resourceID + " with " + am.getValue());
        }
        try {
            return new URL(base.toExternalForm() + "/async");
        } catch (MalformedURLException ex) {
            throw new RuntimeException("FAIL: appending /async to " + base + " gave invalid URL", ex);
        }
    }
    
    /**
     * Generate a usable sync endpoint URL. This method only considers the specified
     * authentication method when performing the lookup of the base URL.
     * 
     * @param am
     * @return sync URL
     * @throws ResourceNotFoundException 
     */
    public URL getSyncURL(AuthMethod am) throws ResourceNotFoundException {
        URL base = reg.getServiceURL(resourceID, Standards.TAP_10, am);
        if (base == null) {
            throw new ResourceNotFoundException("not found: " + resourceID + " with " + am.getValue());
        }
        try {
            return new URL(base.toExternalForm() + "/sync");
        } catch (MalformedURLException ex) {
            throw new RuntimeException("FAIL: appending /async to " + base + " gave invalid URL", ex);
        }
    }
}

@@ -3923,17 +3923,16 @@
 c.tap;%0A%0A
-%0A
 import c
@@ -4878,32 +4878,54 @@
      * @param am
+ authentication method
 %0A     * @return 
@@ -4967,32 +4967,77 @@
 tFoundException 
+if base URL matching specified auth not found
 %0A     */%0A    pub
@@ -5755,16 +5755,38 @@
 param am
+ authentication method
 %0A     * 
@@ -5843,16 +5843,61 @@
 ception 
+if base URL matching specified auth not found
 %0A     */

fix javadoc warnings