com.sun.xml.ws.rx.RxConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webservices-rt Show documentation

This module contains the Metro runtime code.

There is a newer version: 4.0.4

/*
 * 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.rx;

import com.sun.xml.ws.api.SOAPVersion;
import com.sun.xml.ws.api.addressing.AddressingVersion;
import com.sun.xml.ws.api.ha.HighAvailabilityProvider;
import com.sun.xml.ws.rx.mc.api.MakeConnectionSupportedFeature;
import com.sun.xml.ws.rx.rm.api.ReliableMessagingFeature;
import org.glassfish.gmbal.ManagedObjectManager;

/**
 * Common base for WS-RX technology configuration
 *
 * @author Marek Potociar (marek.potociar at sun.com)
 */
public interface RxConfiguration {
    public static final String ACK_REQUESTED_HEADER_SET = RxConfiguration.class.getName() + ".ACK_REQUESTED_HEADER_SET";
    
    /**
     * @see ReliableMessagingFeature
     */
    public boolean isReliableMessagingEnabled();
    
    /**
     * @see MakeConnectionSupportedFeature
     */
    public boolean isMakeConnectionSupportEnabled();

    /**
     * Provides information about the SOAP protocol version used on the endpoint.
     * 
     * @return the SOAP protocol version used on the RM-enabled endpoint
     */
    public SOAPVersion getSoapVersion();

    /**
     * Provides information about the WS-Addressing protocol version used on the endpoint.
     * 
     * @return the WS-Addressing protocol version used on the RM-enabled endpoint
     */
    public AddressingVersion getAddressingVersion();
    
    /**
     * Provides information if the port, which this configuration belongs to, has 
     * any request/response operations.
     *
     * @return {@code true} in case the port has any request/response operations; {@code false} otherwise
     */
    public boolean requestResponseOperationsDetected();
    
    /**
     * Returns GMBAL/JMX manager
     *
     * @return GMBAL/JMX manager. May return null.
     */
    public ManagedObjectManager getManagedObjectManager();
}