VerifyRequest

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jdo.impl.fostore
Class VerifyRequest

java.lang.Object
  org.apache.jdo.impl.fostore.AbstractRequest
      org.apache.jdo.impl.fostore.AbstractFieldRequest
          org.apache.jdo.impl.fostore.InsertRequest
              org.apache.jdo.impl.fostore.VerifyRequest

All Implemented Interfaces:: FieldManager, Request

class VerifyRequest
extends InsertRequest

Represents a request to verify that in-memory data is the same as that in the database.

Author:: Dave Bristor

Field Summary
`private java.util.BitSet`	`fieldsToVerify` Fields to verify in database.
`protected FOStoreSchemaUID`	`fsuid` uid corresponding to the same java.lang.Class that initializes jdoClass.
`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.
`private boolean`	`verified` Result of executing request.
`private boolean`	`verifyFields` If true, verify values of object, otherwise verify only existence (and ignore remaining parameters).

Constructor Summary
`(package private)`	`VerifyRequest(StateManagerInternal sm, Message m, FOStorePMF pmf, boolean verifyFields, java.util.BitSet fieldsToVerify)`

Method Summary
`void`	`doRequest()` Does whatever it is that the kind of request does in actually making a request of the store.
`protected void`	`doRequestBody()` Provides the information necessary for a VerifyRequest.
`boolean`	`fetchBooleanField(int fieldNum)`
`byte`	`fetchByteField(int fieldNum)`
`char`	`fetchCharField(int fieldNum)`
`double`	`fetchDoubleField(int fieldNum)`
`float`	`fetchFloatField(int fieldNum)`
`int`	`fetchIntField(int fieldNum)`
`long`	`fetchLongField(int fieldNum)`
`java.lang.Object`	`fetchObjectField(int fieldNum)`
`short`	`fetchShortField(int fieldNum)`
`java.lang.String`	`fetchStringField(int fieldNum)`
`protected RequestId`	`getId()`
`protected OID`	`getOID()`
`StateManagerInternal`	`getStateManager()` Get the StateManager associated with this request, null if none.
`(package private) boolean`	`getVerified()`
`void`	`handleReply(Status status, java.io.DataInput in, int length)` Handles reply data from a VerifyReply.
`void`	`storeBooleanField(int fieldNum, boolean value)` Provides the means by which the value of a boolean field can be given by a StateManager to an object that needs the value.
`void`	`storeByteField(int fieldNum, byte value)` Provides the means by which the value of a byte field can be given by a StateManager to an object that needs the value.
`void`	`storeCharField(int fieldNum, char value)` Provides the means by which the value of a char field can be given by a StateManager to an object that needs the value.
`void`	`storeDoubleField(int fieldNum, double value)` Provides the means by which the value of a double field can be given by a StateManager to an object that needs the value.
`void`	`storeFloatField(int fieldNum, float value)` Provides the means by which the value of a field can be given by a StateManager to an object that needs the value.
`void`	`storeIntField(int fieldNum, int value)` Provides the means by which the value of a int field can be given by a StateManager to an object that needs the value.
`void`	`storeLongField(int fieldNum, long value)` Provides the means by which the value of a long field can be given by a StateManager to an object that needs the value.
`void`	`storeObjectField(int fieldNum, java.lang.Object value)` Provides the means by which the value of an Object field can be given by a StateManager to an object that needs the value.
`void`	`storeShortField(int fieldNum, short value)` Provides the means by which the value of a short field can be given by a StateManager to an object that needs the value.
`void`	`storeStringField(int fieldNum, java.lang.String value)` Provides the means by which the value of a String field can be given by a StateManager to an object that needs the value.
`protected int`	`writeBlock(int[] fields, boolean identifying)` Writes a data block, which consists of the values of the specified fields, plus the CLID's and corresponding class names of referenced objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

verifyFields

private final boolean verifyFields

If true, verify values of object, otherwise verify only existence (and ignore remaining parameters).

fieldsToVerify

private final java.util.BitSet fieldsToVerify

Fields to verify in database.

verified

private boolean verified

Result of executing request.

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

VerifyRequest

VerifyRequest(StateManagerInternal sm,
              Message m,
              FOStorePMF pmf,
              boolean verifyFields,
              java.util.BitSet fieldsToVerify)

Method Detail

doRequestBody

protected void doRequestBody()
                      throws java.io.IOException

Provides the information necessary for a VerifyRequest. The format of this request is (aside from the request header):

 oid: OID
 boolean: verifyFields
 data block (optional; only if verifyFields is true)

Overrides:: doRequestBody in class InsertRequest

Throws:: java.io.IOException
See Also:: AbstractRequest.doRequestBody()

handleReply

public void handleReply(Status status,
                        java.io.DataInput in,
                        int length)
                 throws java.io.IOException

Handles reply data from a VerifyReply. The format of this reply is

 boolean: true => object exists in database, and (if verifyFields is
 true) values match those in request.

Specified by:: handleReply in interface Request
Overrides:: handleReply in class InsertRequest

Throws:: java.io.IOException
See Also:: Request.handleReply(org.apache.jdo.impl.fostore.Status, java.io.DataInput, int)