001/**
002 *
003 * Copyright the original author or authors
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smack.debugger;
018
019import java.io.PrintWriter;
020import java.io.StringWriter;
021import java.text.SimpleDateFormat;
022import java.util.Date;
023
024import org.jivesoftware.smack.XMPPConnection;
025
026/**
027 * Very simple debugger that prints to the console (stdout) the sent and received stanzas. Use
028 * this debugger with caution since printing to the console is an expensive operation that may
029 * even block the thread since only one thread may print at a time.
030 * <p>
031 * It is possible to not only print the raw sent and received stanzas but also the interpreted
032 * packets by Smack. By default interpreted packets won't be printed. To enable this feature
033 * just change the <tt>printInterpreted</tt> static variable to <tt>true</tt>.
034 * </p>
035 *
036 * @author Gaston Dombiak
037 */
038public class ConsoleDebugger extends AbstractDebugger {
039    private final SimpleDateFormat dateFormatter = new SimpleDateFormat("HH:mm:ss");
040
041    public ConsoleDebugger(XMPPConnection connection) {
042        super(connection);
043    }
044
045    @Override
046    protected void log(String logMessage) {
047        String formatedDate;
048        synchronized (dateFormatter) {
049            formatedDate = dateFormatter.format(new Date());
050        }
051        // CHECKSTYLE:OFF
052        System.out.println(formatedDate + ' ' + logMessage);
053        // CHECKSTYLE:ON
054    }
055
056    @Override
057    protected void log(String logMessage, Throwable throwable) {
058        StringWriter sw = new StringWriter();
059        PrintWriter pw = new PrintWriter(sw);
060        // CHECKSTYLE:OFF
061        throwable.printStackTrace(pw);
062        // CHECKSTYLE:ON
063        log(logMessage + sw);
064    }
065
066    public static final class Factory implements SmackDebuggerFactory {
067
068        public static final SmackDebuggerFactory INSTANCE = new Factory();
069
070        private Factory() {
071        }
072
073        @Override
074        public SmackDebugger create(XMPPConnection connection) throws IllegalArgumentException {
075            return new ConsoleDebugger(connection);
076        }
077
078    }
079}