Enterprise JavaBeans 1.0

5. 클라이언트의 관점에서 본 entity Beans

business methods 는 enterprise Bean 자신이 제공해야 한다.

5.1 Overview

        엔티티빈은 지속성 저장매체(데이타베이스, 파일시스템...)에 저장되는 지속성 객체이다.
        클라이언트는 엔티티빈의 홈인터페이스를 통해 접근한다.
        리모트 인터페이스를 구현하는 객체를 EJB object 라고 한다.
        EJB object 는 컨터에너 내에서 생활하며 클라이언트에 투명하다.
        컨테이너는 EJB object 를 위해 security, concurrency, transactions, persistence...
        등의 서비스를 제공한다.
        컨테이너 또한 클라이언트에 투명하며 클라이언트가 컨테이너를 다룰수 있는
        API 존재하지 않는다.

Multiple clients 는 한 엔티티 객체에 동시에 접근할 수 있다.

        일반적으로 각각의 엔티티 객체는 식별자를 가지며 컨테이너가 재시작하거나
        작동을 멈추어도 계속 생존한다.
        객체 식별자는 컨테이너에 의해 구현된다.

        enterprise Bean's home interface 클라이언트가 EJB Object 를 create, look up,
        remove 하는것을 허락한다.
        클라이언트는 JNDI 를 통해 enterprise Bean's home interface 를 찾을수 있다.
        컨테이너는 JNDI 이름공간에서 enterprise Bean's home interface 가
        사용가능하도록 할 책임이 있다.

5.2 EJB container

컨테이너는 enterprise Bean object 가 생존하는 공간이다.

5.2.1 Locating enterprise Bean's home interface

