Mapping with @IdClass and a @Id @ManyToOne not working

[lakxtxue]

Hi, Rob
My posting in the google group seems to go unnoticed. So post it again here.
https://groups.google.com/g/ebean/c/imcUvp6XEHA

I use a federated primary key, create a federated foreign key, and associate many-to-one.
I failed when testing save. The error message is as follows:
set tenantId on [org.example.domain.AssetsObjectFieldId] arg[creator] type[org.example.domain.AssetsObjectFieldId] threw error

Caused by: java.lang.ClassCastException: class java.lang.String cannot be cast to class java.lang.Long (java.lang.String and java.lang.Long are in module java.base of loader 'bootstrap')

It feels like ebean sets the value of the creator field to the tenantId field.
I tried to create a test case to reproduce the problem, but I found that this problem only occurs in my environment, so the test case I provided now reports another error, which I think may be a similar problem. Even if I add a value to the creator field, it will not be saved successfully, and when I save the object, even if the value of tenantId is set, an exception that tenantId is not set will be thrown (because I have constraints on tenantId).

test case I provided:
sql definition:

DROP TABLE IF EXISTS ASSETS_OBJECT;
CREATE TABLE ASSETS_OBJECT (
    TENANT_ID BIGINT NOT NULL,
    SOURCE_ID BIGINT NOT NULL,
    OBJECT_NAME VARCHAR(32) NOT NULL,
    FULL_OBJECT_NAME VARCHAR(128) NOT NULL,
    CREATOR VARCHAR(32) NULL,
    MODIFIER VARCHAR(32) NULL,
    CREATED_STAMP DATETIME DEFAULT CURRENT_TIMESTAMP,
    LAST_UPDATED_STAMP DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);
CREATE TABLE ASSETS_OBJECT_FIELD (
    TENANT_ID BIGINT NOT NULL ,
    FIELD_NAME VARCHAR(32) NOT NULL ,
    SHORT_NAME VARCHAR(32) NOT NULL ,
    FULL_OBJECT_NAME VARCHAR(128) NOT NULL ,
    FULL_FIELD_NAME VARCHAR(128) NOT NULL ,
    SOURCE_ID BIGINT NOT NULL ,
    CREATOR VARCHAR(32) NULL ,
    MODIFIER VARCHAR(32) NULL ,
    CREATED_STAMP DATETIME DEFAULT CURRENT_TIMESTAMP ,
    LAST_UPDATED_STAMP DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);

java bean definition:

@MappedSuperclass
public abstract class BaseModel extends Model {

    @Column(name = "CREATOR", length = 32)
    @WhoCreated
    protected String creator;

    @Column(name = "MODIFIER", length = 32)
    @WhoModified
    protected String modifier;


    @Column(name = "CREATED_STAMP", length = 26)
    @WhenCreated
    protected Date createdStamp;

    @Column(name = "LAST_UPDATED_STAMP", length = 26)
    @WhenModified
    protected Date lastUpdatedStamp;

    public String getCreator() {
        return creator;
    }

    public void setCreator(String creator) {
        this.creator = creator;
    }

    public Date getCreatedStamp() {
        return createdStamp;
    }

    public void setCreatedStamp(Date createdStamp) {
        this.createdStamp = createdStamp;
    }

    public Date getLastUpdatedStamp() {
        return lastUpdatedStamp;
    }

    public void setLastUpdatedStamp(Date lastUpdatedStamp) {
        this.lastUpdatedStamp = lastUpdatedStamp;
    }

    public String getModifier() {
        return modifier;
    }

    public void setModifier(String modifier) {
        this.modifier = modifier;
    }
}

@Embeddable
public class AssetsObjectId {
  @AttributeOverride(name = "tenantId", column = @Column(name = "TENANT_ID"))
  @Column(name = "TENANT_ID")
  private Long tenantId;

  @AttributeOverride(name = "sourceId", column = @Column(name = "SOURCE_ID"))
  @Column(name = "SOURCE_ID")
  private Long sourceId;

  @AttributeOverride(name = "fullObjectName", column = @Column(name = "FULL_OBJECT_NAME"))
  @Column(name = "FULL_OBJECT_NAME")
  private String fullObjectName;

  Long getTenantId() {
    return this.tenantId;
  }

  void setTenantId(Long tenantId) {
    this.tenantId=tenantId;
  }

