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.api.handler;
ohair@286: 
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: import com.sun.xml.internal.ws.api.WSBinding;
ohair@286: import com.sun.xml.internal.ws.api.message.Message;
ohair@286: import com.sun.xml.internal.ws.api.model.SEIModel;
ohair@286: import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort;
ohair@286: 
ohair@286: import javax.xml.ws.handler.MessageContext;
ohair@286: import java.util.Set;
ohair@286: 
ohair@286: /**
ohair@286:  * The <code>MessageHandlerContext</code> interface extends
ohair@286:  * <code>MessageContext</code> to provide easy access to the contained message.
ohair@286:  *
ohair@286:  * This context provides access to RI's <code>Message</code> model for efficient access
ohair@286:  * to various things like accessing headers etc. It also provides access to
ohair@286:  * binding information as <code>WSBinding</code>.
ohair@286:  *
ohair@286:  * @author Rama Pulavarthi
ohair@286:  * @since JAX-WS 2.1.3
ohair@286:  */
ohair@286: public interface MessageHandlerContext extends MessageContext {
ohair@286:     /**
ohair@286:      * Gets the message from this message context
ohair@286:      *
ohair@286:      * @return The contained message; returns <code>null</code> if no
ohair@286:      *         message is present in this message context
ohair@286:      */
ohair@286:     public Message getMessage();
ohair@286: 
ohair@286: 
ohair@286:     /**
ohair@286:      * Sets the message in this message context
ohair@286:      */
ohair@286:     public void setMessage(Message message);
ohair@286: 
ohair@286:     /**
ohair@286:      * @see javax.xml.ws.handler.soap.SOAPMessageContext#getRoles()
ohair@286:      */
ohair@286:      public Set<String> getRoles();
ohair@286: 
ohair@286: 
ohair@286:     /**
ohair@286:      * Provides access to <code>WSBinding</code> which can be used in various ways.
ohair@286:      * for example: <code>WSBinding#getSOAPVersion</code> to get SOAP version of the binding.
ohair@286:      *              <code>WSBinding#isFeatureEnabled(AddressingFeature)</code> to check if addressing is enabled
ohair@286:      */
ohair@286:     public WSBinding getWSBinding();
ohair@286: 
ohair@286:     /**
ohair@286:      * Provides access to <code>SEIModel</code>.
ohair@286:      */
ohair@286:     public @Nullable SEIModel getSEIModel();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the {@link WSDLPort} that represents the port.
ohair@286:      * @return
ohair@286:      *      returns the WSDLModel of the port that the client/endpoint binds to.
ohair@286:      *      null when the Service is not configured with WSDL information.
ohair@286:      */
ohair@286:     public @Nullable WSDLPort getPort();
ohair@286: 
ohair@286: }