aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.api.model.wsdl;
aoqi@0: 
aoqi@0: import java.util.List;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: import org.xml.sax.Locator;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Interface that represents WSDL concepts that
aoqi@0:  * can have extensions.
aoqi@0:  *
aoqi@0:  * @author Vivek Pandey
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public interface WSDLExtensible extends WSDLObject {
aoqi@0:     /**
aoqi@0:      * Gets all the {@link WSDLExtension}s
aoqi@0:      * added through {@link #addExtension(WSDLExtension)}.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      never null.
aoqi@0:      */
aoqi@0:     Iterable<WSDLExtension> getExtensions();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets all the extensions that is assignable to the given type.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This allows clients to find specific extensions in a type-safe
aoqi@0:      * and convenient way.
aoqi@0:      *
aoqi@0:      * @param type
aoqi@0:      *      The type of the extension to obtain. Must not be null.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      Can be an empty fromjava.collection but never null.
aoqi@0:      */
aoqi@0:     <T extends WSDLExtension> Iterable<T> getExtensions(Class<T> type);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the extension that is assignable to the given type.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This is just a convenient version that does
aoqi@0:      *
aoqi@0:      * <pre>
aoqi@0:      * Iterator itr = getExtensions(type);
aoqi@0:      * if(itr.hasNext())  return itr.next();
aoqi@0:      * else               return null;
aoqi@0:      * </pre>
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      null if the extension was not found.
aoqi@0:      */
aoqi@0:     <T extends WSDLExtension> T getExtension(Class<T> type);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds a new {@link WSDLExtension}
aoqi@0:      * to this object.
aoqi@0:      *
aoqi@0:      * @param extension
aoqi@0:      *      must not be null.
aoqi@0:      */
aoqi@0:     void addExtension(WSDLExtension extension);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * True if all required WSDL extensions on Port and Binding are understood
aoqi@0:      * @return true if all wsdl required extensions on Port and Binding are understood
aoqi@0:      */
aoqi@0:     public boolean areRequiredExtensionsUnderstood();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Marks extension as not understood
aoqi@0:      * @param extnEl QName of extension
aoqi@0:      * @param locator Locator
aoqi@0:      */
aoqi@0:     public void addNotUnderstoodExtension(QName extnEl, Locator locator);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Lists extensions marked as not understood
aoqi@0:      * @return List of not understood extensions
aoqi@0:      */
aoqi@0:     public List<? extends WSDLExtension> getNotUnderstoodExtensions();
aoqi@0: }