org.nakedobjects.remoting.protocol.encoding.internal
Interface ObjectEncoderDecoder

All Known Implementing Classes:

ObjectEncoderDecoderDefault

public interface ObjectEncoderDecoder

Method Summary

NakedObject	decode(Data data)
NakedObject	decode(Data data, KnownObjectsRequest knownObjects)
void	decode(ObjectData[] dataArray)
PersistenceQuery	decodePersistenceQuery(PersistenceQueryData persistenceQueryData)
Data[]	encodeActionParameters(NakedObjectSpecification[] parameterTypes, NakedObject[] parameterAdapters, KnownObjectsRequest knownObjects)
ReferenceData	encodeActionTarget(NakedObject targetAdapter, KnownObjectsRequest knownObjects)
EncodableObjectData	encodeAsValue(NakedObject value)
AuthorizationResponse	encodeAuthorizeResponse(boolean allowed)
ExecuteClientActionResponse	encodeClientActionResult(ReferenceData[] madePersistent, Version[] changedVersion, ObjectData[] updates)
ObjectData	encodeCompletePersistentGraph(NakedObject object) Creates an ObjectData that contains all the data for all the objects in the graph.
Data	encodeForResolveField(NakedObject targetAdapter, java.lang.String fieldName)
ObjectData	encodeForUpdate(NakedObject object) Creates an ObjectData that contains the data for the specified object, but not the data for any referenced objects.
ObjectData	encodeGraphForChangedObject(NakedObject adapter, KnownObjectsRequest knownObjects)
IdentityData	encodeIdentityData(NakedObject object)
ObjectData	encodeMadePersistentGraph(ObjectData originalData, NakedObject adapter) Creates a graph of ReferenceData objects (mirroring the graph of transient objects) to transfer the OIDs and Versions for each object that was made persistent during the makePersistent call.
ObjectData	encodeMakePersistentGraph(NakedObject adapter, KnownObjectsRequest knownObjects) Creates an ObjectData that contains all the data for all the transient objects in the specified transient object.
PersistenceQueryData	encodePersistenceQuery(PersistenceQuery persistenceQuery)
ExecuteServerActionResponse	encodeServerActionResult(NakedObject resultAdapter, ObjectData[] updatedData, ReferenceData[] disposedData, ObjectData persistedTargetData, ObjectData[] persistedParameterData, java.lang.String[] messages, java.lang.String[] warnings)
NakedObjectAssociation[]	getFieldOrder(NakedObjectSpecification specification) Returns the agreed order to transfer fields within data objects.
void	madePersistent(NakedObject target, ObjectData persistedTarget)

Method Detail

encodeAuthorizeResponse

AuthorizationResponse encodeAuthorizeResponse(boolean allowed)

getFieldOrder

NakedObjectAssociation[] getFieldOrder(NakedObjectSpecification specification)

Returns the agreed order to transfer fields within data objects. Both remote parties need to process the fields in the same order, this is that order.

encodeIdentityData

IdentityData encodeIdentityData(NakedObject object)

encodeForResolveField

Data encodeForResolveField(NakedObject targetAdapter,
                           java.lang.String fieldName)

encodeActionTarget

ReferenceData encodeActionTarget(NakedObject targetAdapter,
                                 KnownObjectsRequest knownObjects)

encodeActionParameters

Data[] encodeActionParameters(NakedObjectSpecification[] parameterTypes,
                              NakedObject[] parameterAdapters,
                              KnownObjectsRequest knownObjects)

encodeServerActionResult

ExecuteServerActionResponse encodeServerActionResult(NakedObject resultAdapter,
                                                     ObjectData[] updatedData,
                                                     ReferenceData[] disposedData,
                                                     ObjectData persistedTargetData,
                                                     ObjectData[] persistedParameterData,
                                                     java.lang.String[] messages,
                                                     java.lang.String[] warnings)

encodeClientActionResult

ExecuteClientActionResponse encodeClientActionResult(ReferenceData[] madePersistent,
                                                     Version[] changedVersion,
                                                     ObjectData[] updates)

encodeMakePersistentGraph

ObjectData encodeMakePersistentGraph(NakedObject adapter,
                                     KnownObjectsRequest knownObjects)

Creates an ObjectData that contains all the data for all the transient objects in the specified transient object.

For any referenced persistent object in the graph, only the reference is passed across.

encodeGraphForChangedObject

ObjectData encodeGraphForChangedObject(NakedObject adapter,
                                       KnownObjectsRequest knownObjects)

encodeMadePersistentGraph

ObjectData encodeMadePersistentGraph(ObjectData originalData,
                                     NakedObject adapter)

Creates a graph of ReferenceData objects (mirroring the graph of transient objects) to transfer the OIDs and Versions for each object that was made persistent during the makePersistent call.

encodeCompletePersistentGraph

ObjectData encodeCompletePersistentGraph(NakedObject object)

Creates an ObjectData that contains all the data for all the objects in the graph. This allows the client to receive all data it might need without having to return to the server to get referenced objects.

encodeAsValue

EncodableObjectData encodeAsValue(NakedObject value)

encodeForUpdate

ObjectData encodeForUpdate(NakedObject object)

Creates an ObjectData that contains the data for the specified object, but not the data for any referenced objects.

For each referenced object only the reference is passed across.

decode

NakedObject decode(Data data)

decode

void decode(ObjectData[] dataArray)

decode

NakedObject decode(Data data,
                   KnownObjectsRequest knownObjects)

encodePersistenceQuery

PersistenceQueryData encodePersistenceQuery(PersistenceQuery persistenceQuery)

decodePersistenceQuery

PersistenceQuery decodePersistenceQuery(PersistenceQueryData persistenceQueryData)

madePersistent

void madePersistent(NakedObject target,
                    ObjectData persistedTarget)