Beispiel: Einfache Container Managed Entity Bean (JBoss 4.0)

Aufbau des Beispieles

Anlegen der Application

Anlegen der Entity Bean

	 * @ejb.bean name="KuchenSingle"	
	 *           description="A session bean named KuchenSingle"
	 *           display-name="KuchenSingle"
	 *           jndi-name="KuchenSingle"
	 *           type="Stateless" 
	 *           transaction-type="Container" 

	 * @ejb.bean name="KuchenSingle"	
	 *           description="Ein einzelner Kuchen"
	 *           display-name="KuchenSingle"
	 *           jndi-name="KuchenSingle"
	 *           type="CMP" 
	 *           transaction-type="Container"
	 *           cmp-version="2.x" 
	 *           view-type="remote" 
	 * @ejb.pk 
	 *           class="java.lang.Object" 
	 *           generate="false" 
	 * @jboss.unknown-pk 
	 *           class="java.lang.Integer" 
	 *           column-name="kuchenid" 
	 *           field-name="kuchenid" 
	 *           sql-type="INTEGER" 
	 *           jdbc-type="INTEGER" 
	 *           auto-increment="true" 
	 * @jboss.entity-command 
	 *           name="hsqldb-fetch-key" 
	 * @ejb.finder 
	 *           signature="java.util.Collection findAll()" 
	 *           query="select Object(o) from KuchenSingle o order by o.name"  

• @ejb.bean: die Bean hat den Typ "Container managed Entity Bean" (="CMP"), die unterstützte Version für Container Managed Entity Beans ist "2.x". Wir wollen hier nur Remote aufdie Bean zugreifen.
• @ejb.pk: Wir verwenden einen vom Container erzeugten Primary Key. Regeln hierfür aus dem J2EE-Standard:
  • Es darf in der Bean-Klasse keine get/set-Methoden für das Feld geben.
  • Rückgabe von "findByPrimaryKey" muss vom Typ "java.lang.Object" sein.
  • Rückgabe von "ejbCreate" muss vom Typ "java.lang.Object" sein und den Wert NULL haben.
  Wichtig ist hier das Attribut "generated=false" die XDoclet daran hindert eine Klasse "java.lang.Object" in unserem Projekt anzulegen !
