org.apache.jdo.impl.fostore
Class ActivateClassRequest

java.lang.Object
  extended byorg.apache.jdo.impl.fostore.AbstractRequest
      extended byorg.apache.jdo.impl.fostore.ActivateClassRequest
All Implemented Interfaces:
Request

class ActivateClassRequest
extends AbstractRequest

Represents a request to cause the description of a class in the client to have a representation in the store.

Author:
Dave Bristor

Field Summary
private  CLID clid
           
protected  FOStoreSchemaUID fsuid
          uid corresponding to the same java.lang.Class that initializes jdoClass.
private static RuntimeJavaModelFactory javaModelFactory
          RuntimeJavaModelFactory.
protected  JDOClass jdoClass
          Class meta data of the object represented by the constructor's given state manager
protected static int LENGTH_COOKIE
           
(package private) static org.apache.commons.logging.Log logger
          Logger
protected static I18NHelper msg
           
protected  FOStoreOutput out
          Stream to which request writes itself.
protected  FOStorePMF pmf
          PersistenceManagerFactory via which request is being done.
protected  StateManagerInternal sm
          The state manager which is the subject of this request.
 
Constructor Summary
(package private) ActivateClassRequest(java.lang.Class cls, Message m, FOStorePMF pmf)
           
 
Method Summary
 void doRequest()
          Does whatever it is that the kind of request does in actually making a request of the store.
 void doRequestBody()
          Subclasses must implement in this method the actual writing of their Request type-specific data.
protected  RequestId getId()
           
 StateManagerInternal getStateManager()
          Get the StateManager associated with this request, null if none.
 void handleReply(Status status, java.io.DataInput in, int length)
          Processes the results of the effect of the request in the store.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

clid

private final CLID clid

javaModelFactory

private static final RuntimeJavaModelFactory javaModelFactory
RuntimeJavaModelFactory.


sm

protected StateManagerInternal sm
The state manager which is the subject of this request.


pmf

protected final FOStorePMF pmf
PersistenceManagerFactory via which request is being done.


out

protected final FOStoreOutput out
Stream to which request writes itself.


jdoClass

protected JDOClass jdoClass
Class meta data of the object represented by the constructor's given state manager


fsuid

protected FOStoreSchemaUID fsuid
uid corresponding to the same java.lang.Class that initializes jdoClass.


msg

protected static final I18NHelper msg

logger

static final org.apache.commons.logging.Log logger
Logger


LENGTH_COOKIE

protected static final int LENGTH_COOKIE
See Also:
Constant Field Values
Constructor Detail

ActivateClassRequest

ActivateClassRequest(java.lang.Class cls,
                     Message m,
                     FOStorePMF pmf)
Method Detail

doRequestBody

public void doRequestBody()
                   throws java.io.IOException
Description copied from class: AbstractRequest
Subclasses must implement in this method the actual writing of their Request type-specific data.

Specified by:
doRequestBody in class AbstractRequest
Throws:
java.io.IOException
See Also:
The format of this request is (aside from the request header):
 class's name: String
 clid: CLID (will always be provisional)
 FOStoreSchemaUID for class
 numPCSuperclasses: int
 foreach PCSuperclass in inheritance order going towards Object:
     the superclass' class name
     the superclass's CLID
     the superclass's FOStoreSchemaUID
 numFields: int
 scoField: boolean
 foreach field in the class:
     the field's name
     the field's CLID
     the field's class's FOStoreSchemaUID
 
Note that we do not currently support all sco information, and will have to ammend this when we do. In that case, we will write also write, for each field:
     scoField: boolean
     elementType: String
     allowNulls: boolean
     initialSize: int
 
Note that we write out information in order of name, CLID, FSUID in all cases above.

handleReply

public void handleReply(Status status,
                        java.io.DataInput in,
                        int length)
                 throws java.io.IOException
Description copied from interface: Request
Processes the results of the effect of the request in the store. To be invoked after the store has processed the request, and has returned information about that request, such as its status and any accompanying data.

Parameters:
in - the input stream.
length - the length of data in the stream.
status - Indication as to the success, failure, etc. of the request as handled by the store.
Throws:
java.io.IOException - if any problems reading the stream.
See Also:
Request.handleReply(org.apache.jdo.impl.fostore.Status, java.io.DataInput, int)

getId

protected RequestId getId()

doRequest

public final void doRequest()
                     throws java.io.IOException
Description copied from interface: Request
Does whatever it is that the kind of request does in actually making a request of the store.

Specified by:
doRequest in interface Request
Throws:
java.io.IOException - in case of errors with the stream.
See Also:
Request.doRequest()

getStateManager

public StateManagerInternal getStateManager()
Get the StateManager associated with this request, null if none.

Specified by:
getStateManager in interface Request
Returns:
the StateManager.