com.buddycloud.pusher.utils.XMPPUtils.java Source code

Introduction

Here is the source code for com.buddycloud.pusher.utils.XMPPUtils.java

Source

/*
 * Copyright 2011 buddycloud
 *
 * 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 com.buddycloud.pusher.utils;

import org.apache.log4j.Logger;
import org.dom4j.Element;
import org.xmpp.packet.IQ;
import org.xmpp.packet.PacketError;
import org.xmpp.packet.PacketError.Condition;
import org.xmpp.packet.PacketError.Type;

public class XMPPUtils {

    /**
     * Logs the error and returns an IQ error response
     * 
     * @param iq
     * @param errorMessage
     * @param logger
     * @return
     */
    public static IQ error(IQ iq, String errorMessage, Logger logger) {
        logger.error(errorMessage);
        return error(iq, errorMessage);
    }

    public static IQ error(IQ iq, String errorMessage) {
        return XMPPUtils.createErrorResponse(iq, errorMessage, Condition.bad_request, Type.modify);
    }

    /**
     * @param iq
     * @param errorMessage
     * @param logger
     * @return
     */
    public static IQ error(IQ iq, String errorMessage, Exception e, Logger logger) {
        logger.error(errorMessage, e);
        return XMPPUtils.createErrorResponse(iq, errorMessage, Condition.bad_request, Type.modify);
    }

    /**
     * Logs the RSM page not found error and returns an IQ error response
     * 
     * @param iq
     * @param errorMessage
     * @param logger
     * @return
     */
    public static IQ errorRSM(IQ iq, Logger logger) {
        String rsmMessage = "RSM: Page Not Found";
        logger.error(rsmMessage + " " + iq);
        return XMPPUtils.createErrorResponse(iq, rsmMessage, Condition.item_not_found, Type.cancel);
    }

    /**
     * Creates an error response for a given IQ request.  
     * 
     * @param request
     * @param message
     * @param condition
     * @param type
     * @return
     */
    public static IQ createErrorResponse(final IQ request, final String message, Condition condition, Type type) {
        final IQ result = request.createCopy();
        result.setID(request.getID());
        result.setFrom(request.getTo());
        result.setTo(request.getFrom());

        PacketError e = new PacketError(condition, type);
        if (message != null) {
            e.setText(message);
        }
        result.setError(e);

        return result;
    }

    public static void addInfo(String message, Element queryElement) {
        Element messageEl = queryElement.addElement("info");
        messageEl.setText(message);
    }
}