• @jboss.unknown-pk: JBoss-spezifische Angaben: Festlegen des Datentyps des für die Bean unbekannten Primary Keys (Java-Klasse ist "java.lang.Integer", Spaltename in Datenbank ist "kuchenid", SQL-Typ und JDBC-Typ sind "INTEGER", in der von JBoss erzeugten Bean-Implementation wird ein Feld namens "kuchenid" verwendet. Die Werte des Keys werden automatisch hochgezählt.
• @jboss.entity-command: JBoss-spezifische Angaben für die Hypersonic-Datenbank: für das Erzeugen des PK-Werts soll die Hypersonic-spezifische Funktion "CALL IDENTITY()" verwendet werden. Weitere Infos zu den JBoss-spezifischen Verfahren für das Erzeugen des Primary Keys: http://docs.jboss.org/jbossas/jboss4guide/, Kapitel 11.11.1
• @ejb.finder: Es soll eine find-Methode "findAll" erzeugt werden, die eine Collection zurückliefert (voller Name der Parameter- und Rückgabewert-Klassen muss angegeben werden). Die dazugehörige EJB-QL - Query liest alle Kuchen sortiert nach Namen ein.

	/**@ejb.create-method view-type="remote"
	 * @generated
	 */
	public Object ejbCreate () throws CreateException
	{
		KuchenSingleBean.logger.info("ejbCreate");
		return null;
	}

	
	/**Nach dem Erzeugen eines Kuchen-Objekts, Name ist noch nicht gegeben.
	 * @exception CreateException Fehler beim Erzeugen.
	 */
	public void ejbPostCreate () throws CreateException
	{
		KuchenSingleBean.logger.info("ejbPostCreate");
	} 

	/**Der Name des Kuchens.
	 * @return
	 * @ejb.persistence column-name="name" sql-type="VARCHAR" 
	 * @ejb.interface-method view-type="remote" 
	 */
	public abstract String getName();

	/**Der Name des Kuchens.
	 * @param str_Name Der neue Name
	 * @ejb.persistence column-name="name" sql-type="VARCHAR" 
	 * @ejb.interface-method view-type="remote" 
	 */
	public abstract void setName (String str_Name); 

	<entity>
	...
		<ejb-class>com.knauf.ejb.kuchen.KuchenSingleCMP</ejb-class>
	       	<persistence-type>Container</persistence-type>
	      	<prim-key-class>java.lang.Object</prim-key-class>
	       	<reentrant>false</reentrant>
	       	<cmp-version>2.x</cmp-version>
	       	<abstract-schema-name>KuchenSingle</abstract-schema-name>
	       	<cmp-field >
			<description><![CDATA[Der Name des Kuchens.]]></description>
			<field-name>name</field-name>
		</cmp-field>
		<query>
        		<query-method>
				<method-name>findAll</method-name>
				<method-params> </method-params>
			</query-method>
			<ejb-ql><![CDATA[select Object(o) from KuchenSingle o order by o.name]]></ejb-ql>
		</query>
	</entity> 

	<entity>
		<ejb-name>KuchenSingle</ejb-name>
		<cmp-field>
			<field-name>name</field-name>
			<column-name>name</column-name>
		</cmp-field>
		<unknown-pk>
			<unknown-pk-class>java.lang.Integer</unknown-pk-class>
			<field-name>kuchenid</field-name>
			<column-name>kuchenid</column-name>
			<jdbc-type>INTEGER</jdbc-type>
			<sql-type>INTEGER</sql-type>
			<auto-increment/>
		</unknown-pk>
		<entity-command name="hsqldb-fetch-key"></entity-command>
	</entity> 

org.jboss.ejb.plugins.cmp.jdbc.keygen.JDBCHsqldbCreateCommand.KuchenSingle] Insert Entity SQL: INSERT INTO KUCHENSINGLE (name) VALUES (?)
org.jboss.ejb.plugins.cmp.jdbc.JDBCCommandFactory.KuchenSingle] entity-command: [commandName=hsqldb-fetch-key,commandClass=class org.jboss.ejb.plugins.cmp.jdbc.keygen.JDBCHsqldbCreateCommand,attributes={}]
org.jboss.ejb.plugins.cmp.jdbc.JDBCRemoveEntityCommand.KuchenSingle] Remove SQL: DELETE FROM KUCHENSINGLE WHERE kuchenid=?
org.jboss.ejb.plugins.cmp.jdbc.JDBCStartCommand.KuchenSingle] Executing SQL: CREATE TABLE KUCHENSINGLE (kuchenid INTEGER NOT NULL IDENTITY, name VARCHAR(256), CONSTRAINT PK_KUCHENSINGLE PRIMARY KEY (kuchenid))
org.jboss.ejb.plugins.cmp.jdbc.JDBCFindByPrimaryKeyQuery.KuchenSingle#findByPrimaryKey] SQL: SELECT t0_KuchenSingle.kuchenid FROM KUCHENSINGLE t0_KuchenSingle WHERE t0_KuchenSingle.kuchenid=?
org.jboss.ejb.plugins.cmp.jdbc.JDBCQueryManager.KuchenSingle] Added findByPrimaryKey query command for home interface 

Datenbank-Adminstrations-Tool

Application Client

	<ejb-ref>
		<ejb-ref-name>ejb/KuchenSingle</ejb-ref-name>
		<ejb-ref-type>Session</ejb-ref-type>
		<home>com.knauf.ejb.kuchen.KuchenSingleHome</home>
		<remote>com.knauf.ejb.kuchen.KuchenSingle</remote>
		<ejb-link>KuchenSingle</ejb-link>
	</ejb-ref> 

      Properties props = new Properties();
      props.setProperty(Context.INITIAL_CONTEXT_FACTORY, "org.jnp.interfaces.NamingContextFactory");
      props.setProperty(Context.URL_PKG_PREFIXES, "org.jboss.naming.client");
      props.setProperty(Context.PROVIDER_URL, "jnp://localhost:1099");
      props.setProperty("j2ee.clientName", "KuchenSingleClient"); 

      InitialContext initialContext = new InitialContext(props);
      Object homeref = initialContext.lookup(KuchenSingleHome.COMP_NAME);
      this.kuchenHome = (KuchenSingleHome) PortableRemoteObject.narrow(homeref, KuchenSingleHome.class); 

	Manifest-Version: 1.0
	Class-Path: KuchenSingleEJB.jar
	Main-Class: com.knauf.ejb.kuchen.KuchenApplicationClient

Ausführen des Clients