// Account enterprise Bean 을 위한 홈인터페이스를 찾는방법

            Context initialContext = new InitialContext();
            AccountHome accountHome = javax.rmi.PortableRemoteObject.narrow(
           initialContext.lookup("applications/bank/accounts", AccountHome.class);

5.2.2 What a container provides

5.3 Enterprise Bean's home interface

        컨테이너는 각각의 enterprise Bean 의 홈인터페이스 구현을 제공한다.
        그리고 모든 클라이언트가 JNDI 를 통해 홈인터페이스제 접근할수 있도록 한다.
        홈인터페이스의 구현클래스를 EJB home 이라고 한다.

엔티티빈의 홈인터페이스는 아래사항을 클라이언트에게 허락한다.

- Create new EJB objects.

- Look up existing EJB objects.

- Remove an EJB object.

- Get the javax.ejb.EJBMetaData interface for the enterprise Bean.

홈 인터페이스는 javax.ejb.EJBHome interface 를 상속해야 한다.

5.3.1 create() method

Entity Beans 의 Home interface 는 0개 이상의 create() 메소드를 정의할 수 있다.
(한 EJB 객체를 생성하기위한 각각의 방법을 사용할수 있다는 것이다.)

일반적으로 create() 메소드의 전달인자는 생성된 객체를 상태를 초기화 하기 위해
사용된다.

create() 메소드의 리턴값은 enterprise Bean's remote interface 이다.

또한 create() 메소드는 java.rmi.RemoteException, javax.ejb.CreateException 을
throws 해야하며 추가적으로 애플리케이션 레벨의 예외를 발생시킬수 있다.

2개의 create() 메소드를 구현하는 홈 인터페이스 예제..

public interface AccountHome extends javax.ejb.EJBHome {

public Account create(String firstName, String lastName, double initialBalance)
throws RemoteException, CreateException;

public Account create(String accountNumber, double initialBalance)
throws RemoteException, CreateException, LowInitialBalanceException;

...
}

클라이언트가 새로운 EJB 객체를 생성하는 방법.

AccountHome accountHome = ...;
Account account = accountHome.create("john", "smith", 500.00);

5.3.2 find~() methods

            Entity Beans 의 Home interface 는 하나이상의 find~() 메소드를 정의할 수 있다.
            (한 EJB 객체를 찾기위해 또는 특별한 타입의 EJB 객체를 수집하기 위해
            각각의 방법을 사용할수 있다는 것이다.)
           (모든 엔티티빈에 있어서 findByPrimaryKey(primaryKey) 메소드는 반드시 정의해야함)

메소드 명칭은 findLargeAccounts(...)와 같이 find 로 시작해야 한다.

리턴타입은 enterprise Bean's remote interface 이거나 EJB 객체의 모임을 묘사하는 타입이다.

모든 find 메소드는 java.rmi.RemoteException 을 발생해야만 하고, 일반적으로
javax.ejb.FinderException 을 발생할수 있다.

Entity Bean 의 홈 인터페이스는 Primary Key 를 가지는 Entity Bean 의 리모트 인터페이스를
얻기위해 findByPrimaryKey(primaryKey) 메소드를 포함한다.

            public interface AccountHome extends javax.ejb.EJBHome {
               ...
               public Account findByPrimaryKey(String AccountNumber) throws RemoteException,
                                                                                                                FinderException;
            }

AccountHome = ...;
Account account = accountHome.findByPrimaryKey("100-3450-3333");

5.3.3 remove() methods

javax.ejb.EJBHome 인터페이스는 클라이언트가 EJB 객체를 제거할수 있게 하기위해
remove() 메소드를 정의한다.

public interface EJBHome extends Remote {

void remove(Handle handle) throws RemoteException, RemoveException;

void remove(Object primaryKey) throws RemoteException, RemoveException;
}

5.4 Entity EJB object life cycle

        EJB object 는 생성(create())되기 전까지 존재하지 않으며 식별자도 가지지 않는다.
        클라이언트는 컨테이너에 의해 실행되는 enterprise Bean's home interface 를 이용해
        EJB 객체를 생성한다.

        entity EJB 는 create() 메소드를 이용하는것 외에 다른 메커니즘
        (데이타베이스 레코드에 직접 삽입하는 방법 등)을 사용하여 객체를 생성할 수 있다.
        이경우에 클라이언트는 find~() method 만을 이용할 수 있다.

또한 remove() 를 사용하지 않고 데이타베이스의 레코드를 직접 삭제함으로써
제거될수도 있다.

클라이언트가 이미 존재하는 EJB 객체의 참조를 획득하는 3가지 방법

- Receive a reference as a parameter in a method call (input parameter or result).

- Look up the EJB object using a finder method of the enterprise Bean's home interface.

- Obtain the reference from a Bean's handle

객체참조를 얻은후 클라이언트가 할수 있는 일.

- Invoke business methods on the object through the EJB object's remote interface.

- Obtain a reference to the enterprise Bean's home interface.

- Pass the reference as a parameter or return value.

- Obtain the EJB object's primary key.

- Obtain the EJB object's handle.

- Remove the EJB object.

존재하지 않는 객체에 대한 참조를 가지고 호출할 경우 java.rmi.NoSuchObjectException 을 발생한다.

모든 엔티티빈은 지속성 객체이다.따라서 생명주기는 자바가상머신, 컨테이너들의 상태에
영향받지않는다.

Multiple clients 는 같은 EJB 객체에 동시에 접근할 수 있으며 트랜잭션은 각각으로부터
클라이언트의 요청을 분리하기 위해 사용된다.

5.5 Primary key and object identity

        모든 엔티티객체를 그것의 홈 내에서 유일한 식별자를 가진다.
        컨테이너내의 객체 식별자는 EJB object's home 그리고 primary key에 의해 결정된다.
        만약 두 객체가 같은 home 과 primary key 를 가진다면 두 객체는 동일하다.
        그리고 primary key object 직렬화 가능해야하며 primary key class는
        enterprise Bean class 에 특화된다.
        즉, 각각의 enterprise Bean class 는 primary key 를 위해 다른 클래스를 가질수 있다.

클라이언트는 getPrimaryKey() 메소드를 호출하여 EJB 객체의 primary key 를
얻을수 있다.

클라이언트측에서 두 EJB 객체참조가 같은 Entity 를 참조하는지 알수 있는 방법

- isIdentical(otherObject) 메소드 (전달인자로 다른 참조를 전달한다.)(추천)

Account acc1 = ...;
Account acc2 = ...;

                if (acc1.isIdentical(acc2)) {
                    //acc1 and acc2 are the same EJB objects
                } else {
                    //acc2 and acc2 are different EJB object
                }

            - entity objects's primary keys 를 획득한 다음 java.lang.Object.equals() 메소드를
               이용해 key 를 비교한다.
               (단, 두 EJB reference 가 같은 Home에 있는 EJB 객체를 참조할때만 가능하다)
               (하지만, 같은 객체를 묘사하는 두 객체 참조 상에서 java.lang.Object.hashCode()
                메소드는 정확한 결과를 보증할수 없다.)

entity EJB object 의 primary keys 를 알고있는 클라이언트는 컨테이너에 의해 실행되는
홈 인터페이스의 findByPrimaryKey(key) 를 호출해서 객체의 참조를 획득할 수 있다.

5.6. Enterprise Bean's remote interface

클라이언트는 리모트 인터페이스를 통해 Entity Bean 에 접근할수 있고 리모트 인터페이스는
business methods 를 정의한다.

리모트 인터페이스의 정의 예.

public interface Account extends javax.ejb.EJBObject {

void debit(double amount) throws java.rmi.RemoteException,
InsufficientBalanceException;

void credit(double amount) throws java.rmi.RemoteException;

double getBalance() throws java.rmi.RemoteException;
}

javax.ejb.EJBObject interface 는 클라이언트가 EJB 객체 참조상에서 다음과 같은 일을 할수
있도록 정의한다.

- Obtain the home interface for the EJB class. (getEJBHome())

- Remove the EJB object. (remove())

- Obtain the EJB object's handle. (getHandle())

- Obtain the EJB object's primary key. (getPrimaryKey())

javax.ejb.EJBObject interface 에 정의된 메소드의 실행은 컨테이너에 의해 제공되고
비즈니스 메소드의 실행은 enterprise Bean class 에 위임된다.

5.7 Enterprise Bean's handle

handle 은 EJB 객체를 식별하기 위한 객체이며, EJB 객체의 참조를 가지는 클라이언트가
참조상에서 getHandle() 메소드를 호출함으로써 객체의 핸들을 얻을수 있다.

            handle 은 일반적으로 컨테이너에 의해 제공되지만 클래스를 직접 구현할 경우는 반드시
            직렬화 가능하기위해 java.io.Serializable interface 를 구현해야만 한다.
           그리고 클라이언트는 이후에 직렬화된 핸들을 사용할수가 있다.

// A client obtains a handle of an account EJB object and
// stores the handle in stable storage.

             ObjectOutputStream stream = ...;
             Account account = ...;
             Handle handle = account.getHandle();
             stream.writeObject(handle);

             // A client can read the handle from stable storage, and use the
             // handle to ressurect an object reference to the
             // account EJB object.

             ObjectInputStream stream = ...;
             Handle handle = (Handle) stream.readObject(handle);
             Account account = (Account) handle.getEJBObject();
             account.debit(100.00);