org.dbflute.bhv.exception.BehaviorExceptionThrower Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation
Show all versions of dbflute-runtime Show documentation
The runtime library of DBFlute
/*
* Copyright 2014-2023 the original author or authors.
*
* 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.dbflute.bhv.exception;
import java.io.Serializable;
import java.util.List;
import org.dbflute.Entity;
import org.dbflute.bhv.writable.DeleteOption;
import org.dbflute.bhv.writable.UpdateOption;
import org.dbflute.bhv.writable.WritableOption;
import org.dbflute.cbean.ConditionBean;
import org.dbflute.cbean.chelper.HpInvalidQueryInfo;
import org.dbflute.cbean.paging.PagingBean;
import org.dbflute.exception.BatchUpdateUniqueByUnsupportedException;
import org.dbflute.exception.DangerousResultSizeException;
import org.dbflute.exception.EntityAlreadyDeletedException;
import org.dbflute.exception.EntityDuplicatedException;
import org.dbflute.exception.EntityPrimaryKeyNotFoundException;
import org.dbflute.exception.EntityUniqueKeyNotFoundException;
import org.dbflute.exception.FetchingOverSafetySizeException;
import org.dbflute.exception.NonQueryDeleteNotAllowedException;
import org.dbflute.exception.NonQueryUpdateNotAllowedException;
import org.dbflute.exception.OptimisticLockColumnValueNullException;
import org.dbflute.exception.PagingCountSelectNotCountException;
import org.dbflute.exception.ScalarSelectValueNotFoundException;
import org.dbflute.exception.SelectEntityConditionNotFoundException;
import org.dbflute.helper.message.ExceptionMessageBuilder;
import org.dbflute.jdbc.FetchBean;
import org.dbflute.system.DBFluteSystem;
import org.dbflute.util.DfTypeUtil;
import org.dbflute.util.Srl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author jflute
*/
public class BehaviorExceptionThrower implements Serializable {
private static final long serialVersionUID = 1L;
// ===================================================================================
// Definition
// ==========
private static final Logger _log = LoggerFactory.getLogger(BehaviorExceptionThrower.class);
// ===================================================================================
// Select
// ======
public void throwSelectEntityAlreadyDeletedException(Object searchKey) {
final ExceptionMessageBuilder br = createExceptionMessageBuilder();
br.addNotice("Not found the entity by the condition. (might be deleted?)");
br.addItem("Advice");
br.addElement("Please confirm the existence of your target record on your database.");
br.addElement("Does the target record really created before this operation?");
br.addElement("Has the target record been deleted by other thread?");
br.addElement("It is precondition that the record exists on your database.");
setupSearchKeyElement(br, searchKey);
final String msg = br.buildExceptionMessage();
throw new EntityAlreadyDeletedException(msg); // basically treated as application exception
}
public void throwSelectEntityDuplicatedException(String resultCountExp, Object searchKey, Throwable cause) {
final ExceptionMessageBuilder br = createExceptionMessageBuilder();
br.addNotice("Duplicate entity by the condition. (should be the only one)");
br.addItem("Advice");
br.addElement("Confirm your search condition. Is it really for the only one?");
br.addElement("And confirm your database. Does it really exist the only one?");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" memberBhv.selectEntity(cb -> {");
br.addElement(" cb.query().setMemberName_LikeSearch(\"S\", op -> op.likePrefix());");
br.addElement(" }).alwaysPresent(...)");
br.addElement(" (o):");
br.addElement(" memberBhv.selectEntity(cb -> {");
br.addElement(" cb.query().setMemberId_Equal(3);");
br.addElement(" }).alwaysPresent(...)");
br.addItem("Result Count");
br.addElement(resultCountExp);
setupSearchKeyElement(br, searchKey);
final String msg = br.buildExceptionMessage();
if (cause != null) {
throw new EntityDuplicatedException(msg, cause);
} else {
throw new EntityDuplicatedException(msg);
}
}
protected void setupSearchKeyElement(ExceptionMessageBuilder br, Object searchKey) {
if (searchKey instanceof Object[]) {
final Object[] ary = (Object[]) searchKey;
if (ary.length == 1) {
searchKey = ary[0];
} else {
final StringBuilder sb = new StringBuilder();
for (Object obj : ary) {
if (sb.length() > 0) {
sb.append(", ");
}
sb.append(obj);
}
sb.insert(0, "{").append("}");
searchKey = sb.toString();
}
}
if (searchKey instanceof ConditionBean) {
final ConditionBean cb = (ConditionBean) searchKey;
setupInvalidQueryElement(br, cb);
setupDisplaySqlElement(br, cb);
} else {
br.addItem("Search Condition");
br.addElement(searchKey);
}
}
public void throwSelectEntityConditionNotFoundException(ConditionBean cb) {
final ExceptionMessageBuilder br = createExceptionMessageBuilder();
br.addNotice("The condition for selecting an entity was not found!");
br.addItem("Advice");
br.addElement("Confirm your search condition. Does it really select the only one?");
br.addElement("You have to set a valid query or fetch-first as 1.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" ... = memberBhv.selectEntity(cb -> {}); // exception");
br.addElement(" (x):");
br.addElement(" ... = memberBhv.selectEntity(cb -> cb.query().setMemberId_Equal(null)); // exception");
br.addElement(" (o):");
br.addElement(" ... = memberBhv.selectEntity(cb -> cb.query().setMemberId_Equal(3));");
br.addElement(" (o):");
br.addElement(" ... = memberBhv.selectEntity(cb -> cb.fetchFirst(1));");
setupInvalidQueryElement(br, cb);
setupFetchSizeElement(br, cb);
setupDisplaySqlElement(br, cb);
final String msg = br.buildExceptionMessage();
throw new SelectEntityConditionNotFoundException(msg);
}
public void throwDangerousResultSizeException(FetchBean fetchBean, Throwable cause) {
final int safetyMaxResultSize = fetchBean.getSafetyMaxResultSize();
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("You've already been in DANGER ZONE. (check is working)");
br.addItem("Advice");
br.addElement("The selected size is over the specified safety size.");
br.addElement("Confirm your conditions and table records.");
br.addItem("Safety Max Result Size");
br.addElement(safetyMaxResultSize);
if (fetchBean instanceof ConditionBean) {
final ConditionBean cb = ((ConditionBean) fetchBean);
setupInvalidQueryElement(br, cb);
setupFetchSizeElement(br, cb);
setupDisplaySqlElement(br, cb);
} else {
br.addItem("Fetch Bean");
br.addElement(fetchBean);
if (cause instanceof FetchingOverSafetySizeException) {
final String sql = ((FetchingOverSafetySizeException) cause).getDangerousDisplaySql();
if (sql != null) {
br.addItem("Dangerous SQL");
br.addElement(sql);
}
}
}
final String msg = br.buildExceptionMessage();
throw new DangerousResultSizeException(msg, cause, safetyMaxResultSize);
}
protected void setupInvalidQueryElement(ExceptionMessageBuilder br, ConditionBean cb) {
br.addItem("Invalid Query");
final List invalidQueryList = cb.getSqlClause().getInvalidQueryList();
if (invalidQueryList != null && !invalidQueryList.isEmpty()) {
for (HpInvalidQueryInfo invalidQueryInfo : invalidQueryList) {
br.addElement(invalidQueryInfo.buildDisplay());
}
} else {
br.addElement("*no invalid");
}
}
protected void setupFetchSizeElement(ExceptionMessageBuilder br, ConditionBean cb) {
br.addItem("Fetch Size");
br.addElement(cb.getFetchSize());
}
protected void setupDisplaySqlElement(ExceptionMessageBuilder br, ConditionBean cb) {
br.addItem("Display SQL");
br.addElement(cb.toDisplaySql());
}
public void throwPagingCountSelectNotCountException(String tableDbName, String path, PagingBean pmb, Class entityType,
EntityDuplicatedException e) { // for OutsideSql
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The count select for paging could not get a count.");
br.addItem("Advice");
br.addElement("A select clause of OutsideSql paging should be switchable like this:");
br.addElement("For example:");
br.addElement(" /*IF pmb.isPaging()*/");
br.addElement(" select member.MEMBER_ID");
br.addElement(" , member.MEMBER_NAME");
br.addElement(" , ...");
br.addElement(" -- ELSE select count(*)");
br.addElement(" /*END*/");
br.addElement(" from ...");
br.addElement(" where ...");
br.addElement("");
br.addElement("This specificaton is for both ManualPaging and AutoPaging.");
br.addElement("(AutoPaging is only allowed to omit a paging condition)");
br.addItem("Table");
br.addElement(tableDbName);
br.addItem("OutsideSql");
br.addElement(path);
br.addItem("ParameterBean");
br.addElement(pmb);
br.addItem("Entity Type");
br.addElement(entityType);
final String msg = br.buildExceptionMessage();
throw new PagingCountSelectNotCountException(msg, e);
}
public void throwScalarSelectValueNotFoundException(String title, ConditionBean cb, Class resultType) {
final ExceptionMessageBuilder br = createExceptionMessageBuilder();
br.addNotice("Not found the selected scalar value by the condition.");
br.addItem("Advice");
br.addElement("No hit by the search condition or null-only column data.");
br.addElement("e.g. max(), min(), sun(), avg() can return null.");
br.addElement("");
br.addElement("So check the existence of your optional value.");
br.addElement(" (o):");
br.addElement(" memberBhv.selectScalar(LocalDate.class).max(cb -> {");
br.addElement(" cb.specify().columnBirthdate();");
br.addElement(" cb.query()...");
br.addElement(" }).ifPresent(birthdate -> {");
br.addElement(" // birthdate is not null here");
br.addElement(" }).orElse(() -> {");
br.addElement(" // null birthdate");
br.addElement(" });");
br.addElement("");
br.addElement("And you can also set default value by coalesce() like this:");
br.addElement(" (o):");
br.addElement(" purchaseBhv.selectScalar(Integer.class).avg(cb -> {");
br.addElement(" cb.specify().columnPurchasePrice();");
br.addElement(" cb.query()...");
br.addElement(" }, op -> op.coalesce(0)).alwaysPresent(price -> {");
br.addElement(" // price is not null here");
br.addElement(" });");
br.addItem("Function");
br.addElement(title);
br.addItem("Result Type");
br.addElement(resultType.getName());
setupDisplaySqlElement(br, cb);
final String msg = br.buildExceptionMessage();
throw new ScalarSelectValueNotFoundException(msg);
}
// ===================================================================================
// Update
// ======
public void throwEntityPrimaryKeyNotFoundException(Entity entity) {
final String classTitle = DfTypeUtil.toClassTitle(entity);
final String behaviorName = Srl.substringLastRear(entity.asDBMeta().getBehaviorTypeName(), ".");
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The primary-key value in the entity was not found.");
br.addItem("Advice");
br.addElement("An entity should have its primary-key value");
br.addElement("when e.g. insert(), update().");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" " + classTitle + " entity = new " + classTitle + "();");
br.addElement(" entity.setFooName(...);");
br.addElement(" entity.setFooDate(...);");
br.addElement(" " + behaviorName + ".updateNonstrict(entity);");
br.addElement(" (o):");
br.addElement(" " + classTitle + " entity = new " + classTitle + "();");
br.addElement(" entity.setFooId(...); // Good");
br.addElement(" entity.setFooName(...);");
br.addElement(" entity.setFooDate(...);");
br.addElement(" " + behaviorName + ".updateNonstrict(entity);");
br.addElement("");
br.addElement("Or if your process is insert(), you might expect identity.");
br.addElement("Confirm the primary-key's identity setting.");
if (!entity.asDBMeta().getUniqueInfoList().isEmpty()) {
br.addElement("");
br.addElement("Or if you update it by unique column (not PK),");
br.addElement("use entity.uniqueBy(...).");
br.addElement("For example:");
br.addElement(" (o):");
br.addElement(" " + classTitle + " entity = new " + classTitle + "();");
br.addElement(" entity.uniqueBy(...); // Good");
br.addElement(" entity.setFooDate(...);");
br.addElement(" " + behaviorName + ".updateNonstrict(entity);");
}
setupEntityElement(br, entity);
final String msg = br.buildExceptionMessage();
throw new EntityPrimaryKeyNotFoundException(msg);
}
public void throwEntityUniqueKeyNotFoundException(Entity entity) {
final String classTitle = DfTypeUtil.toClassTitle(entity);
final String behaviorName = Srl.substringLastRear(entity.asDBMeta().getBehaviorTypeName(), ".");
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The unique-key value in the entity was not found.");
br.addItem("Advice");
br.addElement("An entity should have its unique-key value");
br.addElement("when e.g. update(), delete() with uniqueBy() call.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" " + classTitle + " entity = new " + classTitle + "();");
br.addElement(" entity.setFooName(...);");
br.addElement(" entity.setFooDate(...);");
br.addElement(" entity.uniqueBy(null); // *Bad");
br.addElement(" " + behaviorName + ".updateNonstrict(entity);");
br.addElement(" (o):");
br.addElement(" " + classTitle + " entity = new " + classTitle + "();");
br.addElement(" entity.setFooName(...);");
br.addElement(" entity.setFooDate(...);");
br.addElement(" entity.uniqueBy(fooAccount); // Good");
br.addElement(" " + behaviorName + ".updateNonstrict(entity);");
br.addElement(" (o):");
br.addElement(" " + classTitle + " entity = new " + classTitle + "();");
br.addElement(" entity.setFooName(...);");
br.addElement(" entity.setFooDate(...);");
br.addElement(" entity.setFooAccount(fooAccount); // Good");
br.addElement(" " + behaviorName + ".varyingUpdateNonstrict(entity, op -> {");
br.addElement(" op.uniqueBy(" + classTitle + "Dbm.getInstance().uniqueOf());");
br.addElement(" });");
setupEntityElement(br, entity);
final String msg = br.buildExceptionMessage();
throw new EntityUniqueKeyNotFoundException(msg);
}
public void throwUpdateEntityAlreadyDeletedException(ENTITY entity) {
final ExceptionMessageBuilder br = createExceptionMessageBuilder();
br.addNotice("Not found the updated entity. (might be deleted?)");
setupEntityElement(br, entity);
final String msg = br.buildExceptionMessage();
throw new EntityAlreadyDeletedException(msg); // basically treated as application exception
}
public void throwUpdateEntityDuplicatedException(ENTITY entity, int count) {
final ExceptionMessageBuilder br = createExceptionMessageBuilder();
br.addNotice("The updated entity was duplicated. It should be the only one!");
br.addItem("Count");
br.addElement(count);
setupEntityElement(br, entity);
final String msg = br.buildExceptionMessage();
throw new EntityDuplicatedException(msg); // basically no way if you use PK constraint
}
// -----------------------------------------------------
// Optimistic Lock
// ---------------
public void throwVersionNoValueNullException(Entity entity) {
final ExceptionMessageBuilder br = createExceptionMessageBuilder();
br.addNotice("Not found the value of 'version no' on the entity!");
br.addItem("Advice");
br.addElement("Please confirm the existence of the value of 'version no' on the entity.");
br.addElement("You called the method in which the check for optimistic lock is indispensable.");
br.addElement("So 'version no' is required on the entity.");
br.addElement("In addition, please confirm the necessity of optimistic lock.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberId(3);");
br.addElement(" member.setMemberName(\"Pixy\");");
br.addElement(" memberBhv.update(member);");
br.addElement(" (o): (Optimistic Lock)");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberId(3);");
br.addElement(" member.setMemberName(\"Pixy\");");
br.addElement(" member.setVersionNo(...); // *Point");
br.addElement(" memberBhv.update(member);");
br.addElement(" (o): (Nonstrict)");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberId(3);");
br.addElement(" member.setMemberName(\"Pixy\");");
br.addElement(" memberBhv.updateNonstrict(member); // *Point");
setupEntityElement(br, entity);
final String msg = br.buildExceptionMessage();
throw new OptimisticLockColumnValueNullException(msg);
}
public void throwUpdateDateValueNullException(Entity entity) {
final ExceptionMessageBuilder br = createExceptionMessageBuilder();
br.addNotice("Not found the value of 'update date' on the entity!");
br.addItem("Advice");
br.addElement("Please confirm the existence of the value of 'update date' on the entity.");
br.addElement("You called the method in which the check for optimistic lock is indispensable.");
br.addElement("So 'update date' is required on the entity.");
br.addElement("In addition, please confirm the necessity of optimistic lock.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberId(3);");
br.addElement(" member.setMemberName(\"Pixy\");");
br.addElement(" memberBhv.update(member);");
br.addElement(" (o): (Optimistic Lock)");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberId(3);");
br.addElement(" member.setMemberName(\"Pixy\");");
br.addElement(" member.setUpdateDatetime(updateDatetime); // *Point");
br.addElement(" memberBhv.update(member);");
br.addElement(" (o): (Nonstrict)");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberId(3);");
br.addElement(" member.setMemberName(\"Pixy\");");
br.addElement(" memberBhv.updateNonstrict(member); // *Point");
setupEntityElement(br, entity);
final String msg = br.buildExceptionMessage();
throw new OptimisticLockColumnValueNullException(msg);
}
// -----------------------------------------------------
// Batch Update
// ------------
public void throwBatchUpdateUniqueByUnsupportedException(List entityList,
WritableOption option) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The uniqueBy() of batch-update/delete is unsupported.");
br.addItem("Advice");
br.addElement("The uniqueBy() is only for entity-update.");
br.addElement("So use primary key instead of unique column.");
br.addElement("Or use entity-update.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" for (...) {");
br.addElement(" Member member = new Member();");
br.addElement(" member.uniqueBy(memberAccount); // *Bad");
br.addElement(" ...");
br.addElement(" }");
br.addElement(" memberBhv.batchUpdate(memberList);");
br.addElement(" (o):");
br.addElement(" for (...) {");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberId(memberId); // Good: using PK");
br.addElement(" member.setMemberAccount(memberAccount);");
br.addElement(" ...");
br.addElement(" }");
br.addElement(" memberBhv.batchUpdate(memberList);");
br.addElement(" (o):");
br.addElement(" for (...) {");
br.addElement(" Member member = new Member();");
br.addElement(" member.uniqueBy(memberAccount);");
br.addElement(" ...");
br.addElement(" memberBhv.update(member); // Good: entity-update");
br.addElement(" }");
br.addItem("Entity List");
for (ENTITY entity : entityList) {
br.addElement(entity.toStringWithRelation());
}
setupOptionElement(br, option);
final String msg = br.buildExceptionMessage();
throw new BatchUpdateUniqueByUnsupportedException(msg);
}
// -----------------------------------------------------
// Query Update
// ------------
public void throwNonQueryUpdateNotAllowedException(ENTITY entity, ConditionBean cb,
UpdateOption option) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The query-update without a query condition is not allowed.");
br.addItem("Advice");
br.addElement("Confirm your condition values for queryUpdate().");
br.addElement("If you want to update all records, use varyingQueryUpdate().");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberStatusCode_Formalized();");
br.addElement(" memberBhv.queryUpdate(member, cb -> {});");
br.addElement(" (o): (exists query)");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberStatusCode_Formalized();");
br.addElement(" MemberCB cb = new MemberCB();");
br.addElement(" memberBhv.queryUpdate(member, cb -> cb.query().setBirthdate_LessThan(...)); // *OK");
br.addElement(" (o): (non query)");
br.addElement(" Member member = new Member();");
br.addElement(" member.setMemberStatusCode_Formalized();");
br.addElement(" MemberCB cb = new MemberCB();");
br.addElement(" memberBhv.varyingQueryUpdate(member, cb -> {}, op -> op.allowNonQueryUpdate()); // *OK");
setupEntityElement(br, entity);
setupOptionElement(br, option);
setupInvalidQueryElement(br, cb);
final String msg = br.buildExceptionMessage();
throw new NonQueryUpdateNotAllowedException(msg);
}
public void throwNonQueryDeleteNotAllowedException(ConditionBean cb,
DeleteOption option) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The query-delete without a query condition is not allowed.");
br.addItem("Advice");
br.addElement("Confirm your condition values for queryDelete().");
br.addElement("If you want to delete all records, use varyingQueryDelete().");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" memberBhv.queryDelete(cb -> {});");
br.addElement(" (o): (exists query)");
br.addElement(" memberBhv.queryDelete(cb -> cb.query().setBirthdate_LessThan(...)); // Good");
br.addElement(" (o): (non query)");
br.addElement(" memberBhv.varyingQueryDelete(cb -> {}, op -> op.allowNonQueryDelete()); // Good");
setupOptionElement(br, option);
setupInvalidQueryElement(br, cb);
final String msg = br.buildExceptionMessage();
throw new NonQueryDeleteNotAllowedException(msg);
}
// -----------------------------------------------------
// Setup Logic
// -----------
protected void setupEntityElement(ExceptionMessageBuilder br, Entity entity) {
br.addItem("Entity");
try {
br.addElement(entity.toStringWithRelation());
} catch (RuntimeException continued) {
final String tableDbName = entity.asTableDbName();
final String msg = "*Failed to build string from the entity for debug: " + tableDbName;
if (_log.isDebugEnabled()) {
_log.debug(msg);
}
br.addElement(msg);
}
}
protected void setupOptionElement(ExceptionMessageBuilder br, WritableOption option) {
br.addItem("Option");
br.addElement(option);
}
// ===================================================================================
// General Helper
// ==============
/**
* Get the value of line separator.
* @return The value of line separator. (NotNull)
*/
protected String ln() {
return DBFluteSystem.ln();
}
protected String initCap(String str) {
return Srl.initCap(str);
}
protected String initUncap(String str) {
return Srl.initUncap(str);
}
// ===================================================================================
// Exception Helper
// ================
protected ExceptionMessageBuilder createExceptionMessageBuilder() {
return new ExceptionMessageBuilder();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy