atom.content.Jcr.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.content

import javax.jcr.query.Query.JCR_SQL2
import javax.jcr.query.QueryResult
import javax.jcr.{Node, RepositoryException, Session}

import atom.content.Jcr.jcr

/**
 * Вспомогательный класс для взаимодействия с хранилищем JCR.
 *
 * @author Alex Voloshyn
 * @version 1.1 3/1/15
 */
trait Jcr {
  /**
   * Рабочее пространство хранилища JCR.
   */
  val workspace = "default"

  /**
   * Подсчет колличества результатов по заданному запросу.
   *
   * @param string запрос для выполнения
   * @return колличество результатов или -1 в случае возникновения ошивки
   */
  protected def queryCount(string: String): Long = {
    execute[Long](session => {
      val manager = session.getWorkspace.getQueryManager
      val query = manager.createQuery(string, JCR_SQL2)
      val result = query.execute
      result.getNodes.getSize
    }).getOrElse(-1)
  }

  /**
   * Обработка результатов заданного запроса.
   *
   * @param string запрос для выполления
   * @param function функция обработки результатов запроса
   */
  protected def query(string: String, function: QueryResult => Unit): Unit = {
    execute(session => {
      val manager = session.getWorkspace.getQueryManager
      val query = manager.createQuery(string, JCR_SQL2)
      function(query.execute)
    })
  }

  /**
   * Выполнение определенной функции при взаимодействии с хранилищем.
   *
   * @param function функция для выполнения
   * @tparam R тип возвращаемого результата
   * @return результат выполнения функции
   */
  protected def execute[R](function: Session => R): Option[R] = {
    val session = login()
    try {
      Some(function(session.get))
    } catch {
      case e: Throwable => e.printStackTrace(); None
    } finally {
      if (session.nonEmpty) session.get logout()
    }
  }

  /**
   * Получение сессии взаимодействия с JCR хранилищем.
   *
   * @return сессия взаимодействия с JCR хранилищем
   */
  protected def login(): Option[Session] = {
    try {
      Some(jcr login workspace)
    } catch {
      case e: Throwable => e.printStackTrace(); None
    }
  }

  /**
   * Получение определенного узла либо его предварительное создание в случае его
   * отсутствия.
   *
   * @param parent родительский узел
   * @param name имя узла
   * @param kind основной тип узла
   * @throws RepositoryException в случае возникновения какой-либо ошибки
   * @return ячейка, которая была найдена либо создана
   */
  @throws(classOf[RepositoryException])
  protected def getOrCreate(parent: Node, name: String, kind: String): Node = {
    if (parent hasNode name) parent getNode name else parent addNode(name, kind)
  }
}

object Jcr {
  /**
   * Системный сервис для взаимодействия с хранилищем.
   */
  private val jcr = Context.getSystemService(classOf[JcrManager])
}