mirror of
https://github.com/google/nomulus.git
synced 2025-04-30 12:07:51 +02:00
c458c05801
The dark lord Gosling designed the Java package naming system so that ownership flows from the DNS system. Since we own the domain name registry.google, it seems only appropriate that we should use google.registry as our package name.
96 lines
3.6 KiB
Java
96 lines
3.6 KiB
Java
// Copyright 2016 The Domain Registry Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package google.registry.model.ofy;
|
|
|
|
import static com.google.appengine.api.datastore.EntityTranslator.convertToPb;
|
|
import static com.google.appengine.api.datastore.EntityTranslator.createFromPbBytes;
|
|
import static com.google.common.base.Preconditions.checkNotNull;
|
|
import static google.registry.model.ofy.ObjectifyService.ofy;
|
|
|
|
import com.google.appengine.api.datastore.KeyFactory;
|
|
import com.google.common.annotations.VisibleForTesting;
|
|
|
|
import com.googlecode.objectify.Key;
|
|
import com.googlecode.objectify.annotation.Entity;
|
|
import com.googlecode.objectify.annotation.Id;
|
|
import com.googlecode.objectify.annotation.Parent;
|
|
|
|
import google.registry.model.ImmutableObject;
|
|
import google.registry.model.annotations.NotBackedUp;
|
|
import google.registry.model.annotations.NotBackedUp.Reason;
|
|
|
|
/** Representation of a saved entity in a {@link CommitLogManifest} (not deletes). */
|
|
@Entity
|
|
@NotBackedUp(reason = Reason.COMMIT_LOGS)
|
|
public class CommitLogMutation extends ImmutableObject {
|
|
|
|
/** The manifest this belongs to. */
|
|
@Parent
|
|
Key<CommitLogManifest> parent;
|
|
|
|
/** Serialized web-safe string representation of saved entity key. */
|
|
@Id
|
|
String entityKey;
|
|
|
|
/**
|
|
* Raw entity that was saved during the transaction, serialized as a protocol buffer.
|
|
*
|
|
* <p>This value will be written to a GCS file by an export task.
|
|
*/
|
|
byte[] entityProtoBytes;
|
|
|
|
public byte[] getEntityProtoBytes() {
|
|
return entityProtoBytes.clone();
|
|
}
|
|
|
|
/** Deserializes embedded entity bytes and returns it. */
|
|
public com.google.appengine.api.datastore.Entity getEntity() {
|
|
return createFromPbBytes(entityProtoBytes);
|
|
}
|
|
|
|
/**
|
|
* Returns a new mutation entity created from an @Entity ImmutableObject instance.
|
|
*
|
|
* <p>The mutation key is generated deterministically from the {@code entity} key. The object is
|
|
* converted to a raw datastore Entity, serialized to bytes, and stored within the mutation.
|
|
*/
|
|
public static CommitLogMutation create(Key<CommitLogManifest> parent, Object entity) {
|
|
return createFromRaw(parent, ofy().save().toEntity(entity));
|
|
}
|
|
|
|
/**
|
|
* Returns a new mutation entity created from a raw datastore Entity instance.
|
|
*
|
|
* <p>The mutation key is generated deterministically from the {@code entity} key. The Entity
|
|
* itself is serialized to bytes and stored within the returned mutation.
|
|
*/
|
|
@VisibleForTesting
|
|
public static CommitLogMutation createFromRaw(
|
|
Key<CommitLogManifest> parent,
|
|
com.google.appengine.api.datastore.Entity rawEntity) {
|
|
CommitLogMutation instance = new CommitLogMutation();
|
|
instance.parent = checkNotNull(parent);
|
|
// Creates a web-safe key string.
|
|
instance.entityKey = KeyFactory.keyToString(rawEntity.getKey());
|
|
instance.entityProtoBytes = convertToPb(rawEntity).toByteArray();
|
|
return instance;
|
|
}
|
|
|
|
/** Returns the key of a mutation based on the {@code entityKey} of the entity it stores. */
|
|
public static
|
|
Key<CommitLogMutation> createKey(Key<CommitLogManifest> parent, Key<?> entityKey) {
|
|
return Key.create(parent, CommitLogMutation.class, entityKey.getString());
|
|
}
|
|
}
|