/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
*
*  (c) 2010.                            (c) 2010.
*  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/>.
*
*  $Revision: 5 $
*
************************************************************************
 */

package ca.nrc.cadc.reg;

import ca.nrc.cadc.auth.AuthMethod;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import org.apache.log4j.Logger;

/**
 * Minimal implementation of the IVOA Capability model in VOResource 1.0.
 *
 * standardID is a URI which represents a service standard, e.g. ivo://ivoa.net/std/TAP
 *
 * interface specifies how the capability can be accessed. At least one interface
 * must be provided. If more than one is provided, each interface should provide
 * an alternative interface for accessing essentially the same underlying
 * capability. The interfaces can differ in their overall type or in the
 * supported input parameters or output products.
 *
 * @author yeunga
 */
public class Capability {

    private static Logger log = Logger.getLogger(Capability.class);

    // Use List to preserve the order.
    private final URI standardID;
    private final List<Interface> interfaces = new ArrayList<Interface>();

    /**
     * Constructor. 
     * @param standardID
     */
    public Capability(final URI standardID) {
        validateParams(standardID);
        this.standardID = standardID;
    }

    public URI getStandardID() {
        return standardID;
    }

    public List<Interface> getInterfaces() {
        return interfaces;
    }

    /**
     * Find a ParamHTTP interface that uses the specified securityMethod.
     * This method returns the first matching interface.
     * 
     * @param securityMethod
     * @return the first matching interface or null
     */
    public Interface findInterface(final URI securityMethod) {
        return findInterface(securityMethod, Standards.INTERFACE_PARAM_HTTP);
    }
    
    /**
     * Find an interface of the specified type that uses the specified securityMethod.
     * This method returns the first matching interface.
     * 
     * @param securityMethod
     * @param interfaceType
     * @return the first matching interface or null
     */
    public Interface findInterface(final URI securityMethod, final URI interfaceType) {
        for (Interface intf : this.interfaces) {
            if (intf.getType().equals(interfaceType)
                    && intf.getSecurityMethod().equals(securityMethod)) {
                return intf;
            }
        }

        return null;
    }

    /**
     * Find a ParamHTTP interface that uses the specified securityMethod.
     * This method returns the first matching interface.
     * 
     * @param authMethod
     * @return the first matching interface or null
     */
    public Interface findInterface(final AuthMethod authMethod) {
        return findInterface(authMethod, Standards.INTERFACE_PARAM_HTTP);
    }
    
    /**
     * Find an interface of the specified type that uses the specified securityMethod.
     * This method returns the first matching interface.
     * 
     * @param authMethod
     * @param interfaceType
     * @return the first matching interface or null
     */
    public Interface findInterface(final AuthMethod authMethod, final URI interfaceType) {
        for (Interface intf : this.interfaces) {
            if (intf.getType().equals(interfaceType)) {
                AuthMethod am = Standards.getAuthMethod(intf.getSecurityMethod());
                if (authMethod.equals(am)) {
                    return intf;
                }
            }
        }

        return null;
    }
    
    private void validateParams(final URI standardID) {
        if (standardID == null) {
            String msg = "standard identifier for a Capability object cannot be null.";
            throw new IllegalArgumentException(msg);
        }
    }
}

@@ -6098,16 +6098,53 @@
       &&
+ (intf.getSecurityMethod() == null %7C%7C
  intf.ge
@@ -6184,16 +6184,17 @@
 Method))
+)
  %7B%0A     

fix findInterface(anon) to match no securityMethod or standard anon uri