All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.cxf.ws.addressing.AddressingProperties Maven / Gradle / Ivy

There is a newer version: 2.7.18
Show newest version
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.cxf.ws.addressing;

import java.util.List;

import javax.xml.namespace.QName;


/**
 * Abstraction of Message Addressing Properties. 
 */
public interface AddressingProperties extends AddressingType {
    /**
     * Accessor for the To property.
     * @return current value of To property
     */
    EndpointReferenceType getToEndpointReference();
    
    /**
     * Accessor for the To property.
     * @return current value of To property
     */
    AttributedURIType getTo();

    /**
     * Mutator for the To property.
     * @param epr new value for To property
     */
    void setTo(EndpointReferenceType epr);
    
    /**
     * Mutator for the To property.
     * @param epr new value for To property
     */
    void setTo(AttributedURIType epr);

    /**
     * Accessor for the From property.
     * @return current value of From property
     */
    EndpointReferenceType getFrom();

    /**
     * Mutator for the From property.
     * @param epr new value for From property
     */
    void setFrom(EndpointReferenceType epr);

    /**
     * Accessor for the MessageID property.
     * @return current value of MessageID property
     */
    AttributedURIType getMessageID();

    /**
     * Mutator for the MessageID property.
     * @param iri new value for MessageID property
     */
    void setMessageID(AttributedURIType iri);

    /**
     * Accessor for the ReplyTo property.
     * @return current value of ReplyTo property
     */
    EndpointReferenceType getReplyTo();

    /**
     * Mutator for the ReplyTo property.
     * @param ref new value for ReplyTo property
     */
    void setReplyTo(EndpointReferenceType ref);
    
    /**
     * Accessor for the FaultTo property.
     * @return current value of FaultTo property
     */
    EndpointReferenceType getFaultTo();

    /**
     * Mutator for the FaultTo property.
     * @param ref new value for FaultTo property
     */
    void setFaultTo(EndpointReferenceType ref);


    /**
     * Accessor for the RelatesTo property.
     * @return current value of RelatesTo property
     */
    RelatesToType getRelatesTo();

    /**
     * Mutator for the RelatesTo property.
     * @param relatesTo new value for RelatesTo property
     */
    void setRelatesTo(RelatesToType relatesTo);
    
    /**
     * Accessor for the Action property.
     * @return current value of Action property
     */
    AttributedURIType getAction();

    /**
     * Mutator for the Action property.
     * @param iri new value for Action property
     */
    void setAction(AttributedURIType iri);
    
    /**
     * Used to specify a different WS-Addressing namespace URI, 
     * so as to cause MAPs to be exposed (i.e. encoded in externalized
     * message with a different WS-Addressing version).
     */
    void exposeAs(String uri);
    
    
    AddressingProperties createCompatibleResponseProperties();
    
    QName getDuplicate();
    void setDuplicate(QName qn);
    List getMustUnderstand();

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy