org.openhab.io.net.actions.Prowl.java Source code

Introduction

Here is the source code for org.openhab.io.net.actions.Prowl.java

Source

/**
 * openHAB, the open Home Automation Bus.
 * Copyright (C) 2010-2013, openHAB.org <admin@openhab.org>
 *
 * See the contributors.txt file in the distribution for a
 * full listing of individual contributors.
 *
 * 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; either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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, see <http://www.gnu.org/licenses>.
 *
 * Additional permission under GNU GPL version 3 section 7
 *
 * If you modify this Program, or any covered work, by linking or
 * combining it with Eclipse (or a modified version of that library),
 * containing parts covered by the terms of the Eclipse Public License
 * (EPL), the licensors of this Program grant you additional permission
 * to convey the resulting work.
 */
package org.openhab.io.net.actions;

import java.util.Dictionary;

import net.sourceforge.prowl.api.DefaultProwlEvent;
import net.sourceforge.prowl.api.ProwlClient;
import net.sourceforge.prowl.api.ProwlEvent;
import net.sourceforge.prowl.exception.ProwlException;

import org.apache.commons.lang.StringUtils;
import org.osgi.service.cm.ConfigurationException;
import org.osgi.service.cm.ManagedService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** 
 * This class provides static methods that can be used in automation rules
 * for pushin Prowl notifications. 
 * 
 * @author Thomas.Eichstaedt-Engelen
 * @since 0.6.0
 */
public class Prowl implements ManagedService {

    static private final Logger logger = LoggerFactory.getLogger(Prowl.class);

    private static boolean initialized = false;

    private static String url = null;
    private static String apiKey = null;
    private static int priority = 0;

    /**
     * Pushes a Prowl Notification and takes the default priority into account
     * 
     * @param subject the subject of the notification
     * @param message the message of the notification
     * 
     * @return <code>true</code>, if pushing the notification has been successful
     * and <code>false</code> in all other cases.
     */
    static public boolean pushNotification(String subject, String message) {
        return pushNotification(subject, message, Prowl.priority);
    }

    /**
     * Pushes a Prowl Notification
     * 
     * @param subject the subject of the notification 
     * @param message the message of the notification
     * @param priority the priority of the notification (a value between
     * '-2' and '2')
     * 
     * @return <code>true</code>, if pushing the notification has been successful
     * and <code>false</code> in all other cases.
     */
    static public boolean pushNotification(String subject, String message, int priority) {
        boolean success = false;

        int normalizedPriority = priority;
        if (priority < -2) {
            normalizedPriority = -2;
            logger.info("Prowl-Notification priority '{}' is invalid - normalized value to '{}'", priority,
                    normalizedPriority);
        } else if (priority > 2) {
            normalizedPriority = 2;
            logger.info("Prowl-Notification priority '{}' is invalid - normalized value to '{}'", priority,
                    normalizedPriority);
        }

        if (initialized) {
            ProwlClient client = new ProwlClient();
            if (StringUtils.isNotBlank(Prowl.url)) {
                client.setProwlUrl(Prowl.url);
            }

            ProwlEvent event = new DefaultProwlEvent(Prowl.apiKey, "openhab", subject, message, normalizedPriority);

            try {
                String returnMessage = client.pushEvent(event);
                logger.info(returnMessage);
                success = true;
            } catch (ProwlException pe) {
                logger.error("pushing prowl event throws exception", pe);
            }

        } else {
            logger.error(
                    "Cannot push Prowl notification because of missing configuration settings. The current settings are: "
                            + "apiKey: '{}', priority: {}, url: '{}'",
                    new String[] { apiKey, String.valueOf(normalizedPriority), url });
        }

        return success;
    }

    @SuppressWarnings("rawtypes")
    public void updated(Dictionary config) throws ConfigurationException {
        if (config != null) {
            Prowl.url = (String) config.get("url");

            Prowl.apiKey = (String) config.get("apikey");
            if (StringUtils.isBlank(Prowl.apiKey)) {
                throw new ConfigurationException("prowl.apikey",
                        "The parameter 'apikey' must be configured. Please refer to your 'openhab.cfg'");
            }

            String priorityString = (String) config.get("defaultpriority");
            if (StringUtils.isNotBlank(priorityString)) {
                Prowl.priority = Integer.valueOf(priorityString);
            }

            initialized = true;
        }
    }

}