smslib-v3[1].2.2

// SMSLib for Java v3 // A Java API library for sending and receiving SMS via a GSM modem // or other supported gateways. // Web Site: http://www.smslib.org // // Copyright (C) 2002-2008, Thanasis Delenikas, Athens/GREECE. // SMSLib is distributed under the terms of the Apache License version 2.0 // // 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 org.smslib; import java.io.File; import java.io.IOException; import java.util.ArrayList; import java.util.Enumeration; import java.util.List; import java.util.Properties; import org.apache.log4j.BasicConfigurator; import org.apache.log4j.Level; import org.apache.log4j.Logger; import org.apache.log4j.PropertyConfigurator; import org.apache.log4j.xml.DOMConfigurator; /** * This is main library class. Your primary interface with SMSLib is via methods * defined in this class. */ public class Service { private static final String LOG4J_CONF = "smslib-log4j.properties"; private static final String LOG4J_CONF_XML = "smslib-log4j.xml"; private Logger logger; private List gtwList; private Router router; private LoadBalancer loadBalancer; private WatchDog watchDog; /** * Configuration settings. * * @see Settings */ public Settings S; /** * Default Service constructor. Will set SMSLib to use its own logger. */ public Service() { S = new Settings(); try { logger = Logger.getLogger("org.smslib"); logger.setLevel(S.DEBUG ? Level.ALL : Level.WARN); Properties p = new Properties(); p = loadLoggerProps(LOG4J_CONF); if (p != null) PropertyConfigurator.configure(p); else { if (new File(LOG4J_CONF).exists()) PropertyConfigurator.configure(LOG4J_CONF); else if (new File(LOG4J_CONF_XML).exists()) DOMConfigurator.configure(LOG4J_CONF_XML); else BasicConfigurator.configure(); } logger.info(Library.getLibraryDescription()); logger.info("Version: " + Library.getLibraryVersion()); logger.info("JRE Version: " + System.getProperty("java.version")); logger.info("JRE Impl Version: " + System.getProperty("java.vm.version")); logger.info("O/S: " + System.getProperty("os.name") + " / " + System.getProperty("os.arch") + " / " + System.getProperty("os.version")); gtwList = new ArrayList(); setRouter(new Router(this)); setLoadBalancer(new RoundRobinLoadBalancer(this)); } catch (Exception e) { logger.fatal(e); } } /** * Service constructor. Will set SMSLib to use the provided log4j logger. * * @param logger * A ready log4j logger to use. */ public Service(Logger logger) { S = new Settings(); this.logger = logger; logger.setLevel(S.DEBUG ? Level.ALL : Level.WARN); logger.info(Library.getLibraryDescription()); logger.info("Version: " + Library.getLibraryVersion()); logger.info("JRE Version: " + System.getProperty("java.version")); logger.info("JRE Impl Version: " + System.getProperty("java.vm.version")); logger.info("O/S: " + System.getProperty("os.name") + " / " + System.getProperty("os.arch") + " / " + System.getProperty("os.version")); gtwList = new ArrayList(); setRouter(new Router(this)); setLoadBalancer(new RoundRobinLoadBalancer(this)); } private Properties loadLoggerProps(String filename) { Properties props = new Properties(); try { props.load(getClass().getResourceAsStream(filename)); } catch (Exception ex) { return null; } Enumeration keys = props.keys(); while (keys.hasMoreElements()) { String prop = (String) keys.nextElement(); String val = props.getProperty(prop); props.setProperty(prop, val); } return props; } /** * Returns the logger used by SMSLib. * * @return The logger in use. */ public Logger getLogger() { return logger; } /** * Adds a gateway to the list of gateways managed by the Service class. * * @param gtw * The gateway to be added. * @see #getGatewayList() */ public void addGateway(AGateway gtw) { synchronized (gtwList) { gtw.setService(this); gtwList.add(gtw); } } /** * Initializes all gateways. This should be the first call before you use * the Service class for sending/receiving messages. The call will try to * start all defined gateways. * * @throws SMSLibException * No Gateways are defined. * @throws TimeoutException * The gateway did not respond in a timely manner. * @throws GatewayException * A Gateway error occurred. * @throws IOException * An IO error occurred. * @throws InterruptedException * The call was interrupted. * @see #stopService() */ public synchronized void startService() throws SMSLibException, TimeoutException, GatewayException, IOException, InterruptedException { watchDog = new WatchDog(); synchronized (gtwList) { if (gtwList.size() == 0) throw new SMSLibException("No gateways are defined."); for (int i = 0, n = gtwList.size(); i < n; i++) ((AGateway) gtwList.get(i)).startGateway(); } } /** * Stops all gateways - does not remove them from Service's internal list. * Once stopped, all SMSLib operations will fail. You need to start the * gateways again before proceeding. * * @throws TimeoutException * The gateway did not respond in a timely manner. * @throws GatewayException * A Gateway error occurred. * @throws IOException * An IO error occurred. * @throws InterruptedException * The call was interrupted. * @see #startService() */ public synchronized void stopService() throws TimeoutException, GatewayException, IOException, InterruptedException { if (watchDog != null) { watchDog.interrupt(); watchDog.join(); } synchronized (gtwList) { for (int i = 0, n = gtwList.size(); i < n; i++) ((AGateway) gtwList.get(i)).stopGateway(); } } /** * Reads inbound messages from ALL gateways with the Inbound attribute set. * When successful, the message list will contain all messages read. * * @param msgList * A (probably empty) list that will be populated with Inbound * messages read. * @param msgClass * Filtering: Class of messages that need to be read. * @return The number of messages read. * @throws TimeoutException * The gateway did not respond in a timely manner. * @throws GatewayException * A Gateway error occurred. * @throws IOException * An IO error occurred. * @throws InterruptedException * The call was interrupted. * @see MessageClasses */ public int readMessages(List msgList, MessageClasses msgClass) throws TimeoutException, GatewayException, IOException, InterruptedException { synchronized (gtwList) { for (int i = 0, n = gtwList.size(); i < n; i++) { AGateway gtw = (AGateway) gtwList.get(i); if (gtw.isInbound()) { try { readMessages(msgList, msgClass, gtw); } catch (TimeoutException e) { logWarn("readMessages(): Gateway " + gtw.getGatewayId() + " does not respond, marking for restart."); gtw.setGatewayStatus(GatewayStatuses.RESTART); } catch (IOException e) { logWar