  Long getSourceId() {
    return this.sourceId;
  }

  void setSourceId(Long sourceId) {
    this.sourceId=sourceId;
  }

  String getFullObjectName() {
    return this.fullObjectName;
  }

  void setFullObjectName(String fullObjectName) {
    this.fullObjectName=fullObjectName;
  }

  @Override
  public int hashCode() {
    int result = 17 * 31;
    result = 31 * result + Objects.hashCode(tenantId);
    result = 31 * result + Objects.hashCode(sourceId);
    result = 31 * result + Objects.hashCode(fullObjectName);
    return result;
  }

  @Override
  public boolean equals(Object that) {
    if (this == that) {
      return true;
    }
    if (!(that instanceof AssetsObjectId)) {
      return false;
    }
    AssetsObjectId other = (AssetsObjectId) that;
    if (!Objects.equals(tenantId, other.tenantId)) return false;
    if (!Objects.equals(sourceId, other.sourceId)) return false;
    if (!Objects.equals(fullObjectName, other.fullObjectName)) return false;
    return true;
  }
}

@Embeddable
public class AssetsObjectFieldId {
  @AttributeOverride(name = "tenantId", column = @Column(name = "TENANT_ID"))
  @Column(name = "TENANT_ID")
  private Long tenantId;

  @AttributeOverride(name = "sourceId", column = @Column(name = "SOURCE_ID"))
  @Column(name = "SOURCE_ID")
  private Long sourceId;

  @AttributeOverride(name = "fullFieldName", column = @Column(name = "FULL_FIELD_NAME"))
  @Column(name = "FULL_FIELD_NAME")
  private String fullFieldName;

  Long getTenantId() {
    return this.tenantId;
  }

  void setTenantId(Long tenantId) {
    this.tenantId=tenantId;
  }

  Long getSourceId() {
    return this.sourceId;
  }

  void setSourceId(Long sourceId) {
    this.sourceId=sourceId;
  }

  String getFullFieldName() {
    return this.fullFieldName;
  }

  void setFullFieldName(String fullFieldName) {
    this.fullFieldName=fullFieldName;
  }

  @Override
  public int hashCode() {
    int result = 17 * 31;
    result = 31 * result + Objects.hashCode(tenantId);
    result = 31 * result + Objects.hashCode(sourceId);
    result = 31 * result + Objects.hashCode(fullFieldName);
    return result;
  }

  @Override
  public boolean equals(Object that) {
    if (this == that) {
      return true;
    }
    if (!(that instanceof AssetsObjectFieldId)) {
      return false;
    }
    AssetsObjectFieldId other = (AssetsObjectFieldId) that;
    if (!Objects.equals(tenantId, other.tenantId)) return false;
    if (!Objects.equals(sourceId, other.sourceId)) return false;
    if (!Objects.equals(fullFieldName, other.fullFieldName)) return false;
    return true;
  }
}

@Entity(name = "AssetsObject")
@Table(name = "assets_object")
@IdClass(AssetsObjectId.class)
public class AssetsObject extends BaseModel {

    @Id
    @Column(name = "TENANT_ID")
    private Long tenantId;


    @Id
    @Column(name = "SOURCE_ID")
    private Long sourceId;


    @Id
    @Column(name = "FULL_OBJECT_NAME")
    private String fullObjectName;


    @Column(name = "OBJECT_NAME", length = 32, nullable = false)
    private String objectName;


    public Long getTenantId() {
        return tenantId;
    }

    public void setTenantId(Long tenantId) {
        this.tenantId = tenantId;
    }

    public Long getSourceId() {
        return sourceId;
    }

    public void setSourceId(Long sourceId) {
        this.sourceId = sourceId;
    }

    public String getFullObjectName() {
        return fullObjectName;
    }

    public void setFullObjectName(String fullObjectName) {
        this.fullObjectName = fullObjectName;
    }

    String getObjectName() {
        return this.objectName;
    }

    void setObjectName(String objectName) {
        this.objectName = objectName;
    }
}

@Entity(name = "AssetsObjectField")
@Table(name = "assets_object_field")
@IdClass(AssetsObjectFieldId.class)
public class AssetsObjectField extends BaseModel {

    @Id
    @Column(name = "TENANT_ID")
    private Long tenantId;


    @Id
    @Column(name = "SOURCE_ID")
    private Long sourceId;


