org.objectstyle.cayenne.remote.BaseConnection Maven / Gradle / Ivy

Go to download
/* ====================================================================
 * 
 * The ObjectStyle Group Software License, version 1.1
 * ObjectStyle Group - http://objectstyle.org/
 * 
 * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
 * of the software. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The end-user documentation included with the redistribution, if any,
 *    must include the following acknowlegement:
 *    "This product includes software developed by independent contributors
 *    and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 * 
 * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
 *    or promote products derived from this software without prior written
 *    permission. For written permission, email
 *    "andrus at objectstyle dot org".
 * 
 * 5. Products derived from this software may not be called "ObjectStyle"
 *    or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
 *    names without prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by many
 * individuals and hosted on ObjectStyle Group web site.  For more
 * information on the ObjectStyle Group, please see
 * .
 */
package org.objectstyle.cayenne.remote;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.objectstyle.cayenne.CayenneRuntimeException;

/**
 * A common base class for concrete ClientConnection implementations. Provides message
 * logging functionality via commons-logging.
 * 
 * @since 1.2
 * @author Andrus Adamchik
 */
public abstract class BaseConnection implements ClientConnection {

    protected Log logger;
    protected long messageId;

    /**
     * Default constructor that initializes logging and a single threaded EventManager.
     */
    protected BaseConnection() {
        this.logger = LogFactory.getLog(getClass());
    }

    /**
     * Invokes 'beforeSendMessage' on self, then invokes 'doSendMessage'. Implements basic
     * logging functionality. Do not override this method unless absolutely necessary.
     * Override 'beforeSendMessage' and 'doSendMessage' instead.
     */
    public Object sendMessage(ClientMessage message) throws CayenneRuntimeException {
        if (message == null) {
            throw new NullPointerException("Null message");
        }

        beforeSendMessage(message);

        // log start...
        long t0 = 0;
        String messageLabel = "";

        // using sequential number for message id ... it can be useful for some basic
        // connector stats.
        long messageId = this.messageId++;

        if (logger.isInfoEnabled()) {
            t0 = System.currentTimeMillis();
            messageLabel = message.toString();
            logger.info("--- Message " + messageId + ": " + messageLabel);
        }

        Object response;
        try {
            response = doSendMessage(message);
        }
        catch (CayenneRuntimeException e) {

            // log error
            if (logger.isInfoEnabled()) {
                long time = System.currentTimeMillis() - t0;
                logger.info("*** Message error for "
                        + messageId
                        + ": "
                        + messageLabel
                        + " - took "
                        + time
                        + " ms.");
            }

            throw e;
        }

        // log success...
        if (logger.isInfoEnabled()) {
            long time = System.currentTimeMillis() - t0;
            logger.info("=== Message "
                    + messageId
                    + ": "
                    + messageLabel
                    + " done - took "
                    + time
                    + " ms.");
        }

        return response;
    }

    /**
     * Returns a count of processed messages since the beginning of life of this
     * connector.
     */
    public long getProcessedMessagesCount() {
        return messageId + 1;
    }

    /**
     * Called before logging the beginning of message processing.
     */
    protected abstract void beforeSendMessage(ClientMessage message)
            throws CayenneRuntimeException;

    /**
     * The worker method invoked to process message.
     */
    protected abstract Object doSendMessage(ClientMessage message)
            throws CayenneRuntimeException;
}