org.hsqldb.SqlInvariants Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hsqldb Show documentation
Show all versions of hsqldb Show documentation
HSQLDB - Lightweight 100% Java SQL Database Engine
/* Copyright (c) 2001-2019, The HSQL Development Group
* 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 HSQL Development Group nor the names of its
* contributors 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 HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* 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 org.hsqldb;
import org.hsqldb.HsqlNameManager.HsqlName;
import org.hsqldb.error.Error;
import org.hsqldb.error.ErrorCode;
/**
* Invariant schema objects.
*
* @author Fred Toussi (fredt@users dot sourceforge.net)
* @version 2.3.1
* @since 1.9.0
*/
public final class SqlInvariants {
/**
* The role name reserved for authorization of INFORMATION_SCHEMA and
* system objects.
*/
public static final String SYSTEM_AUTHORIZATION_NAME = "_SYSTEM";
/** The role name reserved for ADMIN users. */
public static final String DBA_ADMIN_ROLE_NAME = "DBA";
/** The role name allowing schema creation for users. */
public static final String SCHEMA_CREATE_ROLE_NAME = "CREATE_SCHEMA";
/** The role name allowing switching authorisation for users. */
public static final String CHANGE_AUTH_ROLE_NAME = "CHANGE_AUTHORIZATION";
//
public static final String SYSTEM_SUBQUERY = "SYSTEM_SUBQUERY";
/** The role name reserved for the special PUBLIC pseudo-user. */
public static final String PUBLIC_ROLE_NAME = "PUBLIC";
public static final String DEFAULT_CATALOG_NAME = "PUBLIC";
public static final String SYSTEM_SCHEMA = "SYSTEM_SCHEMA";
public static final String LOBS_SCHEMA = "SYSTEM_LOBS";
public static final String DEFINITION_SCHEMA = "DEFINITION_SCHEMA";
public static final String INFORMATION_SCHEMA = "INFORMATION_SCHEMA";
public static final String SQLJ_SCHEMA = "SQLJ";
public static final String PUBLIC_SCHEMA = "PUBLIC";
public static final String CLASSPATH_NAME = "CLASSPATH";
public static final String MODULE = "MODULE";
public static final String DUAL = "DUAL";
public static final String DUMMY = "DUMMY";
public static final String IDX = "IDX";
public static final HsqlName INFORMATION_SCHEMA_HSQLNAME;
public static final HsqlName SYSTEM_SCHEMA_HSQLNAME;
public static final HsqlName LOBS_SCHEMA_HSQLNAME;
public static final HsqlName SQLJ_SCHEMA_HSQLNAME;
public static final HsqlName SYSTEM_SUBQUERY_HSQLNAME;
public static final HsqlName MODULE_HSQLNAME;
public static final HsqlName DUAL_TABLE_HSQLNAME;
public static final HsqlName DUAL_COLUMN_HSQLNAME;
public static final HsqlName SYSTEM_INDEX_HSQLNAME;
static {
INFORMATION_SCHEMA_HSQLNAME =
HsqlNameManager.newSystemObjectName(INFORMATION_SCHEMA,
SchemaObject.SCHEMA);
SYSTEM_SCHEMA_HSQLNAME =
HsqlNameManager.newSystemObjectName(SYSTEM_SCHEMA,
SchemaObject.SCHEMA);
LOBS_SCHEMA_HSQLNAME = HsqlNameManager.newSystemObjectName(LOBS_SCHEMA,
SchemaObject.SCHEMA);
SQLJ_SCHEMA_HSQLNAME = HsqlNameManager.newSystemObjectName(SQLJ_SCHEMA,
SchemaObject.SCHEMA);
SYSTEM_SUBQUERY_HSQLNAME =
HsqlNameManager.newSystemObjectName(SYSTEM_SUBQUERY,
SchemaObject.TABLE);
MODULE_HSQLNAME = HsqlNameManager.newSystemObjectName(MODULE,
SchemaObject.SCHEMA);
DUAL_TABLE_HSQLNAME = HsqlNameManager.newSystemObjectName(DUAL,
SchemaObject.TABLE);
DUAL_TABLE_HSQLNAME.schema = SYSTEM_SCHEMA_HSQLNAME;
DUAL_COLUMN_HSQLNAME = HsqlNameManager.newSystemObjectName(DUMMY,
SchemaObject.COLUMN);
DUAL_COLUMN_HSQLNAME.parent = DUAL_TABLE_HSQLNAME;
SYSTEM_INDEX_HSQLNAME = HsqlNameManager.newSystemObjectName(IDX,
SchemaObject.INDEX);
SYSTEM_SUBQUERY_HSQLNAME.setSchemaIfNull(SYSTEM_SCHEMA_HSQLNAME);
}
public static void checkSchemaNameNotSystem(String name) {
if (isSystemSchemaName(name)) {
throw Error.error(ErrorCode.X_42503, name);
}
}
public static boolean isSystemSchemaName(String name) {
if (SqlInvariants.DEFINITION_SCHEMA.equals(name)
|| SqlInvariants.INFORMATION_SCHEMA.equals(name)
|| SqlInvariants.SYSTEM_SCHEMA.equals(name)
|| SqlInvariants.SQLJ_SCHEMA.equals(name)) {
return true;
}
return false;
}
public static boolean isLobsSchemaName(String name) {
if (SqlInvariants.LOBS_SCHEMA.equals(name)) {
return true;
}
return false;
}
public static boolean isSchemaNameSystem(HsqlName name) {
if (name.schema != null) {
name = name.schema;
}
if (SqlInvariants.INFORMATION_SCHEMA_HSQLNAME.equals(name)
|| SqlInvariants.SYSTEM_SCHEMA_HSQLNAME.equals(name)
|| SqlInvariants.SQLJ_SCHEMA_HSQLNAME.equals(name)) {
return true;
}
return false;
}
}