ohair@286: /*
ohair@286:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.wsdl;
ohair@286: 
ohair@286: import com.sun.xml.internal.ws.api.message.Packet;
ohair@286: import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort;
ohair@286: import com.sun.xml.internal.ws.api.model.SEIModel;
ohair@286: import com.sun.xml.internal.ws.api.WSBinding;
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: 
ohair@286: import javax.xml.namespace.QName;
ohair@286: 
ohair@286: /**
ohair@286:  * Extensions if this class will be used for dispatching the request message to the correct endpoint method by
ohair@286:  * identifying the wsdl operation associated with the request.
ohair@286:  *
ohair@286:  * @See OperationDispatcher
ohair@286:  *
ohair@286:  * @author Rama Pulavarthi
ohair@286:  */
ohair@286: public abstract class WSDLOperationFinder {
ohair@286:     protected final WSDLPort wsdlModel;
ohair@286:     protected final WSBinding binding;
ohair@286:     protected final SEIModel seiModel;
ohair@286: 
ohair@286:     public WSDLOperationFinder(@NotNull WSDLPort wsdlModel, @NotNull WSBinding binding, @Nullable SEIModel seiModel) {
ohair@286:         this.wsdlModel = wsdlModel;
ohair@286:         this.binding = binding;
ohair@286:         this.seiModel= seiModel;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * This methods returns the QName of the WSDL operation correponding to a request Packet.
ohair@286:      * An implementation should return null when it cannot dispatch to a unique method based on the information it processes.
ohair@286:      * In such case, other OperationFinders are queried to resolve a WSDL operation.
ohair@286:      * It should throw an instance of DispatchException if it finds incorrect information in the packet.
ohair@286:      *
ohair@286:      * @param request  Request Packet that is used to find the associated WSDLOperation
ohair@286:      * @return QName of the WSDL Operation that this request correponds to.
ohair@286:      *          null when it cannot find a unique operation to dispatch to.
ohair@286:      * @throws DispatchException When the information in the Packet is invalid
ohair@286:      */
ohair@286:     public abstract QName getWSDLOperationQName(Packet request) throws DispatchException;
ohair@286: }