DatabaseConfig.java
/*
** Module : DatabaseConfiguration.java
** Abstract : Container for database configuration information.
**
** Copyright (c) 2004-2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- --JPRM-- ---------------------------------Description----------------------------------
** 001 ECF 20071019 @35596 Created initial version. Container for
** database configuration information needed by
** Hibernate and the P2J persistence framework.
** 002 ECF 20200906 New ORM implementation.
** 003 IAS 20200914 Re-work (de)serialization
** 004 IAS 20210520 Added support for session-based database auto-connect.
** ECF 20210630 Minor cleanup.
** IAS 20210803 Added useJavaUDFs flag.
** ECF 20220825 Added mutable flag.
** 005 LS 20250211 Added support for session hook.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.persist;
import java.io.*;
import com.goldencode.p2j.persist.orm.*;
import static com.goldencode.util.NativeTypeSerializer.*;
/**
* Class which encapsulates information necessary to configure a database.
* Currently, this includes all configuration information needed by Hibernate,
* and the schema name for a database.
*
* @author ECF
*/
public class DatabaseConfig
implements Externalizable
{
/** ORM configuration properties */
private Settings ormSettings;
/** Database schema name */
private String schema;
/** Deactivate period for non-permanent db in seconds, -1 means 'never' */
private long deactivateIfNotUsedSec = -1;
/** Flag indicating that Java UDFs should be used */
private boolean useJavaUDFs = true;
/** Flag indicating database's schema is dynamically mutable */
private boolean mutable = false;
/** Instance used to handle session lifecycle events */
private SessionHook hook = null;
/** Default constructor */
public DatabaseConfig()
{
super();
}
/**
* Constructor which stores ORM settings and schema name.
*
* @param ormSettings
* ORM configuration settings.
* @param schema
* Schema name.
* @param deactivateIfNotUsedSec
* Deactivate period for database.
* @param useJavaUDFs
* Flag indicating that Java UDFs should be used.
* @param mutable
* {@code true} if schema is mutable, else {@code false}.
* @param hook
* Session hook.
*/
public DatabaseConfig(Settings ormSettings,
String schema,
long deactivateIfNotUsedSec,
boolean useJavaUDFs,
boolean mutable,
SessionHook hook)
{
this.ormSettings = ormSettings;
this.schema = schema;
this.deactivateIfNotUsedSec = deactivateIfNotUsedSec;
this.useJavaUDFs = useJavaUDFs;
this.mutable = mutable;
this.hook = hook;
}
/**
* Constructor which stores ORM settings and schema name.
*
* @param ormSettings
* ORM configuration settings.
* @param schema
* Schema name.
*/
public DatabaseConfig(Settings ormSettings, String schema)
{
this(ormSettings, schema, -1, true, false, null);
}
/**
* Get deactivate period in seconds.
*
* @return deactivate period in seconds
*/
public long getDeactivateIfNotUsedSec()
{
return deactivateIfNotUsedSec;
}
/**
* Check if Java UDFs should be used.
*
* @return <code>true</code> if Java UDFs should be used.
*/
public boolean isUseJavaUDFs()
{
return useJavaUDFs;
}
/**
* Get the properties needed by Hibernate to create a session factory.
*
* @return ORM configuration properties.
*/
public Settings getOrmSettings()
{
return ormSettings;
}
/**
* Get the database schema name.
*
* @return Schema name.
*/
public String getSchema()
{
return schema;
}
/**
* Indicate whether the database's schema is dynamically mutable.
*
* @return {@code true} if mutable, else {@code false}.
*/
public boolean isMutable()
{
return mutable;
}
/**
* Get the instance of hook object.
*
* @return See above.
*/
public SessionHook getHook()
{
return hook;
}
/**
* Replacement for the default object writing method.
*
* @param out
* The output destination to which fields will be saved.
*
* @throws IOException
* In case of I/O errors.
*/
@Override
public void writeExternal(ObjectOutput out) throws IOException
{
writeExternalizable(out, ormSettings);
writeString(out, schema);
writeLong(out, deactivateIfNotUsedSec);
writeBoolean(out, mutable);
}
/**
* Replacement for the default object reading method.
*
* @param in
* Input source from which fields will be restored.
*
* @throws IOException
* In case of I/O errors.
* @throws ClassNotFoundException
* If payload can't be instantiated.
*/
@Override
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
{
ormSettings = readExternalizable(in, Settings::new);
schema = readString(in);
Long val = readLong(in);
deactivateIfNotUsedSec = val == null ? -1 : val.longValue();
mutable = readBoolean(in);
}
}