com.mockrunner.ejb.Configuration Maven / Gradle / Ivy

Go to download
package com.mockrunner.ejb;

import javax.naming.Context;

/**
 * Global configuration options regarding EJB and JNDI.
 * Usually you do not have to change these options.
 */
public class Configuration
{
    private String userTransactionJNDIName;
    private boolean bindMockUserTransactionToJNDI;
    private Context context;
    
    public Configuration()
    {
        this("javax.transaction.UserTransaction");
    }
    
    public Configuration(String userTransactionJNDIName)
    {
        this(userTransactionJNDIName, true);
    }
    
    public Configuration(String userTransactionJNDIName, boolean bindMockUserTransactionToJNDI)
    {
        this.userTransactionJNDIName = userTransactionJNDIName;
        this.bindMockUserTransactionToJNDI = bindMockUserTransactionToJNDI;
        this.context = null;
    }
    
    /**
     * Get the JNDI context. This method returns null if no context
     * is set. In this case the {@link com.mockrunner.mock.ejb.EJBMockObjectFactory}
     * uses the MockEJB JNDI implementation.
     * @return the JNDI context
     */
    public Context getContext()
    {
        return context;
    }

    /**
     * Set the JNDI context used by {@link com.mockrunner.mock.ejb.EJBMockObjectFactory}.
     * @param context the JNDI context
     */
    public void setContext(Context context)
    {
        this.context = context;
    }

    /**
     * Get if the mock transaction should be bound to JNDI.
     * @return if the mock transaction should be bound to JNDI
     */
    public boolean getBindMockUserTransactionToJNDI()
    {
        return bindMockUserTransactionToJNDI;
    }
    
    /**
     * Set if the mock transaction should be bound to JNDI.
     * When the {@link com.mockrunner.mock.ejb.EJBMockObjectFactory}
     * creates a {@link com.mockrunner.mock.ejb.MockUserTransaction},
     * it tries to rebind the transaction to the JNDI tree with the
     * specified name {@link #setUserTransactionJNDIName}, the name
     * javax.transaction.UserTransaction (which is used
     * by MockEJB and Weblogic) and the name 
     * java:comp/UserTransaction (which is the standard name), 
     * if this option is true. 
     * If this option is false, a mock transaction is created 
     * but not bound to JNDI.
     * Default is true.
     * @param bindMockUserTransactionToJNDI should the mock transaction be bound to JNDI
     */
    public void setBindMockUserTransactionToJNDI(boolean bindMockUserTransactionToJNDI)
    {
        this.bindMockUserTransactionToJNDI = bindMockUserTransactionToJNDI;
    }
    
    /**
     * Get the JNDI name for the user transaction.
     * @return the JNDI name for the user transaction
     */
    public String getUserTransactionJNDIName()
    {
        return userTransactionJNDIName;
    }
    
    /**
     * Set the JNDI name for the user transaction. The
     * {@link com.mockrunner.mock.ejb.EJBMockObjectFactory} tries to
     * obtain a UserTransaction from JNDI using this
     * name. If the lookup fails, a {@link com.mockrunner.mock.ejb.MockUserTransaction}
     * is created and bound to JNDI, if {@link #setBindMockUserTransactionToJNDI} is
     * set to true.
     * Default is javax.transaction.UserTransaction.
     * @param userTransactionJNDIName the JNDI name for the user transaction
     */
    public void setUserTransactionJNDIName(String userTransactionJNDIName)
    {
        this.userTransactionJNDIName = userTransactionJNDIName;
    }
}