org.switchyard.runtime.util.ExchangeFormatter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 Red Hat Inc. and/or its affiliates and other contributors.
 *
 * 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 org.switchyard.runtime.util;

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.Reader;
import java.io.StringReader;
import java.util.Comparator;
import java.util.Set;
import java.util.TreeSet;

import org.switchyard.Exchange;
import org.switchyard.Message;
import org.switchyard.Property;
import org.switchyard.Scope;
import org.switchyard.common.lang.Strings;

/**
 * Implementation class that facilitates print formatting of Switchyard exchanges.
 * The Exchange contents (header and body) are formatted to facilitate
 * easier display/logging.
 */
public final class ExchangeFormatter {
    private static final String INDENT = System.getProperty("line.separator");

    /**
     * Format contents of an incoming exchange.
     * 
     * @param exchange Exchange instance.
     * @param printBody boolean. 
     * 
     * @return String containing formatted Exchange data.
     */    
    public static String format(Exchange exchange, boolean printBody) {
        StringBuilder summary = new StringBuilder()
            .append(indent(0) + "------- Begin Message Trace -------");

        summary.append(formatHeaders(exchange));
        if (printBody) {
            summary.append(formatBody(exchange));
        }
        summary.append(indent(0) + "------ End Message Trace -------");

        return summary.toString();
    }
    
    private static String formatHeaders(Exchange exchange) {
        StringBuilder headers = new StringBuilder()
            .append(indent(0) + "Consumer -> " + exchange.getConsumer().getName())
            .append(indent(0) + "Provider -> " + ((exchange.getProvider() == null) ? "[unassigned]" : exchange.getProvider().getName()))
            .append(indent(0) + "Operation -> " + exchange.getContract().getConsumerOperation().getName())
            .append(indent(0) + "MEP -> " 
                + ((exchange.getContract().getConsumerOperation().getExchangePattern() == null) ? "[unassigned]" : exchange.getContract().getConsumerOperation().getExchangePattern()))
            .append(indent(0) + "Phase -> " + exchange.getPhase())
            .append(indent(0) + "State -> " + exchange.getState());
        
        // Add context properties
        headers.append(indent(0) + "Exchange Context -> ");
        dumpContext(headers, exchange.getContext().getProperties(Scope.EXCHANGE));
    
        headers.append(indent(0) + "Message Context -> ");
        dumpContext(headers, exchange.getContext().getProperties(Scope.MESSAGE));
        
        return headers.toString();
    }

    private static String formatBody(Exchange exchange) {
        StringBuilder body = new StringBuilder();
        
        // Add message content
        String content = null;
        try {
            // try to convert the payload to a string
            Message msg = exchange.getMessage();
            content = msg.getContent(String.class);
            
            // check to see if we have to put content back into the message 
            // after the conversion to string
            if (InputStream.class.isAssignableFrom(msg.getContent().getClass())) {
                msg.setContent(new ByteArrayInputStream(content.getBytes()));
            } else if (Reader.class.isAssignableFrom(msg.getContent().getClass())) {
                msg.setContent(new StringReader(content));
            }
        } catch (Exception ex) {
            // conversion failed, fall back on toString()
            if (exchange.getMessage().getContent() != null) {
                content = exchange.getMessage().getContent().toString();
            }
        }
        body.append(indent(0) + "Message Content -> ")
            .append(indent(0) + content);
        
        return body.toString();
    }
    
    private static void dumpContext(StringBuilder summary, Set properties) {
        Set orderedProperties = new TreeSet(new Comparator() {
            public int compare(Property p1, Property p2) {
                return p1.getName().compareTo(p2.getName());
            }
        });
        int maxLength = 0;
        for (Property property : properties) {
            int curLength = property.getName().length();
            if (curLength > maxLength) {
                maxLength = curLength;
            }
            orderedProperties.add(property);
        }
        for (Property orderedProperty : orderedProperties) {
            String name = orderedProperty.getName();
            int difLength = maxLength - name.length();
            String pad = difLength > 0 ? Strings.repeat(".", difLength) : "";
            summary.append(indent(1) + name + " " + pad + ": " + orderedProperty.getValue());
        }
    }
    
    private static String indent(int column) {
        return INDENT + Strings.repeat("    ", column);
    }
    
    private ExchangeFormatter() {
        // noop
    }

}