org.jooq.Attachable Maven / Gradle / Ivy
/*
* 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.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import java.io.Serializable;
import java.sql.Connection;
import javax.sql.DataSource;
import org.jetbrains.annotations.Nullable;
/**
* An object in jOOQ that can have an underlying {@link Configuration} attached
* or detached.
*
* Detaching an Attachable from its configuration means, that the
* underlying {@link Connection} or {@link DataSource} is removed. Attaching an
* Attachable to a new Configuration means, that its
* underlying Connection or DataSource will be
* restored.
*
* Detaching an Attachable will NOT close the underlying
* Connection or DataSource!
*
* Attachables are also {@link Serializable}. The underlying
* Connection or DataSource is transient.
* Serialising an Attachable will always detach it first.
*
* @author Lukas Eder
*/
public interface Attachable extends Serializable {
/**
* Attach this object to a new {@link Configuration}.
*
* @param configuration A configuration or null, if you wish to
* detach this Attachable from its previous
* configuration.
*/
void attach(Configuration configuration);
/**
* Detach this object from its current {@link Configuration}.
*
* This is the same as calling attach(null).
*/
void detach();
/**
* Get the currently attached {@link Configuration}, or null if
* no Configuration is attached.
*/
@Nullable
Configuration configuration();
}