FileDocCategorySizeDatePackage
WebServiceConfig.javaAPI DocGlassfish v2 API4048Fri May 04 22:24:42 BST 2007com.sun.enterprise.admin.wsmgmt.config.spi

WebServiceConfig.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.enterprise.admin.wsmgmt.config.spi;

/**
 * This represents management configuration for a web service end point. 
 */
public interface WebServiceConfig {

    /**
     * Returns the name of the web service endpoint
     *
     * @return the name of the web service endpoint
     */
    public String getName();

    /**
     * Returns the name of the web service endpoint name (relative i.e. does not
     * include module id in the name.
     *
     * @return the relative name of the web service endpoint
     */
    public String getEndpointName();

    /**
     * Returns the monitoring level OFF, LOW or HIGH 
     *
     * @return the monitoring level OFF, LOW or HIGH 
     */
    public String getMonitoringLevel();

    /**
     * Returns the max history size (size of stored monitoring stats)
     *
     * @return the max history size (size of stored monitoring stats)
     */
    public int getMaxHistorySize();

    /**
     * Returns true, if this web service endpoint JBI enabled
     *
     * @return true, if this web service endpoint JBI enabled
     */
    public boolean getJbiEnabled();
    
    /**
     * Returns the transformation rules defined for this endpoint
     *
     * @return the transformation rules defined for this endpoint
     */
    public TransformationRule[] getTransformationRule();

    /**
     * Returns the transformation rules defined for this endpoint
     * during request phase
     *
     * @return the transformation rules defined for this endpoint
     */
    public TransformationRule[] getRequestTransformationRule();

    /**
     * Returns the transformation rules defined for this endpoint
     * during response phase
     *
     * @return the transformation rules defined for this endpoint
     */
    public TransformationRule[] getResponseTransformationRule();

    /**
     * Returns the registries where the web service end point artifacts are
     * published.
     *
     * @return the registries where the web service end point artifacts are
     * published.
     */
    public RegistryLocation[] getRegistryLocation();
}