IncomingCommandTrace.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.rhq.enterprise.communications.command.server;

import java.io.NotSerializableException;

import mazz.i18n.Logger;

import org.rhq.enterprise.communications.command.Command;
import org.rhq.enterprise.communications.i18n.CommI18NFactory;
import org.rhq.enterprise.communications.i18n.CommI18NResourceKeys;
import org.rhq.enterprise.communications.util.CommandTraceUtil;

/**
 * Object that will log incoming commands, used mainly for debugging a remoting endpoint.
 *
 * @author John Mazzitelli
 */
public class IncomingCommandTrace {
    private static final Logger LOG = CommI18NFactory.getLogger(IncomingCommandTrace.class);

    /**
     * Call this when the command is just received since being delivered over the wire.
     * 
     * @param command the command that was just sent.
     */
    public static void start(Command command) {
        if (LOG.isTraceEnabled()) {
            try {
                String cmdStr = CommandTraceUtil.getCommandString(command);
                String config = CommandTraceUtil.getConfigString(command);
                LOG.trace(CommI18NResourceKeys.TRACE_INCOMING_COMMAND_START, cmdStr, config);

                try {
                    int size = CommandTraceUtil.getCommandSize(command);
                    if (size > -1) {
                        LOG.warn(CommI18NResourceKeys.TRACE_SIZE_THRESHOLD_EXCEEDED_COMMAND, cmdStr, size);
                    }
                } catch (NotSerializableException nse) {
                    LOG.error(CommI18NResourceKeys.TRACE_NOT_SERIALIZABLE_COMMAND, cmdStr, nse);
                }
            } catch (Throwable t) {
                // don't bomb if for some reason we fail to log the trace message (should never happen)
            }
        }
    }

    /**
     * Call this when the command is finished - that is, after the command has been
     * processed and its response is about to be returned.
     * 
     * @param command the command that has just finished
     * @param response the response object that is going to be sent back to the client
     */
    public static void finish(Command command, Object response) {
        if (LOG.isTraceEnabled()) {
            try {
                String cmdStr = CommandTraceUtil.getCommandString(command);
                String config = CommandTraceUtil.getConfigString(command);
                String respStr = CommandTraceUtil.getCommandResponseString(response);
                LOG.trace(CommI18NResourceKeys.TRACE_INCOMING_COMMAND_FINISH, cmdStr, config, respStr);

                try {
                    int size = CommandTraceUtil.getCommandResponseSize(response);
                    if (size > -1) {
                        LOG.warn(CommI18NResourceKeys.TRACE_SIZE_THRESHOLD_EXCEEDED_COMMAND_RESPONSE, respStr, size);
                    }
                } catch (NotSerializableException nse) {
                    LOG.error(CommI18NResourceKeys.TRACE_NOT_SERIALIZABLE_COMMAND_RESPONSE, respStr, nse);
                }

            } catch (Throwable t) {
                // don't bomb if for some reason we fail to log the trace message (should never happen)
            }
        }
    }
}