com.sun.xml.ws.api.handler.MessageHandlerContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of runtime Show documentation

JAX-WS Runtime with module descriptor

There is a newer version: 4.0.2

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.ws.api.handler;

import com.sun.istack.Nullable;
import com.sun.xml.ws.api.WSBinding;
import com.sun.xml.ws.api.message.Message;
import com.sun.xml.ws.api.model.SEIModel;
import com.sun.xml.ws.api.model.wsdl.WSDLPort;

import javax.xml.ws.handler.MessageContext;
import java.util.Set;

/**
 * The MessageHandlerContext interface extends
 * MessageContext to provide easy access to the contained message.
 *
 * This context provides access to RI's Message model for efficient access
 * to various things like accessing headers etc. It also provides access to
 * binding information as WSBinding.
 *
 * @author Rama Pulavarthi
 * @since JAX-WS 2.1.3
 */
public interface MessageHandlerContext extends MessageContext {
    /**
     * Gets the message from this message context
     *
     * @return The contained message; returns null if no
     *         message is present in this message context
     */
    public Message getMessage();

    
    /**
     * Sets the message in this message context
     */
    public void setMessage(Message message);

    /**
     * @see javax.xml.ws.handler.soap.SOAPMessageContext#getRoles()
     */
     public Set getRoles();


    /**
     * Provides access to WSBinding which can be used in various ways.
     * for example: WSBinding#getSOAPVersion to get SOAP version of the binding.
     *              WSBinding#isFeatureEnabled(AddressingFeature) to check if addressing is enabled
     */
    public WSBinding getWSBinding();

    /**
     * Provides access to SEIModel.
     */
    public @Nullable SEIModel getSEIModel();

    /**
     * Gets the {@link WSDLPort} that represents the port.
     * @return
     *      returns the WSDLModel of the port that the client/endpoint binds to.
     *      null when the Service is not configured with WSDL information.
     */
    public @Nullable WSDLPort getPort();
   
}