/*
 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.tools.internal.ws.processor.generator;

import com.sun.codemodel.internal.JCodeModel;
import com.sun.codemodel.internal.JDefinedClass;
import com.sun.tools.internal.ws.processor.model.Model;
import com.sun.tools.internal.ws.processor.model.Port;
import com.sun.tools.internal.ws.wscompile.WsimportOptions;
import com.sun.xml.internal.ws.api.SOAPVersion;

/**
 * Service Generator Extension for Custom Binding and Transport
 *
 * @since 2.2.6
 * @see JwsImplGenerator
 */
public abstract class GeneratorExtension {

    /**
     * Derive  Binding ID based on transport and SOAP version
     * @param transport
     * @param soapVersion
     * @return BindingID
     */
    public String getBindingValue(String transport, SOAPVersion soapVersion) {
      return null;
    }

    /**
     * Create annotations in service JWS generated
     * @param model
     * @param cm
     * @param cls
     * @param port
     */
    public void writeWebServiceAnnotation(Model model, JCodeModel cm, JDefinedClass cls, Port port) {
    }

    /**
     * Allow additional wsimport options
     * @param name for instance, "-neoption"
     * @return whether the name specifies an option recognized by the extension
     */
    public boolean validateOption(String name) {
      return false;
    }

    /**
     * Create annotations in service client generated
     * @param options
     * @param cm
     * @param cls
     */
    public void writeWebServiceClientAnnotation(WsimportOptions options, JCodeModel cm, JDefinedClass cls) {
    }
}
