| /* |
| * Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved. |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v. 2.0 which is available at |
| * http://www.eclipse.org/legal/epl-2.0, |
| * or the Eclipse Distribution License v. 1.0 which is available at |
| * http://www.eclipse.org/org/documents/edl-v10.php. |
| * |
| * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause |
| */ |
| |
| // Contributors: |
| // Oracle - initial API and implementation from Oracle TopLink |
| // 09/14/2017-2.6 Will Dazey |
| // - 522312: Add the eclipselink.sequencing.start-sequence-at-nextval property |
| package org.eclipse.persistence.sequencing; |
| |
| import java.util.Vector; |
| import org.eclipse.persistence.internal.databaseaccess.Accessor; |
| import org.eclipse.persistence.internal.sessions.AbstractSession; |
| import org.eclipse.persistence.exceptions.ValidationException; |
| import org.eclipse.persistence.exceptions.DatabaseException; |
| |
| /** |
| * <p> |
| * <b>Purpose</b>: An abstract class providing default sequence behavior. |
| * </p> |
| */ |
| public abstract class StandardSequence extends Sequence { |
| protected StandardSequence() { |
| super(); |
| } |
| |
| protected StandardSequence(String name) { |
| super(name); |
| } |
| |
| protected StandardSequence(String name, int size) { |
| super(name, size); |
| } |
| |
| protected StandardSequence(String name, int size, int initialValue) { |
| super(name, size, initialValue); |
| } |
| |
| @Override |
| public void onConnect() { |
| // does nothing |
| } |
| |
| @Override |
| public void onDisconnect() { |
| // does nothing |
| } |
| |
| protected abstract Number updateAndSelectSequence(Accessor accessor, AbstractSession writeSession, String seqName, int size); |
| |
| @Override |
| public abstract boolean shouldAcquireValueAfterInsert(); |
| |
| @Override |
| public abstract boolean shouldUseTransaction(); |
| |
| @Override |
| public Object getGeneratedValue(Accessor accessor, AbstractSession writeSession, String seqName) { |
| if (shouldUsePreallocation()) { |
| return null; |
| } else { |
| Number value = updateAndSelectSequence(accessor, writeSession, seqName, 1); |
| if (value == null) { |
| throw DatabaseException.errorPreallocatingSequenceNumbers(); |
| } |
| return value; |
| } |
| } |
| |
| @Override |
| public Vector<?> getGeneratedVector(Accessor accessor, AbstractSession writeSession, String seqName, int size) { |
| if (shouldUsePreallocation()) { |
| Number value = updateAndSelectSequence(accessor, writeSession, seqName, size); |
| if (value == null) { |
| throw DatabaseException.errorPreallocatingSequenceNumbers(); |
| } |
| if(writeSession.getPlatform().getDefaultSeqenceAtNextValue()) { |
| return createVectorAtNextVal(value, seqName, size); |
| } |
| return createVector(value, seqName, size); |
| } else { |
| return null; |
| } |
| } |
| |
| /** |
| * INTERNAL: |
| * given sequence = 10, size = 5 will create Vector (6,7,8,9,10) |
| * @param seqName String is sequencing number field name |
| * @param size int size of Vector to create. |
| */ |
| protected Vector<Number> createVector(Number sequence, String seqName, int size) { |
| long nextSequence = sequence.longValue(); |
| |
| Vector<Number> sequencesForName = new Vector<>(size); |
| nextSequence = nextSequence - size; |
| |
| // Check for incorrect values return to validate that the sequence is setup correctly. |
| // PRS 36451 intvalue would wrap |
| if (nextSequence < -1L) { |
| throw ValidationException.sequenceSetupIncorrectly(seqName); |
| } |
| |
| for (int index = size; index > 0; index--) { |
| nextSequence = nextSequence + 1L; |
| sequencesForName.add(nextSequence); |
| } |
| return sequencesForName; |
| } |
| |
| /** |
| * INTERNAL: |
| * given sequence = 10, size = 5 will create Vector (10,11,12,13,14) |
| * @param seqName String is sequencing number field name |
| * @param size int size of Vector to create. |
| */ |
| protected Vector<Number> createVectorAtNextVal(Number sequence, String seqName, int size) { |
| long nextSequence = sequence.longValue(); |
| |
| Vector<Number> sequencesForName = new Vector<>(size); |
| |
| // Check for incorrect values return to validate that the sequence is setup correctly. |
| // PRS 36451 intvalue would wrap |
| if (nextSequence < -1L) { |
| throw ValidationException.sequenceSetupIncorrectly(seqName); |
| } |
| |
| for (int index = size; index > 0; index--) { |
| sequencesForName.add(nextSequence); |
| nextSequence = nextSequence + 1L; |
| } |
| return sequencesForName; |
| } |
| |
| @Override |
| public void setInitialValue(int initialValue) { |
| // sequence value should be positive |
| if (initialValue <= 0) { |
| initialValue = 1; |
| } |
| super.setInitialValue(initialValue); |
| } |
| } |