#
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
#
# Copyright (c) 2011 Oracle and/or its affiliates. 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
# http://glassfish.java.net/public/CDDL+GPL_1_1.html
# or packager/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 packager/legal/LICENSE.txt.
#
# GPL Classpath Exception:
# Oracle designates this particular file as subject to the "Classpath"
# exception as provided by Oracle in the GPL Version 2 section of the License
# file that accompanied this code.
#
# Modifications:
# If applicable, add the following below the License Header, with the fields
# enclosed by brackets [] replaced by your own identifying information:
# "Portions Copyright [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.
#

custom-tubes sample demonstrates the proprietary extension mechanism for injecting 
custom Tube implementations into the default Metro tubeline.

This sample requires Metro 2.1 or later.

- For integration of a custom tube into Metro, see the content of the etc/metro.xml 
configuration file.
- For a basic custom tube implementation see Java files under src/metro_sample/common
directory

After a successful execution of the sample, you should see a similar output:
- Server side (in the <glassfish-domain>/logs/server.log) :

[#|2011-02-01T12:17:11.030+0100|INFO|glassfish3.1|metro_sample.common.CustomTube|_ThreadID=19;_ThreadName=Thread-1;|Message request intercepted on Endpoint side|#]

[#|2011-02-01T12:17:11.037+0100|INFO|glassfish3.1|metro_sample.common.CustomTube|_ThreadID=19;_ThreadName=Thread-1;|Message response intercepted on Endpoint side|#]

[#|2011-02-01T12:17:11.058+0100|INFO|glassfish3.1|metro_sample.common.CustomTube|_ThreadID=20;_ThreadName=Thread-1;|Message request intercepted on Endpoint side|#]

[#|2011-02-01T12:17:11.058+0100|INFO|glassfish3.1|metro_sample.common.CustomTube|_ThreadID=20;_ThreadName=Thread-1;|Message response intercepted on Endpoint side|#]

[#|2011-02-01T12:17:11.069+0100|INFO|glassfish3.1|metro_sample.common.CustomTube|_ThreadID=21;_ThreadName=Thread-1;|Message request intercepted on Endpoint side|#]

[#|2011-02-01T12:17:11.070+0100|INFO|glassfish3.1|metro_sample.common.CustomTube|_ThreadID=21;_ThreadName=Thread-1;|Message response intercepted on Endpoint side|#]


- Client side (in the console):

Custom tubes sample application
===============================

Feb 1, 2011 12:24:33 PM metro_sample.common.CustomTubeFactory createTube
INFO: Creating client-side interceptor tube
[ Client ]: Adding numbers 10 + 20
Feb 1, 2011 12:24:33 PM metro_sample.common.CustomTube processRequest
INFO: Message request intercepted on Client side
Feb 1, 2011 12:24:33 PM metro_sample.common.CustomTube processResponse
INFO: Message response intercepted on Client side
[ Client ]: Result as expected: 30


[ Client ]: Adding numbers 20 + 40
Feb 1, 2011 12:24:33 PM metro_sample.common.CustomTube processRequest
INFO: Message request intercepted on Client side
Feb 1, 2011 12:24:33 PM metro_sample.common.CustomTube processResponse
INFO: Message response intercepted on Client side
[ Client ]: Result as expected: 60


[ Client ]: Adding numbers 30 + 60
Feb 1, 2011 12:24:33 PM metro_sample.common.CustomTube processRequest
INFO: Message request intercepted on Client side
Feb 1, 2011 12:24:33 PM metro_sample.common.CustomTube processResponse
INFO: Message response intercepted on Client side
[ Client ]: Result as expected: 90


[ Client ]: Closing WS proxy...DONE.


Sample directory content:

* etc - configuration files
    * AddNumbers.wsdl wsdl file
    * deploy-targets.xml ant script to deploy the endpoint
      war file
    * metro.xml customized tubeline descriptor
    * sun-jaxws.xml deployment descriptor for web container
* src source files
    * metro_sample/client/AddNumbersClient.java - client application
    * metro_sample/server/AddNumberImpl.java - server implementation
    * metro_sample/common/*.java - custom tube and tube factory implementations

* wsimport ant task is run to compile etc/AddNumbers.wsdl
    * generates
      SEI - AddNumbersPortType
      service class - AddNumbersService
      and exception class - AddNumbersFault_Exception

* To run
    * set METRO_HOME to the Metro installation directory
    * ant clean server - runs wsimport to compile AddNumbers.wsdl and generate
      server side artifacts and does the deployment
    * ant clean client run - runs wsimport on the published wsdl by the deployed
      endpoint, compiles the generated artifacts and the client application
      then executes it.

* Prerequisites

Refer to the Prerequisites defined in samples/docs/index.html.

We appreciate your feedback, please send it to users@metro.java.net.