    @Id
    @Column(name = "FULL_FIELD_NAME")
    private String fullFieldName;

    @Column(name = "FULL_OBJECT_NAME")
    private String fullObjectName;

    @Id
    @ManyToOne
    @JoinColumns({
            @JoinColumn(name = "TENANT_ID", referencedColumnName = "TENANT_ID"),
            @JoinColumn(name = "SOURCE_ID", referencedColumnName = "SOURCE_ID")
    })
    private AssetsObject assetsObject;

    @Column(name = "FIELD_NAME", length = 32, nullable = false)
    private String fieldName;

    @Column(name = "SHORT_NAME", length = 32, nullable = false)
    private String shortName;


    public Long getTenantId() {
        return tenantId;
    }

    public void setTenantId(Long tenantId) {
        this.tenantId = tenantId;
    }

    public Long getSourceId() {
        return sourceId;
    }

    public void setSourceId(Long sourceId) {
        this.sourceId = sourceId;
    }

    public AssetsObject getAssetsObject() {
        return assetsObject;
    }

    public void setAssetsObject(AssetsObject assetsObject) {
        this.assetsObject = assetsObject;
    }

    public String getFullFieldName() {
        return fullFieldName;
    }

    public void setFullFieldName(String fullFieldName) {
        this.fullFieldName = fullFieldName;
    }

    String getFieldName() {
        return this.fieldName;
    }

    void setFieldName(String fieldName) {
        this.fieldName = fieldName;
    }

    String getShortName() {
        return this.shortName;
    }

    void setShortName(String shortName) {
        this.shortName = shortName;
    }

    public String getFullObjectName() {
        return fullObjectName;
    }

    public void setFullObjectName(String fullObjectName) {
        this.fullObjectName = fullObjectName;
    }
}

test case code to reproduce:

@Test
	public void testEbeanSetField(){
//		 Please execute the script in [test.sql] every time you execute the test to reset the data
		DB.script().run("/test.sql");
		AssetsObject assetsObject = new AssetsObject();
		assetsObject.setTenantId(1L);
		assetsObject.setSourceId(1L);
		assetsObject.setFullObjectName("123");
		assetsObject.setObjectName("123");
		assetsObject.setCreator("creator");
		assetsObject.setModifier("modifier");
		assetsObject.setCreatedStamp(new Date());
		assetsObject.setLastUpdatedStamp(new Date());
		assetsObject.save();

		assetsObject = database.find(AssetsObject.class)
				.where()
					.eq("tenantId",1L)
					.eq("sourceId", 1L)
					.eq("fullObjectName","123")
				.findOne();
		//
		assertThat(assetsObject.getCreator()).isNull();

		// The following program exception information will prompt that tenant_id is not allowed to be null

		// The earlier exception information also appeared as follows, but now I can't reproduce it:
		// set tenantId on [org.example.domain.AssetsObjectFieldId] arg[creator] type[org.example.domain.AssetsObjectFieldId] threw error
		// Caused by: java.lang.ClassCastException: class java.lang.String cannot be cast to class java.lang.Long (java.lang.String and java.lang.Long are in module java.base of loader 'bootstrap')

		// Also I tried, it works fine if my entities AssetsObject don't inherit from BaseModel anymore.
		// But all in all it looks like an underlying problem internally, where creator and tenantId are in the wrong place?
		AssetsObjectField assetsObjectField = new AssetsObjectField();
		assetsObjectField.setAssetsObject(assetsObject);
		// NULL not allowed for column "TENANT_ID"; SQL statement
		assetsObjectField.setTenantId(1L);
		assetsObjectField.setFullFieldName("S123");
		assetsObjectField.setFieldName("S123");
		assetsObjectField.setShortName("S123");
		assetsObjectField.setCreator("creator");
		assetsObjectField.setModifier("modifier");
		assetsObjectField.setCreatedStamp(new Date());
		assetsObjectField.setLastUpdatedStamp(new Date());
		assetsObjectField.setFullObjectName(assetsObject.getFullObjectName());
		assetsObjectField.save();
	}

the error output is as follows:

