com.mindoo.domino.jna.NotesOriginatorId Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jna Show documentation
Show all versions of domino-jna Show documentation
Java project to access the HCL Domino C API using Java Native Access (JNA)
package com.mindoo.domino.jna;
import java.util.Arrays;
import com.mindoo.domino.jna.internal.structs.NotesOriginatorIdStruct;
import com.mindoo.domino.jna.internal.structs.NotesTimeDateStruct;
import com.sun.jna.Pointer;
import com.sun.jna.Structure;
/**
* The Originator ID (OID) for a note identifies all replica copies of the same note and distinguishes
* between different revisions of that note.
*
* The Originator ID is composed of two parts:
* (1) the Universal Note ID (UNID) and (2) the Sequence Number and Sequence Time.
*
* The UNID (the first part of the OID) universally identifies all copies of the same note.
* If one note in one database has the same UNID as another note in a replica of that database,
* then the two notes are replica copies of each other. The Sequence Number and the Sequence Time,
* taken together, distinguish different revisions of the same note from one another.
*
* The full Originator ID uniquely identifies one particular version of a note. A modified
* version of a replica copy of a particular note will have a different OID.
* This is because Domino or Notes increments the Sequence Number when a note is edited, and also
* sets the Sequence Time to the timedate when the Sequence Number was incremented.
* This means that when one replica copy of a note remains unchanged, but another copy is edited
* and modified, then the UNIDs of the 2 notes will remain the same but the Sequence Number and
* Sequence Times (hence, the OIDs) will be different.
*
* The "File" member of the OID (and UNID), contains a number derived in different ways depending
* on the release of Domino or Notes. Pre- 2.1 versions of Notes set the "File" member to the
* creation timedate of the NSF file in which the note is created. Notes 2.1 sets the "File"
* member to a user-unique identifier, derived in part from information in the ID of the user
* creating the note, and in part from the database where the note is created. Notes 3.0 sets
* the "File" member to a random number generated at the time the note is created.
*
* The "Note" member of the OID (and UNID), contains the date/time when the very first copy of
* the note was stored into the first NSF (Note: date/time from $CREATED item, if exists, takes precedence).
*
* The "Sequence" member is a sequence number used to keep track of the most recent version of the
* note. The "SequenceTime" member is a sequence number qualifier, that allows the Domino replicator
* to determine which note is later given identical Sequence numbers.
* The sequence time qualifies the sequence number by preventing two concurrent updates from looking
* like no update at all. The sequence time also forces all Domino systems to reach the same
* decision as to which update is the "latest" version.
*
* The sequence time is the value that is returned to the @Modified formula and indicates when
* the document was last edited and saved.
*/
public class NotesOriginatorId implements IAdaptable {
private String unid;
private int sequence;
/** C type : TIMEDATE */
private NotesTimeDate sequenceTime;
/** structure is lazily created */
private NotesOriginatorIdStruct m_struct;
public NotesOriginatorId(IAdaptable adaptable) {
NotesOriginatorIdStruct struct = adaptable.getAdapter(NotesOriginatorIdStruct.class);
if (struct!=null) {
m_struct = struct;
this.unid = m_struct.getUNIDAsString();
this.sequence = m_struct.Sequence;
this.sequenceTime = m_struct.SequenceTime==null ? null : new NotesTimeDate(m_struct.SequenceTime);
return;
}
Pointer p = adaptable.getAdapter(Pointer.class);
if (p!=null) {
m_struct = NotesOriginatorIdStruct.newInstance(p);
m_struct.read();
this.unid = m_struct.getUNIDAsString();
this.sequence = m_struct.Sequence;
this.sequenceTime = m_struct.SequenceTime==null ? null : new NotesTimeDate(m_struct.SequenceTime);
return;
}
throw new IllegalArgumentException("Constructor argument cannot provide a supported datatype");
}
public NotesOriginatorId(String unid, int sequence, NotesTimeDate sequenceTime) {
this.unid = unid;
this.sequence = sequence;
this.sequenceTime = sequenceTime;
}
public NotesOriginatorId(String unid, int sequence, int[] sequenceTimeInnards) {
this.unid = unid;
this.sequence = sequence;
this.sequenceTime = new NotesTimeDate(sequenceTimeInnards);
}
public NotesTimeDate getFile() {
//creating structure converts UNID to file/note
NotesOriginatorIdStruct struct = getAdapter(NotesOriginatorIdStruct.class);
if (struct==null)
throw new IllegalStateException("NotesOriginatorIdStruct expected not to be null");
if (struct.File!=null) {
return new NotesTimeDate(struct.File.Innards);
}
return null;
}
public NotesTimeDate getNote() {
//creating structure converts UNID to file/note
NotesOriginatorIdStruct struct = getAdapter(NotesOriginatorIdStruct.class);
if (struct==null)
throw new IllegalStateException("NotesOriginatorIdStruct expected not to be null");
if (struct.Note!=null) {
return new NotesTimeDate(struct.Note.Innards);
}
return null;
}
public int getSequence() {
if (m_struct!=null) {
this.sequence = m_struct.Sequence;
}
return this.sequence;
}
public void setSequence(int newSeq) {
if (m_struct!=null) {
m_struct = NotesOriginatorIdStruct.newInstance();
}
m_struct.Sequence = newSeq;
this.sequence = newSeq;
//make sture SequenceTime has a value
if (m_struct.SequenceTime==null) {
m_struct.SequenceTime = NotesTimeDateStruct.newInstance();
m_struct.SequenceTime.setNow();
this.sequenceTime = new NotesTimeDate(m_struct.SequenceTime);
}
m_struct.write();
}
public void setSequenceTime(NotesTimeDate td) {
if (m_struct!=null) {
m_struct = NotesOriginatorIdStruct.newInstance();
}
if (m_struct.SequenceTime==null) {
m_struct.SequenceTime = NotesTimeDateStruct.newInstance();
}
m_struct.SequenceTime.Innards[0] = td.getInnardsNoClone()[0];
m_struct.SequenceTime.Innards[1] = td.getInnardsNoClone()[1];
m_struct.SequenceTime.write();
m_struct.write();
this.sequenceTime = new NotesTimeDate(td.getInnardsNoClone());
}
public NotesTimeDate getSequenceTime() {
if (this.m_struct!=null && this.m_struct.SequenceTime!=null) {
if (this.sequenceTime==null ||
Arrays.equals(this.sequenceTime.getInnardsNoClone(), this.m_struct.SequenceTime.Innards)) {
this.sequenceTime = new NotesTimeDate(this.m_struct.SequenceTime.Innards);
}
}
return this.sequenceTime;
}
@Override
public T getAdapter(Class clazz) {
if (clazz == NotesOriginatorIdStruct.class || clazz == Structure.class) {
if (m_struct==null) {
m_struct = NotesOriginatorIdStruct.newInstance();
m_struct.Sequence = this.sequence;
m_struct.SequenceTime = this.sequenceTime==null ? null : this.sequenceTime.getAdapter(NotesTimeDateStruct.class);
if (this.unid!=null) {
m_struct.setUNID(this.unid);
}
m_struct.write();
}
return (T) m_struct;
}
return null;
}
/**
* Extracts the {@link NotesUniversalNoteId} part from the OID data
*
* @return UNID
*/
public NotesUniversalNoteId getUNID() {
NotesOriginatorIdStruct struct = getAdapter(NotesOriginatorIdStruct.class);
if (struct==null)
throw new IllegalStateException("NotesOriginatorIdStruct expected not to be null");
return new NotesUniversalNoteId(m_struct.getUNID());
}
/**
* Computes the hex UNID from the OID data
*
* @return UNID
*/
public String getUNIDAsString() {
if (this.unid==null) {
NotesOriginatorIdStruct struct = getAdapter(NotesOriginatorIdStruct.class);
if (struct==null)
throw new IllegalStateException("NotesOriginatorIdStruct expected not to be null");
this.unid = struct.getUNIDAsString();
}
return this.unid;
}
@Override
public String toString() {
return "NotesOriginatorId [unid="+getUNIDAsString()+", seq="+getSequence()+", seqtime="+getSequenceTime()+"]";
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy