/*******************************************************************************
* This file is part of OpenNMS(R).
*
* Copyright (C) 2009-2011 The OpenNMS Group, Inc.
* OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
*
* OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
*
* OpenNMS(R) 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.
*
* OpenNMS(R) 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 OpenNMS(R). If not, see:
* http://www.gnu.org/licenses/
*
* For more information contact:
* OpenNMS(R) Licensing <license@opennms.org>
* http://www.opennms.org/
* http://www.opennms.com/
*******************************************************************************/
package org.opennms.sms.phonebook;
/**
* <p>Phonebook interface.</p>
*
* @author ranger
* @version $Id: $
*/
public interface Phonebook {
/**
* Get an SMS message target when given an IP address.
*
* @param address the IPv4 or IPv6 address
* @return a string representing the SMS "to" (usually a phone number or SMS email address)
* @throws @{link PhonebookException}
* @throws org.opennms.sms.phonebook.PhonebookException if any.
*/
String getTargetForAddress(String address) throws PhonebookException;
}