org.apache.axis2.format.TextMessageBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of axis2-transport-base Show documentation

Apache Axis2 - Base Transport

There is a newer version: 1.8.2

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

import java.io.Reader;

import org.apache.axiom.om.OMElement;
import org.apache.axis2.AxisFault;
import org.apache.axis2.builder.Builder;
import org.apache.axis2.context.MessageContext;

/**
 * Message builder able to build messages from a character stream.
 * This interface can be optionally implemented by {@link Builder}
 * implementations that support building a message from a character
 * stream.
 * 
 * The character stream can either be provided as a string or a
 * {@link Reader} object. The caller should use a {@link Reader} object
 * except if the content of the message is available as a string anyway.
 * 
 * This interface is currently used by the JMS transport to process
 * {@link javax.jms.TextMessage} instances.
 */
public interface TextMessageBuilder extends Builder {
    public OMElement processDocument(Reader reader, String contentType,
            MessageContext messageContext) throws AxisFault;
    
    public OMElement processDocument(String content, String contentType,
            MessageContext messageContext) throws AxisFault;
}