ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, 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;
ohair@286: 
ohair@286: import javax.xml.ws.WebServiceException;
ohair@286: import javax.xml.ws.Dispatch;
ohair@286: import java.io.IOException;
ohair@286: 
ohair@286: /**
ohair@286:  * Closeable JAX-WS proxy object.
ohair@286:  *
ohair@286:  * @author Kohsuke Kawaguchi
ohair@286:  * @since JAX-WS 2.0.2
ohair@286:  */
ohair@286: // this interface is exposed to applications.
ohair@286: public interface Closeable extends java.io.Closeable {
ohair@286:     /**
ohair@286:      * Closes this object and cleans up any resources
ohair@286:      * it holds, such as network connections.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * This interface is implemented by a port proxy
ohair@286:      * or {@link Dispatch}. In particular, this signals
ohair@286:      * the implementation of certain specs (like WS-ReliableMessaging
ohair@286:      * and WS-SecureConversation) to terminate sessions that they
ohair@286:      * create during the life time of a proxy object.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * This is not a mandatory operation, so the application
ohair@286:      * does not have to call this method.
ohair@286:      *
ohair@286:      *
ohair@286:      * @throws WebServiceException
ohair@286:      *      If clean up fails unexpectedly, this exception
ohair@286:      *      will be thrown (instead of {@link IOException}.
ohair@286:      */
ohair@286:     public void close() throws WebServiceException;
ohair@286: }