Error: NULL not allowed for column "TENANT_ID"; SQL statement: insert into assets_object_field (TENANT_ID, SOURCE_ID, FULL_FIELD_NAME, FULL_OBJECT_NAME, FIELD_NAME, SHORT_NAME, CREATOR, MODIFIER, CREATED_STAMP, LAST_UPDATED_STAMP) values (?,?,?,?,?,?,?,?,?,?) [23502-214]
io.ebean.DataIntegrityException: Error: NULL not allowed for column "TENANT_ID"; SQL statement: insert into assets_object_field (TENANT_ID, SOURCE_ID, FULL_FIELD_NAME, FULL_OBJECT_NAME, FIELD_NAME, SHORT_NAME, CREATOR, MODIFIER, CREATED_STAMP, LAST_UPDATED_STAMP) values (?,?,?,?,?,?,?,?,?,?) [23502-214]
	at app//io.ebean.config.dbplatform.SqlCodeTranslator.translate(SqlCodeTranslator.java:79)
	at app//io.ebean.config.dbplatform.DatabasePlatform.translate(DatabasePlatform.java:212)
	at app//io.ebeaninternal.server.persist.dml.DmlBeanPersister.execute(DmlBeanPersister.java:77)
	at app//io.ebeaninternal.server.persist.dml.DmlBeanPersister.insert(DmlBeanPersister.java:46)
	at app//io.ebeaninternal.server.core.PersistRequestBean.executeInsert(PersistRequestBean.java:1200)
	at app//io.ebeaninternal.server.core.PersistRequestBean.executeNow(PersistRequestBean.java:726)
	at app//io.ebeaninternal.server.core.PersistRequestBean.executeNoBatch(PersistRequestBean.java:770)
	at app//io.ebeaninternal.server.core.PersistRequestBean.executeOrQueue(PersistRequestBean.java:761)
	at app//io.ebeaninternal.server.persist.DefaultPersister.insert(DefaultPersister.java:468)
	at app//io.ebeaninternal.server.persist.DefaultPersister.insert(DefaultPersister.java:418)
	at app//io.ebeaninternal.server.persist.DefaultPersister.save(DefaultPersister.java:402)
	at app//io.ebeaninternal.server.core.DefaultServer.save(DefaultServer.java:1578)
	at app//io.ebeaninternal.server.core.DefaultServer.save(DefaultServer.java:1570)
	at app//io.ebean.Model.save(Model.java:192)
	at app//org.example.domain.EBeanTests.testEbeanSetField(EBeanTests.java:69)
	at [email protected]/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at [email protected]/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at [email protected]/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at [email protected]/java.lang.reflect.Method.invoke(Method.java:566)
	at app//org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
	at app//org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
	at app//org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
	at app//org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
	at app//org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:26)
	at app//org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
	at app//org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
	at app//org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
	at app//org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
	at app//org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
	at app//org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
	at app//org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
	at app//org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
	at app//org.junit.runners.ParentRunner.run(ParentRunner.java:363)
	at org.gradle.api.internal.tasks.testing.junit.JUnitTestClassExecutor.runTestClass(JUnitTestClassExecutor.java:108)
	at org.gradle.api.internal.tasks.testing.junit.JUnitTestClassExecutor.execute(JUnitTestClassExecutor.java:58)
	at org.gradle.api.internal.tasks.testing.junit.JUnitTestClassExecutor.execute(JUnitTestClassExecutor.java:40)
	at org.gradle.api.internal.tasks.testing.junit.AbstractJUnitTestClassProcessor.processTestClass(AbstractJUnitTestClassProcessor.java:60)
	at org.gradle.api.internal.tasks.testing.SuiteTestClassProcessor.processTestClass(SuiteTestClassProcessor.java:52)
	at [email protected]/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at [email protected]/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at [email protected]/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at [email protected]/java.lang.reflect.Method.invoke(Method.java:566)
	at org.gradle.internal.dispatch.ReflectionDispatch.dispatch(ReflectionDispatch.java:36)
	at org.gradle.internal.dispatch.ReflectionDispatch.dispatch(ReflectionDispatch.java:24)
	at org.gradle.internal.dispatch.ContextClassLoaderDispatch.dispatch(ContextClassLoaderDispatch.java:33)
	at org.gradle.internal.dispatch.ProxyDispatchAdapter$DispatchingInvocationHandler.invoke(ProxyDispatchAdapter.java:94)
	at com.sun.proxy.$Proxy2.processTestClass(Unknown Source)
	at org.gradle.api.internal.tasks.testing.worker.TestWorker$2.run(TestWorker.java:176)
	at org.gradle.api.internal.tasks.testing.worker.TestWorker.executeAndMaintainThreadName(TestWorker.java:129)
	at org.gradle.api.internal.tasks.testing.worker.TestWorker.execute(TestWorker.java:100)
	at org.gradle.api.internal.tasks.testing.worker.TestWorker.execute(TestWorker.java:60)
	at org.gradle.process.internal.worker.child.ActionExecutionWorker.execute(ActionExecutionWorker.java:56)
	at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:113)
	at org.gradle.process.internal.worker.child.SystemApplicationClassLoaderWorker.call(SystemApplicationClassLoaderWorker.java:65)
	at app//worker.org.gradle.process.internal.worker.GradleWorkerMain.run(GradleWorkerMain.java:69)
	at app//worker.org.gradle.process.internal.worker.GradleWorkerMain.main(GradleWorkerMain.java:74)
