Java tutorial
/* * Apache License * Version 2.0, January 2004 * http://www.apache.org/licenses/ * * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION * * 1. Definitions. * * "License" shall mean the terms and conditions for use, reproduction, and * distribution as defined by Sections 1 through 9 of this document. * * "Licensor" shall mean the copyright owner or entity authorized by the copyright * owner that is granting the License. * * "Legal Entity" shall mean the union of the acting entity and all other entities * that control, are controlled by, or are under common control with that entity. * For the purposes of this definition, "control" means (i) the power, direct or * indirect, to cause the direction or management of such entity, whether by * contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the * outstanding shares, or (iii) beneficial ownership of such entity. * * "You" (or "Your") shall mean an individual or Legal Entity exercising * permissions granted by this License. * * "Source" form shall mean the preferred form for making modifications, including * but not limited to software tagSource code, documentation tagSource, and configuration * files. * * "Object" form shall mean any form resulting from mechanical transformation or * translation of a Source form, including but not limited to compiled object code, * generated documentation, and conversions to other media types. * * "Work" shall mean the work of authorship, whether in Source or Object form, made * available under the License, as indicated by a copyright notice that is included * in or attached to the work (an example is provided in the Appendix below). * * "Derivative Works" shall mean any work, whether in Source or Object form, that * is based on (or derived from) the Work and for which the editorial revisions, * annotations, elaborations, or other modifications represent, as a whole, an * original work of authorship. For the purposes of this License, Derivative Works * shall not include works that remain separable from, or merely link (or bind by * name) to the interfaces of, the Work and Derivative Works thereof. * * "Contribution" shall mean any work of authorship, including the original version * of the Work and any modifications or additions to that Work or Derivative Works * thereof, that is intentionally submitted to Licensor for inclusion in the Work * by the copyright owner or by an individual or Legal Entity authorized to submit * on behalf of the copyright owner. For the purposes of this definition, * "submitted" means any form of electronic, verbal, or written communication sent * to the Licensor or its representatives, including but not limited to * communication on electronic mailing lists, tagSource code control systems, and * issue tracking systems that are managed by, or on behalf of, the Licensor for * the purpose of discussing and improving the Work, but excluding communication * that is conspicuously marked or otherwise designated in writing by the copyright * owner as "Not a Contribution." * * "Contributor" shall mean Licensor and any individual or Legal Entity on behalf * of whom a Contribution has been received by Licensor and subsequently * incorporated within the Work. * * 2. Grant of Copyright License. * * Subject to the terms and conditions of this License, each Contributor hereby * grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, * irrevocable copyright license to reproduce, prepare Derivative Works of, * publicly display, publicly perform, sublicense, and distribute the Work and such * Derivative Works in Source or Object form. * * 3. Grant of Patent License. * * Subject to the terms and conditions of this License, each Contributor hereby * grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, * irrevocable (except as stated in this section) patent license to make, have * made, use, offer to sell, sell, import, and otherwise transfer the Work, where * such license applies only to those patent claims licensable by such Contributor * that are necessarily infringed by their Contribution(s) alone or by combination * of their Contribution(s) with the Work to which such Contribution(s) was * submitted. If You institute patent litigation against any entity (including a * cross-claim or counterclaim in a lawsuit) alleging that the Work or a * Contribution incorporated within the Work constitutes direct or contributory * patent infringement, then any patent licenses granted to You under this License * for that Work shall terminate as of the date such litigation is filed. * * 4. Redistribution. * * You may reproduce and distribute copies of the Work or Derivative Works thereof * in any medium, with or without modifications, and in Source or Object form, * provided that You meet the following conditions: * * You must give any other recipients of the Work or Derivative Works a copy of * this License; and * You must cause any modified files to carry prominent notices stating that You * changed the files; and * You must retain, in the Source form of any Derivative Works that You distribute, * all copyright, patent, trademark, and attribution notices from the Source form * of the Work, excluding those notices that do not pertain to any part of the * Derivative Works; and * If the Work includes a "NOTICE" text file as part of its distribution, then any * Derivative Works that You distribute must include a readable copy of the * attribution notices contained within such NOTICE file, excluding those notices * that do not pertain to any part of the Derivative Works, in at least one of the * following places: within a NOTICE text file distributed as part of the * Derivative Works; within the Source form or documentation, if provided along * with the Derivative Works; or, within a display generated by the Derivative * Works, if and wherever such third-party notices normally appear. The contents of * the NOTICE file are for informational purposes only and do not modify the * License. You may add Your own attribution notices within Derivative Works that * You distribute, alongside or as an addendum to the NOTICE text from the Work, * provided that such additional attribution notices cannot be construed as * modifying the License. * You may add Your own copyright statement to Your modifications and may provide * additional or different license terms and conditions for use, reproduction, or * distribution of Your modifications, or for any such Derivative Works as a whole, * provided Your use, reproduction, and distribution of the Work otherwise complies * with the conditions stated in this License. * * 5. Submission of Contributions. * * Unless You explicitly state otherwise, any Contribution intentionally submitted * for inclusion in the Work by You to the Licensor shall be under the terms and * conditions of this License, without any additional terms or conditions. * Notwithstanding the above, nothing herein shall supersede or modify the terms of * any separate license agreement you may have executed with Licensor regarding * such Contributions. * * 6. Trademarks. * * This License does not grant permission to use the trade names, trademarks, * service marks, or product names of the Licensor, except as required for * reasonable and customary use in describing the origin of the Work and * reproducing the content of the NOTICE file. * * 7. Disclaimer of Warranty. * * Unless required by applicable law or agreed to in writing, Licensor provides the * Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, * including, without limitation, any warranties or conditions of TITLE, * NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are * solely responsible for determining the appropriateness of using or * redistributing the Work and assume any risks associated with Your exercise of * permissions under this License. * * 8. Limitation of Liability. * * In no event and under no legal theory, whether in tort (including negligence), * contract, or otherwise, unless required by applicable law (such as deliberate * and grossly negligent acts) or agreed to in writing, shall any Contributor be * liable to You for damages, including any direct, indirect, special, incidental, * or consequential damages of any character arising as a result of this License or * out of the use or inability to use the Work (including but not limited to * damages for loss of goodwill, work stoppage, computer failure or malfunction, or * any and all other commercial damages or losses), even if such Contributor has * been advised of the possibility of such damages. * * 9. Accepting Warranty or Additional Liability. * * While redistributing the Work or Derivative Works thereof, You may choose to * offer, and charge a fee for, acceptance of support, warranty, indemnity, or * other liability obligations and/or rights consistent with this License. However, * in accepting such obligations, You may act only on Your own behalf and on Your * sole responsibility, not on behalf of any other Contributor, and only if You * agree to indemnify, defend, and hold each Contributor harmless for any liability * incurred by, or claims asserted against, such Contributor by reason of your * accepting any such warranty or additional liability. * * END OF TERMS AND CONDITIONS * * APPENDIX: How to apply the Apache License to your work * * To apply the Apache License to your work, attach the following boilerplate * notice, with the fields enclosed by brackets "[]" replaced with your own * identifying information. (Don't include the brackets!) The text should be * enclosed in the appropriate comment syntax for the file format. We also * recommend that a file or class name and description of purpose be included on * the same "printed page" as the copyright notice for easier identification within * third-party archives. * * Copyright [yyyy] [name of copyright owner] * * 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. */ package org.normandra.orientdb.data; import com.orientechnologies.orient.core.db.document.ODatabaseDocument; import com.orientechnologies.orient.core.index.OIndex; import com.orientechnologies.orient.core.metadata.schema.OClass; import com.orientechnologies.orient.core.metadata.schema.OProperty; import com.orientechnologies.orient.core.metadata.schema.OType; import com.orientechnologies.orient.core.sql.OCommandSQL; import org.apache.commons.io.FilenameUtils; import org.apache.commons.lang.NullArgumentException; import org.apache.commons.lang3.StringUtils; import org.normandra.Database; import org.normandra.DatabaseConstruction; import org.normandra.NormandraException; import org.normandra.cache.EntityCacheFactory; import org.normandra.data.ColumnAccessorFactory; import org.normandra.generator.IdGenerator; import org.normandra.meta.*; import org.normandra.util.ArraySet; import org.normandra.util.CaseUtils; import org.normandra.util.QueryUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.SequenceGenerator; import javax.persistence.TableGenerator; import java.io.File; import java.lang.reflect.Field; import java.util.*; import java.util.concurrent.ConcurrentHashMap; import java.util.stream.Collectors; public class OrientDatabase implements Database { private static final Logger logger = LoggerFactory.getLogger(OrientDatabase.class); protected static final ColumnAccessorFactory columnFactory = new OrientAccessorFactory(); public static boolean isLocal(final String url) { if (null == url || url.isEmpty()) { return false; } return url.toLowerCase().startsWith("embedded:") || url.toLowerCase().startsWith("plocal:") || url.toLowerCase().startsWith("local:"); } public static OrientDatabase createRemote(final String url, final String database, final String userid, final String password, final EntityCacheFactory factory, final DatabaseConstruction mode, final Collection<Class> types) { final OrientPool pool = new FixedOrientPool(url, database, userid, password); final AnnotationParser parser = new AnnotationParser(columnFactory, types); final DatabaseMeta meta = new DatabaseMeta(parser.read()); return new OrientDatabase(url, pool, factory, mode, meta); } public static OrientDatabase createRemote(final String url, final String database, final String userid, final String password, final EntityCacheFactory factory, final DatabaseConstruction mode, final DatabaseMetaBuilder metaBuilder) { final OrientPool pool = new FixedOrientPool(url, database, userid, password); final DatabaseMeta meta = metaBuilder.withColumnFactory(columnFactory).create(); return new OrientDatabase(url, pool, factory, mode, meta); } public static OrientDatabase createLocalFile(final File path, final String database, final EntityCacheFactory factory, final DatabaseConstruction mode, final Collection<Class> types) { final String url = "plocal:" + FilenameUtils.normalize(path.getAbsolutePath()); final OrientPool pool = new LocalFileOrientPool(url, database, "admin", "admin"); final AnnotationParser parser = new AnnotationParser(columnFactory, types); final DatabaseMeta meta = new DatabaseMeta(parser.read()); return new OrientDatabase(url, pool, factory, mode, meta); } public static OrientDatabase createLocalFile(final File path, final String database, final EntityCacheFactory factory, final DatabaseConstruction mode, final DatabaseMetaBuilder metaBuilder) { final String url = "plocal:" + FilenameUtils.normalize(path.getAbsolutePath()); final OrientPool pool = new LocalFileOrientPool(url, database, "admin", "admin"); final DatabaseMeta meta = metaBuilder.withColumnFactory(columnFactory).create(); return new OrientDatabase(url, pool, factory, mode, meta); } public static OrientDatabase createLocalServer(final File path, final String database, final String userid, final String password, final boolean separateProcess, final EntityCacheFactory factory, final DatabaseConstruction mode, final Collection<Class> types) { final OrientPool pool = new LocalServerOrientPool(path, database, userid, password, separateProcess); final AnnotationParser parser = new AnnotationParser(columnFactory, types); final DatabaseMeta meta = new DatabaseMeta(parser.read()); return new OrientDatabase("remote:localhost", pool, factory, mode, meta); } public static OrientDatabase createLocalServer(final File path, final String database, final String userid, final String password, final boolean separateProcess, final EntityCacheFactory factory, final DatabaseConstruction mode, final DatabaseMetaBuilder metaBuilder) { final OrientPool pool = new LocalServerOrientPool(path, database, userid, password, separateProcess); final DatabaseMeta meta = metaBuilder.withColumnFactory(columnFactory).create(); return new OrientDatabase("remote:localhost", pool, factory, mode, meta); } protected final String url; protected final OrientPool pool; protected final EntityCacheFactory cache; protected final DatabaseConstruction constructionMode; protected final Map<String, OrientQuery> statementsByName = new ConcurrentHashMap<>(); private final DatabaseMeta meta; protected OrientDatabase(final String url, final OrientPool pool, final EntityCacheFactory cache, final DatabaseConstruction mode, final DatabaseMeta meta) { if (null == cache) { throw new NullArgumentException("cache factory"); } if (null == mode) { throw new NullArgumentException("construction mode"); } if (null == pool) { throw new NullArgumentException("pool"); } this.url = url; this.pool = pool; this.cache = cache; this.constructionMode = mode; this.meta = meta; } public DatabaseMeta getMeta() { return this.meta; } final ODatabaseDocument createDatabase() { return this.pool.acquire(); } @Override public OrientDatabaseSession createSession() { return new OrientDatabaseSession(this.createDatabase(), this.statementsByName, this.cache.create()); } @Override public void refresh() throws NormandraException { if (DatabaseConstruction.NONE.equals(this.constructionMode)) { return; } // setup entity schema try (final ODatabaseDocument database = this.createDatabase()) { for (final EntityMeta entity : this.meta.getEntities()) { this.refreshEntityWithTransaction(entity, database); this.refreshGenerators(entity, database); } } catch (final Exception e) { throw new NormandraException("Unable to refresh database.", e); } } private void refreshGenerators(final EntityMeta entity, final ODatabaseDocument database) { // setup any table sequence/id generators for (final Class<?> entityType : entity.getTypes()) { final AnnotationParser parser = new AnnotationParser(new OrientAccessorFactory(), entityType); for (final Map.Entry<Field, GeneratedValue> entry : parser.getGenerators(entityType).entrySet()) { final Field field = entry.getKey(); final GeneratedValue generator = entry.getValue(); final String type = generator.generator(); String tableName = "id_generator"; String keyColumn = "id"; String keyValue = CaseUtils.camelToSnakeCase(entity.getName()); String valueColumn = "value"; if (GenerationType.TABLE.equals(generator.strategy())) { for (final TableGenerator table : parser.findAnnotations(entityType, TableGenerator.class)) { if (type.equalsIgnoreCase(table.name())) { if (!table.table().isEmpty()) { tableName = table.table(); } if (!table.pkColumnName().isEmpty()) { keyColumn = table.pkColumnName(); } if (!table.pkColumnValue().isEmpty()) { keyValue = table.pkColumnValue(); } if (!table.valueColumnName().isEmpty()) { valueColumn = table.valueColumnName(); } } } } else if (GenerationType.SEQUENCE.equals(generator.strategy())) { for (final SequenceGenerator sequence : parser.findAnnotations(entityType, SequenceGenerator.class)) { if (type.equalsIgnoreCase(sequence.name())) { if (!sequence.sequenceName().isEmpty()) { keyValue = sequence.sequenceName(); } } } } else if (GenerationType.IDENTITY.equals(generator.strategy())) { throw new IllegalStateException( "No support available for orient-db identity primary key generation."); } // get the column type final String fieldName = field.getName(); final String indexName = tableName + "." + keyColumn; final ColumnMeta column = entity.findColumn(fieldName); if (null == column) { throw new IllegalStateException( "Unable to locate primary key [" + fieldName + "] for entity [" + entity + "]."); } // drop table as required if (DatabaseConstruction.RECREATE.equals(this.constructionMode)) { if (hasCluster(database, tableName)) { database.command(new OCommandSQL("DELETE FROM " + tableName)).execute(); database.getMetadata().getSchema().dropClass(tableName); } if (hasIndex(database, indexName)) { database.command(new OCommandSQL("DROP INDEX " + indexName)).execute(); database.getMetadata().getIndexManager().dropIndex(indexName); } } // create sequence schema final OClass schemaClass = database.getMetadata().getSchema().getOrCreateClass(tableName); if (!schemaClass.existsProperty(keyColumn)) { schemaClass.createProperty(keyColumn, OType.STRING); } if (!schemaClass.existsProperty(valueColumn)) { schemaClass.createProperty(valueColumn, OrientUtils.columnType(column)); } if (!schemaClass.areIndexed(keyColumn)) { schemaClass.createIndex(indexName, OClass.INDEX_TYPE.UNIQUE, keyColumn); } // assign generator final IdGenerator counter = new OrientIdGenerator(tableName, indexName, keyColumn, valueColumn, keyValue, this); entity.setGenerator(column, counter); logger.info("Set counter id generator for [" + column + "] on entity [" + entity + "]."); } } } private void refreshEntityWithTransaction(final EntityMeta entity, final ODatabaseDocument database) { final String keyIndex = OrientUtils.keyIndex(entity); final String schemaName = entity.getTable(); if (DatabaseConstruction.RECREATE.equals(this.constructionMode)) { // drop schema if (hasClass(database, schemaName)) { database.command(new OCommandSQL("DELETE FROM " + schemaName + " UNSAFE")).execute(); } if (hasIndex(database, keyIndex)) { database.command(new OCommandSQL("DROP INDEX " + keyIndex)).execute(); } for (final IndexMeta index : entity.getIndexed()) { final String indexName; if (index.getColumns().size() == 1) { final ColumnMeta column = index.getColumns().iterator().next(); indexName = schemaName + "." + column.getName(); } else { indexName = schemaName + "." + index.getName(); } if (hasIndex(database, indexName)) { database.command(new OCommandSQL("DROP INDEX " + indexName)).execute(); } } } // create new class final OClass schemaClass = database.getMetadata().getSchema().getOrCreateClass(schemaName); final Set<ColumnMeta> primary = new ArraySet<>(); for (final ColumnMeta column : entity) { final String property = column.getName(); final OType type = OrientUtils.columnType(column); if (type != null && !schemaClass.existsProperty(property)) { schemaClass.createProperty(property, type); } if (column.isPrimaryKey()) { primary.add(column); } } // create index as needed if (!hasIndex(database, keyIndex)) { final Collection<String> names = primary.stream().filter(Objects::nonNull).map(ColumnMeta::getName) .collect(Collectors.toList()); if (!names.isEmpty()) { logger.debug("Adding primary id index [" + keyIndex + "] with " + names + " ..."); database.command(new OCommandSQL("CREATE INDEX " + keyIndex + " ON " + schemaName + " (" + StringUtils.join(names, ",") + ") UNIQUE")).execute(); } } for (final IndexMeta index : entity.getIndexed()) { final String uniqueness = index.isUnique() ? "UNIQUE" : "NOTUNIQUE"; final Collection<String> names = index.getColumns().stream().map(ColumnMeta::getName) .collect(Collectors.toList()); final String indexName = schemaName + "." + index.getName(); if (!names.isEmpty() && !hasIndex(database, indexName)) { logger.debug( "Adding property index [" + indexName + "] with " + names + " (" + uniqueness + ") ..."); database.command(new OCommandSQL("CREATE INDEX " + indexName + " ON " + schemaName + " (" + StringUtils.join(names, ",") + ") " + uniqueness)).execute(); } } } @Override public boolean registerQuery(final EntityMeta entity, final String name, final String query) throws NormandraException { if (null == name || name.isEmpty()) { return false; } if (null == query || query.isEmpty()) { return false; } if (this.statementsByName.containsKey(name)) { return false; } final String tableQuery = QueryUtils.prepare(entity, query); if (null == tableQuery || tableQuery.isEmpty()) { return false; } final OrientQuery prepared = new OrientQuery(query, tableQuery); this.statementsByName.put(name, prepared); return true; } @Override public boolean unregisterQuery(final String name) { if (null == name || name.isEmpty()) { return false; } return this.statementsByName.remove(name) != null; } private static Collection<String> getClasses(final ODatabaseDocument database) { final Collection<OClass> types = database.getMetadata().getSchema().getClasses(); if (null == types || types.isEmpty()) { return Collections.emptyList(); } final List<String> list = new ArrayList<>(types.size()); for (final OClass type : types) { list.add(type.getName()); } return Collections.unmodifiableCollection(list); } private static Collection<String> getClusters(final ODatabaseDocument database) { final Collection<String> names = database.getClusterNames(); if (null == names || names.isEmpty()) { return Collections.emptyList(); } return Collections.unmodifiableCollection(names); } private static Collection<String> getIndices(final ODatabaseDocument database) { final List<String> names = new ArrayList<>(); for (final OIndex index : database.getMetadata().getIndexManager().getIndexes()) { names.add(index.getName()); } return Collections.unmodifiableCollection(names); } private static boolean hasIndex(final ODatabaseDocument database, final String clusterName) { if (null == clusterName || clusterName.isEmpty()) { return false; } for (final String existing : getIndices(database)) { if (clusterName.equalsIgnoreCase(existing)) { return true; } } return false; } private static boolean hasCluster(final ODatabaseDocument database, final String clusterName) { if (null == clusterName || clusterName.isEmpty()) { return false; } for (final String existing : getClusters(database)) { if (clusterName.equalsIgnoreCase(existing)) { return true; } } return false; } private static boolean hasClass(final ODatabaseDocument database, final String className) { if (null == className || className.isEmpty()) { return false; } for (final String existing : getClasses(database)) { if (className.equalsIgnoreCase(existing)) { return true; } } return false; } private static boolean hasProperty(final ODatabaseDocument database, final String className, final String fieldName) { final OClass schemaClass = database.getMetadata().getSchema().getClass(className); if (null == schemaClass) { return false; } final OProperty property = schemaClass.getProperty(fieldName); if (null == property) { return false; } return property.getType() != null; } @Override public void close() { this.pool.close(); } }