com.prowidesoftware.swift.io.ConversionService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pw-swift-core Show documentation
Prowide Core Libraries for SWIFT (TM) messages
There is a newer version: SRU2023-10.1.16
/*
 * Copyright 2006-2023 Prowide
 *
 * Licensed 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 com.prowidesoftware.swift.io;

import com.prowidesoftware.ProwideException;
import com.prowidesoftware.swift.io.parser.XMLParser;
import com.prowidesoftware.swift.io.writer.SwiftWriter;
import com.prowidesoftware.swift.io.writer.XMLWriterVisitor;
import com.prowidesoftware.swift.model.SwiftMessage;
import java.io.IOException;
import java.io.StringWriter;
import java.util.Objects;

/**
 * This interface provides a general conversion service between three different formats:
 * 
 *   FIN: SWIFT raw format for MT messages (ISO 15022).
 *   XML: A proprietary XML representation of SWIFT MT messages.
 *   SwiftMessage: Java model of SWIFT MT messages.
 * 
 * This class may be used as a serializer.
 * 
All methods in this class are thread safe.
 */
public class ConversionService implements IConversionService {

    /**
     * Given a SwiftMessage object returns a String containing its SWIFT message representation.
     * The implementation ensures all line breaks use CRLF, and ignores all empty blocks.
     *
     * @see com.prowidesoftware.swift.io.IConversionService#getFIN(com.prowidesoftware.swift.model.SwiftMessage)
     */
    @Override
    public String getFIN(final SwiftMessage msg) {
        Objects.requireNonNull(msg);

        final StringWriter writer = new StringWriter();
        SwiftWriter.writeMessage(msg, writer, true);
        final String fin = writer.getBuffer().toString();

        // ensure EOLs in the result
        return SwiftWriter.ensureEols(fin);
    }

    /**
     * Given a String containing a message in its Wife XML internal representation, returns a String
     * containing its SWIFT message representation.
     *
     * @see com.prowidesoftware.swift.io.IConversionService#getFIN(java.lang.String)
     */
    @Override
    public String getFIN(final String xml) {
        Objects.requireNonNull(xml);
        final SwiftMessage msg = getMessageFromXML(xml);
        if (msg == null) {
            throw new ProwideException("parsed SwiftMessage from XML is null");
        }
        return getFIN(msg);
    }

    /**
     * Given a SwiftMessage objects returns a String containing WIFE internal XML representation of the message.
     *
     * @see com.prowidesoftware.swift.io.IConversionService#getXml(com.prowidesoftware.swift.model.SwiftMessage)
     */
    @Override
    public String getXml(final SwiftMessage msg) {
        return getXml(msg, false);
    }

    /**
     * Given a SwiftMessage objects returns a String containing WIFE internal XML representation of the message.
     *
     * @since 7.6
     */
    public String getXml(final SwiftMessage msg, final boolean useField) {
        Objects.requireNonNull(msg);
        final StringWriter w = new StringWriter();
        msg.visit(new XMLWriterVisitor(w, useField));
        return w.getBuffer().toString();
    }

    @Override
    public String getXml(final String fin) {
        return getXml(fin, false);
    }

    public String getXml(final String fin, final boolean useField) {
        Objects.requireNonNull(fin);
        final SwiftMessage msg = this.getMessageFromFIN(fin);
        return getXml(msg, useField);
    }

    @Override
    public SwiftMessage getMessageFromFIN(final String fin) {
        Objects.requireNonNull(fin);
        try {
            return SwiftMessage.parse(fin);
        } catch (final IOException e) {
            throw new ProwideException(e + " during parse of message");
        }
    }

    /**
     * Given a String containing a message in its WIFE internal XML representation, returns a SwiftMessage object.
     *
     * @see com.prowidesoftware.swift.io.IConversionService#getMessageFromXML(java.lang.String)
     */
    @Override
    public SwiftMessage getMessageFromXML(final String xml) {
        return new XMLParser().parse(xml);
    }
}