Author: alessio.soldano(a)jboss.com Date: 2011-05-10 05:22:13 -0400 (Tue, 10 May 2011) New Revision: 14342 Added: api/trunk/src/main/java/org/jboss/ws/api/addressing/package.html api/trunk/src/main/java/org/jboss/ws/api/annotation/package.html api/trunk/src/main/java/org/jboss/ws/api/binding/package.html api/trunk/src/main/java/org/jboss/ws/api/handler/package.html api/trunk/src/main/java/org/jboss/ws/api/monitoring/package.html api/trunk/src/main/java/org/jboss/ws/api/tools/package.html api/trunk/src/main/java/org/jboss/ws/api/util/package.html Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/AddressingConstants.java api/trunk/src/main/java/org/jboss/ws/api/addressing/MAP.java api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilder.java api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilderFactory.java api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPConstants.java api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPEndpoint.java api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPRelatesTo.java api/trunk/src/main/java/org/jboss/ws/api/annotation/AuthMethod.java api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java api/trunk/src/main/java/org/jboss/ws/api/annotation/TransportGuarantee.java api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java api/trunk/src/main/java/org/jboss/ws/api/binding/BindingCustomization.java api/trunk/src/main/java/org/jboss/ws/api/binding/JAXBBindingCustomization.java api/trunk/src/main/java/org/jboss/ws/api/handler/GenericHandler.java api/trunk/src/main/java/org/jboss/ws/api/handler/GenericLogicalHandler.java api/trunk/src/main/java/org/jboss/ws/api/handler/GenericSOAPHandler.java api/trunk/src/main/java/org/jboss/ws/api/monitoring/Record.java api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordFilter.java api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordGroupAssociation.java api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordProcessor.java api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractConsumer.java api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractConsumerFactory.java api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProvider.java api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProviderFactory.java api/trunk/src/main/java/org/jboss/ws/api/util/DOMUtils.java api/trunk/src/main/java/org/jboss/ws/api/util/ServiceLoader.java Log: [JBWS-2709] Fixing public API javadoc Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/AddressingConstants.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/addressing/AddressingConstants.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/addressing/AddressingConstants.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -24,8 +24,7 @@ import javax.xml.namespace.QName; /** - * TODO: see javax.xml.ws.addressing - merge it properly - * Addressing constants. + * WS-Addressing constants * * @author <a href="mailto:ropalka@redhat.com">Richard Opalka</a> */ @@ -40,7 +39,7 @@ } /** - * <a href="http://www.w3.org/2005/08/addressing">WSA</a> constants. + * <a href="http://www.w3.org/2005/08/addressing">WS-Addressing<... constants. */ public static final class Core { @@ -199,7 +198,7 @@ } /** - * <a href="http://www.w3.org/2007/05/addressing/metadata">WSAM<... constants. + * <a href="http://www.w3.org/2007/05/addressing/metadata">WS-Addr... Metadata</a> constants. */ public static final class Metadata { Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/MAP.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/addressing/MAP.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/addressing/MAP.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -31,8 +31,8 @@ * classes implemented by JBossWS Native and CXF. It is used to localize dependence upon the WS * stack. * - * @author Andrew Dinn (adinn(a)redhat.com) - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:adinn@redhat.com">Andrew Dinn</a> + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * */ public interface MAP Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilder.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilder.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilder.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -24,37 +24,58 @@ import java.util.Map; import javax.xml.namespace.QName; -import javax.xml.ws.handler.MessageContext; /** - * MAPBuilder is a helper used to create objects used with class MAP. + * MAPBuilder is a helper used to create objects used with class {@link org.jboss.ws.api.addressing.MAP}. * - * @author Andrew Dinn (adinn(a)redhat.com) - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:adinn@redhat.com">Andrew Dinn</a> + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * */ public interface MAPBuilder { + /** + * Creates a new {@link org.jboss.ws.api.addressing.MAP} instance + * + * @return a {@link org.jboss.ws.api.addressing.MAP} instance + */ public MAP newMap(); /** - * retrieve the inbound server message address properties attached to a message context + * Retrieves the inbound server message address properties attached to a message context + * * @param ctx the server message context - * @return + * @return the inbound server Message Addressing Properties instance */ public MAP inboundMap(Map<String, Object> ctx); /** - * retrieve the outbound client message address properties attached to a message request map + * Retrieves the outbound client message address properties attached to a message request map + * * @param ctx the client request properties map - * @return + * @return the outbound server Message Addressing Properties instance */ public MAP outboundMap(Map<String, Object> ctx); + /** + * Creates a new {@link org.jboss.ws.api.addressing.MAPConstants} instance + * + * @return a {@link org.jboss.ws.api.addressing.MAPConstants} instance + */ public MAPConstants newConstants(); + /** + * Creates a new {@link org.jboss.ws.api.addressing.MAPEndpoint} instance + * + * @return a {@link org.jboss.ws.api.addressing.MAPEndpoint} instance + */ public MAPEndpoint newEndpoint(String address); + /** + * Creates a new {@link org.jboss.ws.api.addressing.MAPRelatesTo} instance + * + * @return a {@link org.jboss.ws.api.addressing.MAPRelatesTo} instance + */ public MAPRelatesTo newRelatesTo(String id, QName type); } Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilderFactory.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilderFactory.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPBuilderFactory.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -28,10 +28,10 @@ import org.jboss.ws.api.util.ServiceLoader; /** - * Factory for MAPBuilder; to be used to get an instance of the proper MAPBuilder - * implementation which depends on the jbossws stack in use. + * Factory for {@link org.jboss.ws.api.addressing.MAPBuilder}; to be used to get an instance of the proper MAPBuilder + * implementation which depends on the JBossWS stack in use. * - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * @since 25-May-2009 * */ @@ -43,12 +43,12 @@ private static final String JBOSSWS_SPI_MODULE = "org.jboss.ws.spi"; /** - * Get the proper MAPBuilderFactory instance according to stack in use; + * Get the proper {@link org.jboss.ws.api.addressing.MAPBuilderFactory} instance according to stack in use; * this uses the ws server integration modular classloader if available * (alternatively the current thread context classloader is used) for * looking up the factory name. * - * @return + * @return a {@link org.jboss.ws.api.addressing.MAPBuilderFactory} instance */ public static MAPBuilderFactory getInstance() { @@ -56,17 +56,22 @@ } /** - * The same as getInstance() except the provided ClassLoader instance + * The same as {@link #getInstance()} except the provided ClassLoader instance * is used to lookup the factory name. * - * @param loader - * @return + * @param loader the classloader instance to use + * @return a {@link org.jboss.ws.api.addressing.MAPBuilderFactory} instance */ public static MAPBuilderFactory getInstance(ClassLoader loader) { return (MAPBuilderFactory)ServiceLoader.loadService(MAPBuilderFactory.class.getName(), null, loader); } + /** + * Get an instance of {@link org.jboss.ws.api.addressing.MAPBuilder} + * + * @return a {@link org.jboss.ws.api.addressing.MAPBuilder} instance + */ public abstract MAPBuilder getBuilderInstance(); private static ClassLoader getServerIntegrationClassLoader() Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPConstants.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPConstants.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPConstants.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -22,10 +22,10 @@ package org.jboss.ws.api.addressing; /** - * MAPConstants is a wrapper which works with class MAP + * MAPConstants is a wrapper which works with class {@link org.jboss.ws.api.addressing.MAP} * - * @author Andrew Dinn (adinn(a)redhat.com) - * @author alessio.soldano(a)jboss.com + * @author <a href=&quot;adinn(a)redhat.com&quot;&gt;Andrew Dinn</a> + * @author <a href=&quot;alessio.soldano(a)jboss.com&quot;&gt;Alessio Soldano</a> * */ public interface MAPConstants Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPEndpoint.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPEndpoint.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPEndpoint.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -26,10 +26,10 @@ import org.w3c.dom.Element; /** - * MAPEndpoint is a wrapper which works with class MAP. + * MAPEndpoint is a wrapper which works with class {@link org.jboss.ws.api.addressing.MAP}. * - * @author Andrew Dinn (adinn(a)redhat.com) - * @author alessio.soldano(a)jboss.com + * @author <a href=&quot;adinn(a)redhat.com&quot;&gt;Andrew Dinn</a> + * @author <a href=&quot;alessio.soldano(a)jboss.com&quot;&gt;Alessio Soldano</a> * */ public interface MAPEndpoint Modified: api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPRelatesTo.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPRelatesTo.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/addressing/MAPRelatesTo.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -24,10 +24,10 @@ import javax.xml.namespace.QName; /** - * MAPRelationship is a wrapper which works with class MAP. + * MAPRelationship is a wrapper which works with class {@link org.jboss.ws.api.addressing.MAP}. * - * @author Andrew Dinn (adinn(a)redhat.com) - * @author alessio.soldano(a)jboss.com + * @author <a href=&quot;adinn(a)redhat.com&quot;&gt;Andrew Dinn</a> + * @author <a href=&quot;alessio.soldano(a)jboss.com&quot;&gt;Alessio Soldano</a> * */ public interface MAPRelatesTo Added: api/trunk/src/main/java/org/jboss/ws/api/addressing/package.html =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/addressing/package.html (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/addressing/package.html 2011-05-10 09:22:13 UTC (rev 14342) @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +<!-- + JBoss, Home of Professional Open Source. + Copyright 2011, Red Hat Middleware LLC, and individual contributors + as indicated by the @author tags. See the copyright.txt file in the + distribution for a full listing of individual contributors. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. +--> +</head> +<body> + +JSR-261 support classes and interfaces + +</body> +</html> \ No newline at end of file Modified: api/trunk/src/main/java/org/jboss/ws/api/annotation/AuthMethod.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/AuthMethod.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/AuthMethod.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -28,7 +28,7 @@ * As a prerequisite to gaining access to any web service which are protected by an * authorization constraint, a user must have authenticated using the configured mechanism. * - * @author ropalka(a)redhat.com + * @author <a href=&quot;ropalka(a)redhat.com&quot;&gt;Richard Opalka</a> */ public final class AuthMethod { @@ -52,10 +52,10 @@ } /** - * Returns string representing correct auth method value. + * Returns string representing correct {@link org.jboss.ws.api.annotation.AuthMethod} value. * @param s string to convert. * @return correct auth method value - * @throws IllegalArgumentException if <b>s</b> is <b>null</b> or it contains unknown value. + * @throws IllegalArgumentException if <b>s</b> is <b>null</b> or contains unknown value. */ public static String valueOf(final String s) { Modified: api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/EndpointConfig.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -27,24 +27,23 @@ import java.lang.annotation.Target; /** - * Defines an endpoint configuration. + * Defines an endpoint configuration. * This annotation is valid on an endpoint implementation bean or a SEI. * + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> */ @Retention(value = RetentionPolicy.RUNTIME) @Target(value = { ElementType.TYPE }) public @interface EndpointConfig { /** - * The optional config-name element gives the configuration name that must be present in - * the configuration given by element config-file. - * - * Default: Standard Endpoint + * The configName gives the configuration name that must be present in the configuration given by configFile. + * If configName is not specified, the standard endpoint configuration is used. */ String configName() default ""; /** - * The optional config-file element is a URL or resource name for the configuration. + * The configFile element is a URL or resource name for the configuration. * The default value references the current AS configuration. * */ Modified: api/trunk/src/main/java/org/jboss/ws/api/annotation/TransportGuarantee.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/TransportGuarantee.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/TransportGuarantee.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -33,7 +33,7 @@ * the transmission. In most cases, the presence of the INTEGRAL or * CONFIDENTIAL flag will indicate that the use of SSL is required. * - * @author ropalka(a)redhat.com + * @author <a href="mailto:ropalka@redhat.com">Richard Opalka</a> */ public final class TransportGuarantee { @@ -62,10 +62,10 @@ } /** - * Returns string representing correct transport guarantee value. + * Returns string representing correct {@link org.jboss.ws.api.annotation.TransportGuarantee} value. * @param s string to convert. * @return correct transport guarantee value - * @throws IllegalArgumentException if <b>s</b> is <b>null</b> or it contains unknown value. + * @throws IllegalArgumentException if <b>s</b> is <b>null</b> or contains unknown value. */ public static String valueOf(final String s) { Modified: api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/WebContext.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -29,7 +29,7 @@ /** * Provides web context specific meta data to EJB based web service endpoints. * - * @author thomas.diesler(a)jboss.org + * @author <a href="mailto:thomas.diesler@jboss.org">Thomas Diesler</a> * @since 26-Apr-2005 */ @Retention(value = RetentionPolicy.RUNTIME) Added: api/trunk/src/main/java/org/jboss/ws/api/annotation/package.html =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/annotation/package.html (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/annotation/package.html 2011-05-10 09:22:13 UTC (rev 14342) @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +<!-- + JBoss, Home of Professional Open Source. + Copyright 2011, Red Hat Middleware LLC, and individual contributors + as indicated by the @author tags. See the copyright.txt file in the + distribution for a full listing of individual contributors. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. +--> +</head> +<body> + +JBossWS stack agnostic annotations + +</body> +</html> \ No newline at end of file Modified: api/trunk/src/main/java/org/jboss/ws/api/binding/BindingCustomization.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/binding/BindingCustomization.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/binding/BindingCustomization.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -30,8 +30,8 @@ * <p> * Supported properties need to be documented in subclasses. * - * @author Heiko.Braun(a)jboss.com - * Created: Jun 28, 2007 + * @author <a href="mailto:Heiko.Braun@jboss.com">Heiko Braun</a> + * @since Jun 28, 2007 */ public abstract class BindingCustomization extends HashMap { Modified: api/trunk/src/main/java/org/jboss/ws/api/binding/JAXBBindingCustomization.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/binding/JAXBBindingCustomization.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/binding/JAXBBindingCustomization.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -26,7 +26,7 @@ /** * JAXB customizations. * - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * @since 05-Oct-2009 */ public class JAXBBindingCustomization extends BindingCustomization Added: api/trunk/src/main/java/org/jboss/ws/api/binding/package.html =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/binding/package.html (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/binding/package.html 2011-05-10 09:22:13 UTC (rev 14342) @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +<!-- + JBoss, Home of Professional Open Source. + Copyright 2011, Red Hat Middleware LLC, and individual contributors + as indicated by the @author tags. See the copyright.txt file in the + distribution for a full listing of individual contributors. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. +--> +</head> +<body> + +JBossWS binding customization interfaces + +</body> +</html> \ No newline at end of file Modified: api/trunk/src/main/java/org/jboss/ws/api/handler/GenericHandler.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/handler/GenericHandler.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/handler/GenericHandler.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -25,9 +25,9 @@ import javax.xml.ws.handler.MessageContext; /** - * A generic jaxws handler + * A generic JAX-WS handler * - * @author Thomas.Diesler(a)jboss.org + * @author <a href="mailto:Thomas.Diesler@jboss.org">Thomas Diesler</a> * @since 13-Aug-2006 */ public abstract class GenericHandler implements Handler Modified: api/trunk/src/main/java/org/jboss/ws/api/handler/GenericLogicalHandler.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/handler/GenericLogicalHandler.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/handler/GenericLogicalHandler.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -25,9 +25,9 @@ import javax.xml.ws.handler.LogicalMessageContext; /** - * A generic jaxws logical handler + * A generic JAX-WS logical handler * - * @author Thomas.Diesler(a)jboss.org + * @author <a href="mailto:Thomas.Diesler@jboss.org">Thomas Diesler</a> * @since 13-Aug-2006 */ public class GenericLogicalHandler<C extends LogicalMessageContext> extends GenericHandler implements LogicalHandler Modified: api/trunk/src/main/java/org/jboss/ws/api/handler/GenericSOAPHandler.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/handler/GenericSOAPHandler.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/handler/GenericSOAPHandler.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -29,7 +29,7 @@ import javax.xml.ws.handler.soap.SOAPHandler; /** - * A generic jaxws soap handler + * A generic JAX-WS soap handler * * @author Thomas.Diesler(a)jboss.org * @since 13-Aug-2006 @@ -39,14 +39,20 @@ // The header blocks that can be processed by this Handler instance private Set<QName> headers = new HashSet<QName>(); - /** Gets the header blocks that can be processed by this Handler instance. + /** + * Gets the header blocks that can be processed by this Handler instance. + * + * @return a set of headers */ public Set<QName> getHeaders() { return headers; } - /** Sets the header blocks that can be processed by this Handler instance. + /** + * Sets the header blocks that can be processed by this Handler instance. + * + * @param headers the headers to be set */ public void setHeaders(Set<QName> headers) { Added: api/trunk/src/main/java/org/jboss/ws/api/handler/package.html =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/handler/package.html (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/handler/package.html 2011-05-10 09:22:13 UTC (rev 14342) @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +<!-- + JBoss, Home of Professional Open Source. + Copyright 2011, Red Hat Middleware LLC, and individual contributors + as indicated by the @author tags. See the copyright.txt file in the + distribution for a full listing of individual contributors. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. +--> +</head> +<body> + +Convenient extensions to JAX-WS handler framework + +</body> +</html> \ No newline at end of file Modified: api/trunk/src/main/java/org/jboss/ws/api/monitoring/Record.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/monitoring/Record.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/monitoring/Record.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -1,6 +1,6 @@ /* * JBoss, Home of Professional Open Source. - * Copyright 2006, Red Hat Middleware LLC, and individual contributors + * Copyright 2007, Red Hat Middleware LLC, and individual contributors * as indicated by the @author tags. See the copyright.txt file in the * distribution for a full listing of individual contributors. * @@ -29,30 +29,47 @@ import javax.xml.namespace.QName; /** + * An interface defining recordable data * - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * @since 8-Dec-2007 */ public interface Record extends Serializable { + /** + * {@link org.jboss.ws.api.monitoring.Record}'s message type; can be either inboud or outbound + * + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> + * + */ public enum MessageType {INBOUND, OUTBOUND}; /** * Gets the group ID corresponding to the current message exchange flow * - * @return + * @return the groupID of the record */ public String getGroupID(); + /** + * Sets the groupID + * + * @param groupID + */ public void setGroupID(String groupID); /** * Gets the date of this record * - * @return + * @return the date of the record */ public Date getDate(); + /** + * Sets the date of the record + * + * @param date + */ public void setDate(Date date); /** @@ -62,6 +79,11 @@ */ public String getSourceHost(); + /** + * Sets the source host + * + * @param host + */ public void setSourceHost(String host); /** @@ -71,6 +93,11 @@ */ public String getDestinationHost(); + /** + * Sets the destination host + * + * @param host + */ public void setDestinationHost(String host); /** @@ -80,16 +107,26 @@ */ public MessageType getMessageType(); + /** + * Sets the message type + * + * @param type + */ public void setMessageType(MessageType type); /** * Gets the SOAP message envelope * - * @return + * @return the SOAP message envelope */ public String getEnvelope(); + /** + * Sets the SOAP message envelope + * + * @param envelope + */ public void setEnvelope(String envelope); /** @@ -99,8 +136,19 @@ */ public Map<String, List<String>> getHeaders(); + /** + * Adds a HTTP header to the record + * + * @param key + * @param value + */ public void addHeaders(String key, List<String> value); - + + /** + * Sets the HTTP headers of the record + * + * @param headers + */ public void setHeaders(Map<String, List<String>> headers); /** @@ -110,5 +158,10 @@ */ public QName getOperation(); + /** + * Sets the record's operation + * + * @param operation + */ public void setOperation(QName operation); } Modified: api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordFilter.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordFilter.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordFilter.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -26,7 +26,7 @@ /** * A record filter * - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * @since 8-Dec-2007 */ public interface RecordFilter extends Cloneable, Serializable Modified: api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordGroupAssociation.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordGroupAssociation.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordGroupAssociation.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -1,6 +1,6 @@ /* * JBoss, Home of Professional Open Source. - * Copyright 2006, Red Hat Middleware LLC, and individual contributors + * Copyright 2007, Red Hat Middleware LLC, and individual contributors * as indicated by the @author tags. See the copyright.txt file in the * distribution for a full listing of individual contributors. * @@ -26,9 +26,10 @@ import org.jboss.logging.Logger; /** - * Associates the record group ID with the current thread. + * Associates the record group ID with the current thread. This is implemented internally + * through a static ThreadLocal member. * - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * @since 8-Dec-2007 */ public class RecordGroupAssociation @@ -38,7 +39,11 @@ // provide logging private static Logger log = Logger.getLogger(RecordGroupAssociation.class); - + /** + * Associates the specified groupID to the current thread + * + * @param groupID the groupID to associate to the current thread + */ public static void pushGroupID(String groupID) { if(log.isTraceEnabled()) log.trace("pushGroupID: " + groupID + " (Thread " +Thread.currentThread().getName()+ ")"); @@ -51,6 +56,11 @@ stack.push(groupID); } + /** + * Returns the groupID currently associated to the current thread + * + * @return the current thread groupID + */ public static String peekGroupID() { String groupID = null; @@ -63,6 +73,11 @@ return groupID; } + /** + * Returns the groupID for the current thread and removes the association. + * + * @return thre current thread groupID + */ public static String popGroupID() { String groupID = null; Modified: api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordProcessor.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordProcessor.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/monitoring/RecordProcessor.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -1,6 +1,6 @@ /* * JBoss, Home of Professional Open Source. - * Copyright 2006, Red Hat Middleware LLC, and individual contributors + * Copyright 2007, Red Hat Middleware LLC, and individual contributors * as indicated by the @author tags. See the copyright.txt file in the * distribution for a full listing of individual contributors. * @@ -27,55 +27,165 @@ /** * Processes a record. A RecordProcessor may have filters to allow processing * of records matching given criteria. It also gives users fine management of - * record's attributes to processed. + * record's attributes to be processed. * - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * @since 8-Dec-2007 */ public interface RecordProcessor extends Cloneable, Serializable { + /** + * Returns the current RecordProcessor name + * + * @return the name + */ String getName(); + /** + * Sets the record processor name + * + * @param name the name to set + */ void setName(String name); + /** + * Return true when the record processor is configured for actively recording data; false otherwise + * + * @return a boolean specifying if the recording is on + */ boolean isRecording(); + /** + * Enable / disable actual data recording + * + * @param value true to enable recording, false to disable it + */ void setRecording(boolean value); + /** + * Processes a {@link org.jboss.ws.api.monitoring.Record} instance + * + * @param record the {@link org.jboss.ws.api.monitoring.Record} to process + */ void processRecord(Record record); + /** + * Gets the currently configured {@link org.jboss.ws.api.monitoring.RecordFilter} instances + * + * @return the currently configured {@link org.jboss.ws.api.monitoring.RecordFilter} instances + */ List<RecordFilter> getFilters(); + /** + * Adds a {@link org.jboss.ws.api.monitoring.RecordFilter} to the processor + * + * @param filter the {@link org.jboss.ws.api.monitoring.RecordFilter} instance to add + */ void addFilter(RecordFilter filter); + /** + * Sets the {@link org.jboss.ws.api.monitoring.RecordFilter} instances for the current processor + * + * @param filters the {@link org.jboss.ws.api.monitoring.RecordFilter} instances to set + */ void setFilters(List<RecordFilter> filters); + /** + * Return whether the source host data are being processed + * + * @return true if source host data are being processed, false otherwise + */ boolean isProcessSourceHost(); + /** + * Enable / disable processing of source host + * + * @param value true to enable processing, false to disable it + */ void setProcessSourceHost(boolean value); + /** + * Return whether the destination host data are being processed + * + * @return true if destination host data are being processed, false otherwise + */ boolean isProcessDestinationHost(); + /** + * Enable / disable processing of destination host + * + * @param value true to enable processing, false to disable it + */ void setProcessDestinationHost(boolean value); + /** + * Return whether the message type data are being processed + * + * @return true if message type data are being processed, false otherwise + */ boolean isProcessMessageType(); + /** + * Enable / disable processing of message type + * + * @param value true to enable processing, false to disable it + */ void setProcessMessageType(boolean value); + /** + * Return whether the envelope data are being processed + * + * @return true if envelope data are being processed, false otherwise + */ boolean isProcessEnvelope(); + /** + * Enable / disable processing of envelope + * + * @param value true to enable processing, false to disable it + */ void setProcessEnvelope(boolean value); + /** + * Return whether the headers data are being processed + * + * @return true if headers data are being processed, false otherwise + */ boolean isProcessHeaders(); + /** + * Enable / disable processing of headers + * + * @param value true to enable processing, false to disable it + */ void setProcessHeaders(boolean value); + /** + * Return whether the operation data are being processed + * + * @return true if operation data are being processed, false otherwise + */ boolean isProcessOperation(); + /** + * Enable / disable processing of operation + * + * @param value true to enable processing, false to disable it + */ void setProcessOperation(boolean value); + /** + * Return whether the date data are being processed + * + * @return true if date data are being processed, false otherwise + */ boolean isProcessDate(); + /** + * Enable / disable processing of date + * + * @param value true to enable processing, false to disable it + */ void setProcessDate(boolean value); /** Added: api/trunk/src/main/java/org/jboss/ws/api/monitoring/package.html =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/monitoring/package.html (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/monitoring/package.html 2011-05-10 09:22:13 UTC (rev 14342) @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +<!-- + JBoss, Home of Professional Open Source. + Copyright 2011, Red Hat Middleware LLC, and individual contributors + as indicated by the @author tags. See the copyright.txt file in the + distribution for a full listing of individual contributors. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. +--> +</head> +<body> + +Classes and interfaces for monitoring through collection of records. + +</body> +</html> \ No newline at end of file Modified: api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractConsumer.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractConsumer.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractConsumer.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -44,11 +44,11 @@ public static final String PROVIDER_PROPERTY = "org.jboss.ws.api.tools.ConsumerFactory"; /** - * Obtain a new instance of a WSContractConsumer. This will use the current - * thread's context class loader to locate the WSContractConsumerFactory + * Obtain a new instance of a {@link WSContractConsumer}. This will use the current + * thread's context class loader to locate the {@link WSContractConsumerFactory} * implementation. * - * @return a new WSContractConsumer + * @return a new {@link WSContractConsumer} instance */ public static WSContractConsumer newInstance() { @@ -56,11 +56,11 @@ } /** - * Obtain a new instance of a WSContractConsumer. The specified ClassLoader will be used to - * locate the WebServiceImporterProvide implementation + * Obtain a new instance of a {@link WSContractConsumer}. The specified ClassLoader will be used to + * locate the {@link WSContractConsumerFactory} implementation * * @param loader the ClassLoader to use - * @return a new WSContractConsumer + * @return a new {@link WSContractConsumer} instance */ public static WSContractConsumer newInstance(ClassLoader loader) { Modified: api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractConsumerFactory.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractConsumerFactory.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractConsumerFactory.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -24,17 +24,17 @@ import org.jboss.ws.api.tools.WSContractConsumer; /** - * Creates WSContractConsumer implementations. + * Creates {@link WSContractConsumer} implementations. * * @author <a href="mailto:jason.greene@jboss.com">Jason T. Greene</a> */ public interface WSContractConsumerFactory { /** - * Create a new WSContractConsumer. There are no restrictions on how this + * Create a new {@link WSContractConsumer}. There are no restrictions on how this * should be performed. * - * @return a new WSContractConsumer + * @return a new {@link WSContractConsumer} */ public WSContractConsumer createConsumer(); } Modified: api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProvider.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProvider.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProvider.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -59,11 +59,11 @@ } /** - * Obtain a new instance of a WSContractProvider. This will use the current - * thread's context class loader to locate the WSContractProviderFactory + * Obtain a new instance of a {@link WSContractProvider}. This will use the current + * thread's context class loader to locate the {@link WSContractProviderFactory} * implementation. * - * @return a new WSContractProvider + * @return a new {@link WSContractProvider} */ public static WSContractProvider newInstance() { @@ -71,11 +71,11 @@ } /** - * Obtain a new instance of a WSContractProvider. The specified ClassLoader will be used to - * locate the WSContractProviderFactory implementation + * Obtain a new instance of a {@link WSContractProvider}. The specified ClassLoader will be used to + * locate the {@link WSContractProviderFactory} implementation * * @param loader the ClassLoader to use - * @return a new WSContractProvider + * @return a new {@link WSContractProvider} */ public static WSContractProvider newInstance(ClassLoader loader) { Modified: api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProviderFactory.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProviderFactory.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/tools/WSContractProviderFactory.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -24,20 +24,20 @@ import org.jboss.ws.api.tools.WSContractProvider; /** - * Creates WSContractProvider implementations. + * Creates {@link WSContractProvider} implementations. * * @author <a href="mailto:jason.greene@jboss.com">Jason T. Greene</a> */ public interface WSContractProviderFactory { /** - * Create a new WSContractProvider. There are no restrictions on how this + * Create a new {@link WSContractProvider}. There are no restrictions on how this * should be performed. The passed ClassLoader is the one used in * {@link WSContractProvider#newInstance(ClassLoader)}. This loader - * should be made available to the generated WSContractProvider. + * should be made available to the generated {@link WSContractProvider}. * * @param loader the ClassLoader for type discovery - * @return a new WSContractProvider + * @return a new {@link WSContractProvider} */ public WSContractProvider createProvider(ClassLoader loader); } Added: api/trunk/src/main/java/org/jboss/ws/api/tools/package.html =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/tools/package.html (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/tools/package.html 2011-05-10 09:22:13 UTC (rev 14342) @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +<!-- + JBoss, Home of Professional Open Source. + Copyright 2011, Red Hat Middleware LLC, and individual contributors + as indicated by the @author tags. See the copyright.txt file in the + distribution for a full listing of individual contributors. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. +--> +</head> +<body> + +JBossWS interfaces for JAX-WS tooling + +</body> +</html> \ No newline at end of file Modified: api/trunk/src/main/java/org/jboss/ws/api/util/DOMUtils.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/util/DOMUtils.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/util/DOMUtils.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -57,8 +57,8 @@ /** * Basic DOM2 utilities * - * @author alessio.soldano(a)jboss.com - * @author Thomas.Diesler(a)jboss.org + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> + * @author <a href="mailto:Thomas.Diesler@jboss.org">Thomas Diesler</a> * */ public abstract class DOMUtils Modified: api/trunk/src/main/java/org/jboss/ws/api/util/ServiceLoader.java =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/util/ServiceLoader.java 2011-05-10 08:04:40 UTC (rev 14341) +++ api/trunk/src/main/java/org/jboss/ws/api/util/ServiceLoader.java 2011-05-10 09:22:13 UTC (rev 14342) @@ -36,10 +36,23 @@ import java.util.concurrent.ConcurrentHashMap; /** - * Load a service class using this ordered lookup procedure + * Load a service class of a given name using this ordered lookup procedure: + * <ol> + * <li>If a resource file with the given name is found in META-INF/services/..., then + * its first line, if present, is used as the UTF-8 encoded name of the implementation class.</li> + * + * <li>If the ${java.home}/lib/jaxws.properties file exists and it is readable by the + * java.util.Properties.load(InputStream) method and it contains an entry whose key is + * the given name, then the value of that entry is used as the name of the implementation class.</li> + * + * <li>If a system property with the given name is defined, then its value is used + * as the name of the implementation class.</li> + * + * <li>Finally, a default implementation class name is used.</li> + * </ol> * - * @author Thomas.Diesler(a)jboss.com - * @author alessio.soldano(a)jboss.com + * @author <a href="mailto:Thomas.Diesler@jboss.com">Thomas Diesler</a> + * @author <a href="mailto:alessio.soldano@jboss.com">Alessio Soldano</a> * @since 14-Dec-2006 */ public final class ServiceLoader @@ -60,7 +73,7 @@ /** * This method uses the algorithm below using the JAXWS Provider as an example. - * + * <pre> * 1. If a resource with the name of META-INF/services/javax.xml.ws.spi.Provider exists, then * its first line, if present, is used as the UTF-8 encoded name of the implementation class. * @@ -72,6 +85,7 @@ * as the name of the implementation class. * * 4. Finally, a default implementation class name is used. + * </pre> * * @param propertyName The property name for the service to resolve * @param defaultFactory Default factory class name to be used when not able to resolve anything @@ -94,7 +108,7 @@ /** * This method uses the algorithm below using the JAXWS Provider as an example. - * + * <pre> * 1. If a resource with the name of META-INF/services/javax.xml.ws.spi.Provider exists, then * its first line, if present, is used as the UTF-8 encoded name of the implementation class. * @@ -106,8 +120,9 @@ * as the name of the implementation class. * * 4. Finally, a default implementation class name is used. + * </pre> * - * This is equivalent to calling {@link loadService(String propertyName, String defaultFactory, ClassLoader cl)} + * This is equivalent to calling {@link #loadService(String propertyName, String defaultFactory, ClassLoader cl)} * passing in the Thread.currentThread().getContextClassLoader(). * * @param propertyName The property name for the service to resolve Added: api/trunk/src/main/java/org/jboss/ws/api/util/package.html =================================================================== --- api/trunk/src/main/java/org/jboss/ws/api/util/package.html (rev 0) +++ api/trunk/src/main/java/org/jboss/ws/api/util/package.html 2011-05-10 09:22:13 UTC (rev 14342) @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +<!-- + JBoss, Home of Professional Open Source. + Copyright 2011, Red Hat Middleware LLC, and individual contributors + as indicated by the @author tags. See the copyright.txt file in the + distribution for a full listing of individual contributors. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. +--> +</head> +<body> + +Convenient utilities + +</body> +</html> \ No newline at end of file