nl.renarj.jasdb.api.DBSessionFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jasdb_api Show documentation

There is a newer version: 1.2.1

package nl.renarj.jasdb.api;

import nl.renarj.jasdb.api.context.Credentials;
import nl.renarj.jasdb.core.exceptions.JasDBException;
import nl.renarj.jasdb.core.exceptions.JasDBStorageException;

/**
 *  The session factory is capable of creation JasDB session
 *
 *  @author Renze de Vries
 */
public interface DBSessionFactory {
    /**
     * Creates a DB Session
     * @return The DB Session
     * @throws JasDBStorageException If unable to create the session
     */
    DBSession createSession() throws JasDBStorageException;

    /**
     * Creates a DB Session with given credentials
     * @param credentials the credentials
     * @return The DB Session
     * @throws JasDBStorageException If unable to create the session
     */
    DBSession createSession(Credentials credentials) throws JasDBStorageException;

    /**
     * Creates a session for the given instance
     * @param instance the instance id
     * @return The session for that instance
     * @throws JasDBStorageException If unable to create the session
     */
    DBSession createSession(String instance) throws JasDBStorageException;

    /**
     * Creates a session for the given instance and credentials
     * @param instance the instance id
     * @param credentials the credentials
     * @return The DB Session
     * @throws JasDBStorageException If unable to create the session
     */
    DBSession createSession(String instance, Credentials credentials) throws JasDBStorageException;

    void shutdown() throws JasDBException;
}