atom.app.Notification.scala Maven / Gradle / Ivy
/*
* Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Geeoz Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Geeoz Software is supplied to you by Geeoz in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Geeoz Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Geeoz Software.
*
* Neither the name, trademarks, service marks or logos of Geeoz may be used
* to endorse or promote products derived from the Geeoz Software without
* specific prior written permission from Geeoz.
*
* The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.geeoz.com/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Geeoz and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Geeoz and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Geeoz or visit www.geeoz.com if you need additional
* information or have any questions.
*/
package atom.app
import java.time.ZonedDateTime
import atom.app.Notification.Channel
import scala.collection.JavaConversions.asScalaSet
/**
* Class with notification body that should be send.
*
* @param user identity of the user that should be notified
* @param ref reference code that create the notification
* @param source identity of the source that create notification event
* @param title notification title
* @param text notification text
* @param channels channels for notification
* @param sender identity of the notification's sender
* @param expiration expiration of the notification
*
* @author Alex Voloshyn
* @version 1.1 2/22/15
*/
case class Notification(user: String,
ref: String,
source: String,
title: String,
text: String,
channels: Set[Channel] = Set(),
sender: String = "UNKNOWN",
expiration: ZonedDateTime = ZonedDateTime.now())
/**
* Notification channels enumeration.
*/
object Notification {
/**
* Simplified notification creation.
*
* @param user identity of the user that should be notified
* @param ref reference code that create the notification
* @param source identity of the source that create notification event
* @param title notification title
* @param text notification text
* @return an instance of the notification
*/
def create(user: String,
ref: String,
source: String,
title: String,
text: String): Notification = {
Notification(user, ref, source, title, text)
}
/**
* Simplified notification creation.
*
* @param user identity of the user that should be notified
* @param ref reference code that create the notification
* @param source identity of the source that create notification event
* @param title notification title
* @param text notification text
* @param channels channels for notification
* @return an instance of the notification
*/
def create(user: String,
ref: String,
source: String,
title: String,
text: String,
channels: java.util.Set[Channel]): Notification = {
Notification(user, ref, source, title, text, asScalaSet(channels).toSet)
}
/**
* Simplified notification creation.
*
* @param user identity of the user that should be notified
* @param ref reference code that create the notification
* @param source identity of the source that create notification event
* @param title notification title
* @param text notification text
* @param channels channels for notification
* @param sender identity of the notification's sender
* @return an instance of the notification
*/
def create(user: String,
ref: String,
source: String,
title: String,
text: String,
channels: java.util.Set[Channel],
sender: String): Notification = {
Notification(
user, ref, source, title, text, asScalaSet(channels).toSet, sender)
}
/**
* Simplified notification creation.
*
* @param user identity of the user that should be notified
* @param ref reference code that create the notification
* @param source identity of the source that create notification event
* @param title notification title
* @param text notification text
* @param channels channels for notification
* @param sender identity of the notification's sender
* @param expiration expiration of the notification
* @return an instance of the notification
*/
def create(user: String,
ref: String,
source: String,
title: String,
text: String,
channels: java.util.Set[Channel],
sender: String,
expiration: ZonedDateTime): Notification = {
Notification(user, ref, source, title, text,
asScalaSet(channels).toSet, sender, expiration)
}
/**
* Notification channel for delivery.
*/
trait Channel
/**
* Email notification channel.
* @param to email address
*/
case class Email(to: String) extends Channel
/**
* SMS notification channel.
* @param phone phone number
*/
case class Sms(phone: String) extends Channel
/**
* Instant messenger notification channel.
*/
class Im extends Channel
/**
* Instant messenger initialization object.
*/
object Im {
/**
* Instant messenger class initialization.
* @return an instant messenger instance
*/
def apply(): Im = new Im
}
/**
* Instant messenger instance
*/
val im: Im = new Im()
/**
* Email notification channel.
* @param to email address
* @return an instance of the email channel
*/
def email(to: String): Email = Email(to)
/**
* SMS notification channel.
* @param phone phone number
* @return an instance of the phone channel
*/
def sms(phone: String): Sms = Sms(phone)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy