atom.notification.package.scala Maven / Gradle / Ivy

Go to download
/*
 * 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

import javax.jcr.Session

import atom.app.NotificationListener
import atom.content.{Context, JcrManager}

/**
 * The package object `atom.notification` contains constants for notification
 * operations.
 *
 * @author Alex Voloshyn
 * @version 1.0 1/22/15
 */
package object notification {
  /**
   * Notification JCR node types namespace.
   */
  private val NOTIFICATION_NAMESPACE =
    "{http://www.geeoz.com/jcr/atom/notification/1.0}"
  /**
   * Notification batch JCR node types namespace.
   */
  private val BATCH_NAMESPACE =
    "{http://www.geeoz.com/jcr/atom/notification/batch/1.0}"
  /**
   * An email literal.
   */
  private val EMAIL = "email"
  /**
   * A constant for the workspace notifications.
   */
  val WS_NOTIFICATIONS = "notifications"
  /**
   * A constant for the node path notification.
   */
  val PATH_NOTIFICATION = "/notification"
  /**
   * A constant for the node path notifications/userUUID.
   */
  val PATH_NOTIFICATION_USER = "/notification/%s"
  /**
   * A constant for the node path notifications/userUUID/appCode.
   */
  val PATH_NOTIFICATION_USER_APP = "/notification/%s/%s"
  /**
   * A constant for the node relative path batch.
   */
  val REL_PATH_BATCH = "batch"
  /**
   * A constant for the node relative path email.
   */
  val REL_PATH_EMAIL = EMAIL
  /**
   * A constant for the node type name notification:reference.
   */
  val NT_REF = NOTIFICATION_NAMESPACE + "reference"
  /**
   * A constant for the node type name notification:batch.
   */
  val NT_BATCH = NOTIFICATION_NAMESPACE + "batch"
  /**
   * A constant for the node type name notification:email.
   */
  val NT_EMAIL = NOTIFICATION_NAMESPACE + EMAIL
  /**
   * A constant for the node type name notification:notification.
   */
  val NT_NOTIFICATION = NOTIFICATION_NAMESPACE + "notification"
  /**
   * A constant for the node type name notification:user.
   */
  val NT_USER = NOTIFICATION_NAMESPACE + "user"
  /**
   * A constant for the node type name batch:email.
   */
  val NT_BATCH_EMAIL = BATCH_NAMESPACE + EMAIL
  /**
   * A constant for the node property notification:expiration.
   */
  val PROP_EXP = NOTIFICATION_NAMESPACE + "expiration"
  /**
   * A constant for the node property notification:identities.
   */
  val PROP_IDENTITIES = BATCH_NAMESPACE + "identities"
  /**
   * A constant for the node property notification:last.
   */
  val PROP_LAST = NOTIFICATION_NAMESPACE + "last"
  /**
   * A constant for the node property batch:processed.
   */
  val PROP_PROCESSED = BATCH_NAMESPACE + "processed"
  /**
   * A constant for the node property notification:seen.
   */
  val PROP_SEEN = NOTIFICATION_NAMESPACE + "seen"
  /**
   * A constant for the node property notification:sender.
   */
  val PROP_SENDER = NOTIFICATION_NAMESPACE + "sender"
  /**
   * A constant for the node property notification:source.
   */
  val PROP_SOURCE = NOTIFICATION_NAMESPACE + "source"
  /**
   * A constant for the node property notification:status.
   */
  val PROP_STATUS = NOTIFICATION_NAMESPACE + "status"
  /**
   * A constant for the node property notification:text.
   */
  val PROP_TEXT = NOTIFICATION_NAMESPACE + "text"
  /**
   * A constant for the node property notification:title.
   */
  val PROP_TITLE = NOTIFICATION_NAMESPACE + "title"
  /**
   * A constant for the node property notification:to.
   */
  val PROP_TO = NOTIFICATION_NAMESPACE + "to"
  /**
   * Константа для статуса новых уведомлений.
   */
  val STATUS_NEW = "NEW"
  /**
   * Константа для статуса неотправленного уведомления по причине неверного
   * формата адреса электронной почты.
   */
  val STATUS_FAIL = "FAIL"
  /**
   * Константа для статуса отправленных уведомлений.
   */
  val STATUS_SENT = "SENT"

  /**
   * Empty notification listener handler for exception cases.
   */
  val EMPTY_HANDLER = new NotificationListener.Handler {
    override def destroy(): Unit = {} // Do nothing
  }
  /**
   * JCR storage for notification.
   */
  private val session =
    Context.getSystemService(classOf[JcrManager]) login WS_NOTIFICATIONS

  /**
   * Execute the logic for JCR session.
   *
   * @param function function that should be executed
   * @return result of the function execution
   */
  def observe[R](function: Session => R): Option[R] = {
    try {
      Some(function(session))
    } catch {
      case e: Throwable => e.printStackTrace(); None
    }
  }
}