001/**
002 *
003 * Copyright 2014 Vyacheslav Blinov
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 */
017
018package org.jivesoftware.smackx.debugger.slf4j;
019
020import java.io.Reader;
021import java.io.Writer;
022import java.util.concurrent.atomic.AtomicBoolean;
023
024import org.jivesoftware.smack.SmackConfiguration;
025import org.jivesoftware.smack.StanzaListener;
026import org.jivesoftware.smack.XMPPConnection;
027import org.jivesoftware.smack.debugger.SmackDebugger;
028import org.jivesoftware.smack.util.ObservableReader;
029import org.jivesoftware.smack.util.ObservableWriter;
030
031import org.jxmpp.jid.EntityFullJid;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * Implementation of SmackDebugger that writes log messages using SLF4J API.
038 * Use in conjunction with your SLF4J bindings of choice.
039 * See SLF4J manual for more details about bindings usage.
040 */
041public class SLF4JSmackDebugger implements SmackDebugger  {
042    public static final String LOGGER_NAME = "SMACK";
043    private static final Logger logger = LoggerFactory.getLogger(LOGGER_NAME);
044    public static final AtomicBoolean printInterpreted = new AtomicBoolean(true);
045
046    public static final String SENT_TAG = "SENT";
047    public static final String RECEIVED_TAG = "RECV";
048
049    private final XMPPConnection connection;
050
051    private final StanzaListener receivedListener = new SLF4JLoggingPacketListener(logger, RECEIVED_TAG);
052    private final StanzaListener sentListener = new SLF4JLoggingPacketListener(logger, SENT_TAG);
053    private final SLF4JRawXmlListener slf4JRawXmlListener = new SLF4JRawXmlListener(logger);
054
055    private ObservableWriter writer;
056    private ObservableReader reader;
057
058    /**
059     * Makes Smack use this Debugger.
060     */
061    public static void enable() {
062        SmackConfiguration.setDebuggerFactory(new SLF4JDebuggerFactory());
063    }
064
065    /**
066     * Create new SLF4J Smack Debugger instance.
067     * @param connection Smack connection to debug
068     * @param writer connection data writer to observe
069     * @param reader connection data reader to observe
070     */
071    public SLF4JSmackDebugger(XMPPConnection connection, Writer writer, Reader reader) {
072        this.connection = connection;
073        this.writer = new ObservableWriter(writer);
074        this.writer.addWriterListener(slf4JRawXmlListener);
075        this.reader = new ObservableReader(Validate.notNull(reader));
076        this.reader.addReaderListener(slf4JRawXmlListener);
077        this.connection.addConnectionListener(new SLF4JLoggingConnectionListener(connection, logger));
078    }
079
080    @Override
081    public Reader newConnectionReader(Reader newReader) {
082        reader.removeReaderListener(slf4JRawXmlListener);
083        reader = new ObservableReader(newReader);
084        reader.addReaderListener(slf4JRawXmlListener);
085        return reader;
086    }
087
088    @Override
089    public Writer newConnectionWriter(Writer newWriter) {
090        writer.removeWriterListener(slf4JRawXmlListener);
091        writer = new ObservableWriter(newWriter);
092        writer.addWriterListener(slf4JRawXmlListener);
093        return writer;
094    }
095
096    @Override
097    public void userHasLogged(EntityFullJid user) {
098        if (logger.isDebugEnabled()) {
099            logger.debug("({}) User logged in {}", connection.hashCode(), user.toString());
100        }
101    }
102
103    @Override
104    public Reader getReader() {
105        return reader;
106    }
107
108    @Override
109    public Writer getWriter() {
110        return writer;
111    }
112
113    @Override
114    public StanzaListener getReaderListener() {
115        return receivedListener;
116    }
117
118    @Override
119    public StanzaListener getWriterListener() {
120        return sentListener;
121    }
122}