io.helidon.integrations.cdi.hibernate.CDISEJtaPlatform Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2019, 2021 Oracle and/or its affiliates.
 *
 * 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 io.helidon.integrations.cdi.hibernate;

import java.util.Objects;

import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
import jakarta.transaction.TransactionManager;
import jakarta.transaction.UserTransaction;
import org.hibernate.engine.jndi.spi.JndiService;
import org.hibernate.engine.transaction.jta.platform.internal.AbstractJtaPlatform;

/**
 * An {@link AbstractJtaPlatform} that is an {@link ApplicationScoped}
 * CDI managed bean that supplies {@link TransactionManager} and
 * {@link UserTransaction} instances that are supplied to it at
 * {@linkplain #CDISEJtaPlatform(TransactionManager, UserTransaction)
 * construction time}.
 *
 * @see AbstractJtaPlatform
 */
@ApplicationScoped
public class CDISEJtaPlatform extends AbstractJtaPlatform {
  private final TransactionManager transactionManager;

  private final UserTransaction userTransaction;

  private static final long serialVersionUID = 1L;

  /**
   * Creates a new {@link CDISEJtaPlatform}.
   *
   * @param transactionManager the {@link TransactionManager} to use;
   * must not be {@code null}
   *
   * @param userTransaction the {@link UserTransaction} to use; must
   * not be {@code null}
   *
   * @exception NullPointerException if either {@code
   * transactionManager} or {@code userTransaction} is {@code null}
   */
  @Inject
  public CDISEJtaPlatform(final TransactionManager transactionManager,
                          final UserTransaction userTransaction) {
    super();
    this.transactionManager = Objects.requireNonNull(transactionManager);
    this.userTransaction = Objects.requireNonNull(userTransaction);
  }

  /**
   * Throws an {@link UnsupportedOperationException} when invoked.
   *
   * @return (not applicable)
   *
   * @exception UnsupportedOperationException when invoked
   */
  @Override
  protected JndiService jndiService() {
    throw new UnsupportedOperationException();
  }

  /**
   * Returns the {@link UserTransaction} instance supplied at
   * {@linkplain #CDISEJtaPlatform(TransactionManager,
   * UserTransaction) construction time}.
   *
   * This method never returns {@code null}.
   *
   * @return a non-{@code null} {@link UserTransaction}
   *
   * @see #CDISEJtaPlatform(TransactionManager, UserTransaction)
   */
  @Override
  protected UserTransaction locateUserTransaction() {
    return this.userTransaction;
  }

  /**
   * Returns the {@link TransactionManager} instance supplied at
   * {@linkplain #CDISEJtaPlatform(TransactionManager,
   * UserTransaction) construction time}.
   *
   * This method never returns {@code null}.
   *
   * @return a non-{@code null} {@link TransactionManager}
   *
   * @see #CDISEJtaPlatform(TransactionManager, UserTransaction)
   */
  @Override
  protected TransactionManager locateTransactionManager() {
    return this.transactionManager;
  }

}