org.apache.openjpa.jdbc.kernel.ValueTableJDBCSeq Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.apache.openjpa.jdbc.kernel;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Types;
import org.apache.openjpa.jdbc.conf.JDBCConfiguration;
import org.apache.openjpa.jdbc.conf.JDBCConfigurationImpl;
import org.apache.openjpa.jdbc.meta.ClassMapping;
import org.apache.openjpa.jdbc.meta.MappingRepository;
import org.apache.openjpa.jdbc.schema.Column;
import org.apache.openjpa.jdbc.schema.Table;
import org.apache.openjpa.jdbc.sql.DBDictionary;
import org.apache.openjpa.lib.conf.Configurations;
import org.apache.openjpa.lib.util.Localizer;
import org.apache.openjpa.lib.util.Options;
import org.apache.openjpa.meta.JavaTypes;
////////////////////////////////////////////////////////////
// NOTE: Do not change property names; see SequenceMetaData
// and SequenceMapping for standard property names.
////////////////////////////////////////////////////////////
/**
* Specialization of the {@link TableJDBCSeq} that maintains multiple
* sequence counts. Each instance of this class represents one row with
* a known string primary key value, more or less. The table name defaults
* to OPENJPA_SEQUENCES_TABLE.
*
* @author Abe White
*/
public class ValueTableJDBCSeq
extends TableJDBCSeq {
public static final String PK_VALUE = "PrimaryKeyValue";
private static final Localizer _loc = Localizer.forPackage
(ValueTableJDBCSeq.class);
private String _value = "DEFAULT";
public ValueTableJDBCSeq() {
setTable("OPENJPA_SEQUENCES_TABLE");
}
/**
* The primary key value for this row. Defaults to DEFAULT.
*/
public String getPrimaryKeyValue() {
return _value;
}
/**
* The primary key value for this row. Defaults to DEFAULT.
*/
public void setPrimaryKeyValue(String value) {
_value = value;
}
@Override
protected Column addPrimaryKeyColumn(Table table) {
DBDictionary dict = getConfiguration().getDBDictionaryInstance();
Column pkColumn = table.addColumn(dict.getValidColumnName
(getPrimaryKeyColumnIdentifier(), table));
pkColumn.setType(dict.getPreferredType(Types.VARCHAR));
pkColumn.setJavaType(JavaTypes.STRING);
pkColumn.setSize(dict.characterColumnSize);
return pkColumn;
}
@Override
protected Object getPrimaryKey(ClassMapping mapping) {
return _value;
}
/////////
// Main
/////////
/**
* Usage: java org.apache.openjpa.jdbc.kernel.ValueTableJDBCSeq [option]*
* -action/-a <add | drop | get | set> [primary key value] [value]
* Where the following options are recognized.
*
* - -properties/-p <properties file or resource>: The
* path or resource name of a OpenJPA properties file containing
* information such as the license key and connection data as
* outlined in {@link JDBCConfiguration}. Optional.
* - -<property name> <property value>: All bean
* properties of the OpenJPA {@link JDBCConfiguration} can be set by
* using their names and supplying a value. For example:
*
-licenseKey adslfja83r3lkadf
*
* The various actions are as follows.
*
* - add: Create the sequence table.
* - drop: Drop the sequence table.
* - get: Print the current sequence value for the given
* primary key value.
* - set: Set the sequence value for the given primary key
* value.
*
*/
public static void main(String[] args)
throws Exception {
Options opts = new Options();
final String[] arguments = opts.setFromCmdLine(args);
boolean ret = Configurations.runAgainstAllAnchors(opts,
new Configurations.Runnable() {
@Override
public boolean run(Options opts) throws Exception {
JDBCConfiguration conf = new JDBCConfigurationImpl();
try {
return ValueTableJDBCSeq.run(conf, arguments, opts);
} finally {
conf.close();
}
}
});
if (!ret) {
// START - ALLOW PRINT STATEMENTS
System.out.println(_loc.get("clstable-seq-usage"));
// STOP - ALLOW PRINT STATEMENTS
}
}
/**
* Run the tool. Returns false if invalid options were given.
*/
public static boolean run(JDBCConfiguration conf, String[] args,
Options opts)
throws Exception {
String action = opts.removeProperty("action", "a", null);
Configurations.populateConfiguration(conf, opts);
return run(conf, args, action, null, null);
}
/**
* Run the tool. Return false if an invalid option was given.
*/
public static boolean run(JDBCConfiguration conf, String[] args,
String action, MappingRepository repos, ClassLoader loader)
throws Exception {
ValueTableJDBCSeq seq = new ValueTableJDBCSeq();
String props = Configurations.getProperties(conf.getSequence());
Configurations.configureInstance(seq, conf, props);
if (ACTION_DROP.equals(action)) {
if (args.length != 0)
return false;
seq.dropTable();
} else if (ACTION_ADD.equals(action)) {
if (args.length != 0)
return false;
seq.refreshTable();
} else if (ACTION_GET.equals(action) || ACTION_SET.equals(action)) {
if (args.length > 0)
seq.setPrimaryKeyValue(args[0]);
Connection conn = conf.getDataSource2(null).getConnection();
try {
long cur = seq.getSequence(null, conn);
if (ACTION_GET.equals(action)) {
// START - ALLOW PRINT STATEMENTS
System.out.println(seq.getPrimaryKeyValue() + ": " + cur);
// STOP - ALLOW PRINT STATEMENTS
} else {
long set;
if (args.length > 1)
set = Long.parseLong(args[1]);
else
set = cur + seq.getAllocate();
if (set < cur)
set = cur;
else {
Status stat = seq.getStatus(null);
seq.setSequence(null, stat, (int) (set - cur), true,
conn);
set = stat.seq;
}
// START - ALLOW PRINT STATEMENTS
System.err.println(seq.getPrimaryKeyValue() + ": " + set);
// STOP - ALLOW PRINT STATEMENTS
}
}
catch (NumberFormatException nfe) {
return false;
} finally {
try {
conn.close();
} catch (SQLException se) {
}
}
} else
return false;
return true;
}
}