Top Description Methods
javax.ejb.spi

public Interface HandleDelegate

Imports
java.io.IOException, .ObjectOutputStream, .ObjectInputStream, javax.ejb.EJBObject, .EJBHome

The HandleDelegate interface is implemented by the EJB container. It is used by portable implementations of javax.ejb.Handle and javax.ejb.HomeHandle. It is not used by EJB components or by client components. It provides methods to serialize and deserialize EJBObject and EJBHome references to streams.

The HandleDelegate object is obtained by JNDI lookup at the reserved name "java:comp/HandleDelegate".

Since
EJB 2.0

Method Summary

Modifier and TypeMethod and Description
public EJBHome

Returns:

The deserialized EJBHome reference.
readEJBHome
(ObjectInputStream
The input stream.
istream
)

Deserialize the EJBHome reference corresponding to a HomeHandle.

public EJBObject

Returns:

The deserialized EJBObject reference.
readEJBObject
(ObjectInputStream
The input stream.
istream
)

Deserialize the EJBObject reference corresponding to a Handle.

public void
writeEJBHome(EJBHome
The EJBHome reference to be serialized.
ejbHome
,
ObjectOutputStream
The output stream.
ostream
)

Serialize the EJBHome reference corresponding to a HomeHandle.

public void
writeEJBObject(EJBObject
The EJBObject reference to be serialized.
ejbObject
,
ObjectOutputStream
The output stream.
ostream
)

Serialize the EJBObject reference corresponding to a Handle.

Method Detail

readEJBHomeback to summary
public EJBHome readEJBHome(ObjectInputStream istream) throws IOException, ClassNotFoundException

Deserialize the EJBHome reference corresponding to a HomeHandle.

The readEJBHome method is called from the readObject method of portable HomeHandle implementation classes. The istream object is the same object that was passed in to the HomeHandle class's readObject method. When readEJBHome is called, istream must point to the location in the stream at which the EJBHome reference can be read. The container must ensure that the EJBHome reference is capable of performing invocations immediately after deserialization.

Parameters
istream:ObjectInputStream

The input stream.

Returns:EJBHome

The deserialized EJBHome reference.

Exceptions
IOException:
The EJBHome could not be deserialized because of a system-level failure.
ClassNotFoundException:
The EJBHome could not be deserialized because some class could not be found.
readEJBObjectback to summary
public EJBObject readEJBObject(ObjectInputStream istream) throws IOException, ClassNotFoundException

Deserialize the EJBObject reference corresponding to a Handle.

The readEJBObject method is called from the readObject method of portable Handle implementation classes. The istream object is the same object that was passed in to the Handle class's readObject method. WhenreadEJBObject is called, istream must point to the location in the stream at which the EJBObject reference can be read. The container must ensure that the EJBObject reference is capable of performing invocations immediately after deserialization.

Parameters
istream:ObjectInputStream

The input stream.

Returns:EJBObject

The deserialized EJBObject reference.

Exceptions
IOException:
The EJBObject could not be deserialized because of a system-level failure.
ClassNotFoundException:
The EJBObject could not be deserialized because some class could not be found.
writeEJBHomeback to summary
public void writeEJBHome(EJBHome ejbHome, ObjectOutputStream ostream) throws IOException

Serialize the EJBHome reference corresponding to a HomeHandle.

This method is called from the writeObject method of portable HomeHandle implementation classes. The ostream object is the same object that was passed in to the Handle class's writeObject method.

Parameters
ejbHome:EJBHome

The EJBHome reference to be serialized.

ostream:ObjectOutputStream

The output stream.

Exceptions
IOException:
The EJBObject could not be serialized because of a system-level failure.
writeEJBObjectback to summary
public void writeEJBObject(EJBObject ejbObject, ObjectOutputStream ostream) throws IOException

Serialize the EJBObject reference corresponding to a Handle.

This method is called from the writeObject method of portable Handle implementation classes. The ostream object is the same object that was passed in to the Handle class's writeObject method.

Parameters
ejbObject:EJBObject

The EJBObject reference to be serialized.

ostream:ObjectOutputStream

The output stream.

Exceptions
IOException:
The EJBObject could not be serialized because of a system-level failure.