Caused by: org.h2.jdbc.JdbcSQLIntegrityConstraintViolationException: NULL not allowed for column "TENANT_ID"; SQL statement:
insert into assets_object_field (TENANT_ID, SOURCE_ID, FULL_FIELD_NAME, FULL_OBJECT_NAME, FIELD_NAME, SHORT_NAME, CREATOR, MODIFIER, CREATED_STAMP, LAST_UPDATED_STAMP) values (?,?,?,?,?,?,?,?,?,?) [23502-214]
	at app//org.h2.message.DbException.getJdbcSQLException(DbException.java:508)
	at app//org.h2.message.DbException.getJdbcSQLException(DbException.java:477)
	at app//org.h2.message.DbException.get(DbException.java:223)
	at app//org.h2.message.DbException.get(DbException.java:199)
	at app//org.h2.table.Column.validateConvertUpdateSequence(Column.java:365)
	at app//org.h2.table.Table.convertInsertRow(Table.java:926)
	at app//org.h2.command.dml.Insert.insertRows(Insert.java:167)
	at app//org.h2.command.dml.Insert.update(Insert.java:135)
	at app//org.h2.command.dml.DataChangeStatement.update(DataChangeStatement.java:74)
	at app//org.h2.command.CommandContainer.update(CommandContainer.java:169)
	at app//org.h2.command.Command.executeUpdate(Command.java:252)
	at app//org.h2.jdbc.JdbcPreparedStatement.executeUpdateInternal(JdbcPreparedStatement.java:209)
	at app//org.h2.jdbc.JdbcPreparedStatement.executeUpdate(JdbcPreparedStatement.java:169)
	at app//io.ebean.datasource.pool.ExtendedPreparedStatement.executeUpdate(ExtendedPreparedStatement.java:123)
	at app//io.ebeaninternal.server.bind.DataBind.executeUpdate(DataBind.java:93)
	at app//io.ebeaninternal.server.persist.dml.InsertHandler.execute(InsertHandler.java:106)
	at app//io.ebeaninternal.server.persist.dml.DmlHandler.executeNoBatch(DmlHandler.java:88)
	at app//io.ebeaninternal.server.persist.dml.DmlBeanPersister.execute(DmlBeanPersister.java:69)
	... 53 more

a repository that can run the issue:
https://github.com/lakxtxue/ebean-tests

[rbygrave]

The summary:

The mapping for assetsObject on AssetsObjectField needs to change to:

    //@Id
    @ManyToOne
    @JoinColumns({
            @JoinColumn(name = "TENANT_ID", referencedColumnName = "TENANT_ID", insertable = false, updatable = false),
            @JoinColumn(name = "SOURCE_ID", referencedColumnName = "SOURCE_ID", insertable = false, updatable = false)
    })
    private AssetsObject assetsObject;

1. Remove the @Id
2. Add the insertable = false, updatable = false to the two @JoinColumn

That is, the expectation when using @IdClass is that the properties that have @Id are scalar properties that are also in the associated IdClass type. The @ManyToOne AssetsObject assetsObject property can't be annotated with @Id ... this then leads to the @JoinColumns having the insertable = false, updatable = false added.

Does that make sense?

[rbygrave]

Note: I've changed the title of the discussion to match the issue / question

[lakxtxue]

Thanks a lot for pointing out the incorrect usage for me.

[rob-bygrave]

All good. It wasn't until I ran the code and was debugging it that I actually saw the mapping issue. It wasn't obvious what the issue was when running and seeing the null being inserted.