com.vii.streamline.services.db.DBMediator Maven / Gradle / Ivy
/*
* Copyright (c) 2012 Imre Fazekas.
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* Neither the name of the Brillien nor the names of its
* terms and concepts may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.vii.streamline.services.db;
import com.vii.streamline.services.error.StreamLineException;
import javax.transaction.Transaction;
/**
* Utility class to manage properties to connect to a DB node.
*/
public interface DBMediator {
/**
* Gets the vendor.
*/
String getVendor();
/**
* Sets the vendor.
*/
void setVendor(String vendor);
/**
* Gets the user name.
*/
String getUsername();
/**
* Sets the user name.
*/
void setUsername(String username);
/**
* Gets the password.
*/
String getPassword();
/**
* Sets the password.
*/
void setPassword(String password);
/**
* Gets the address.
*/
String getAddress();
/**
* Sets the address.
*/
void setAddress(String address);
/**
* Gets the port.
*/
String getPort();
/**
* Sets the port.
*/
void setPort(String port);
/**
* Gets the name of the database.
*/
String getDatabase();
/**
* Sets the name of the database.
*/
void setDatabase(String database);
/**
* Checks whether or not the database is xa capable.
*/
boolean isXaCapable();
/**
* Sets the xa capable.
*/
void setXaCapable(boolean xaCapable);
/**
* Gets the {@link javax.sql.DataSource}.
*/
javax.sql.DataSource getDs();
/**
* Sets the {@link javax.sql.DataSource}.
*/
void setDs(javax.sql.DataSource ds);
/**
* Initiates a new transaction.
*/
T startTransaction() throws StreamLineException;
/**
* Terminats the given transaction.
*/
void closeTransaction( T t ) throws StreamLineException;
}