com.mindoo.domino.jna.utils.NotesCalendarUtils 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.utils;
import java.io.IOException;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import com.mindoo.domino.jna.NotesCalendarActionData;
import com.mindoo.domino.jna.NotesDatabase;
import com.mindoo.domino.jna.NotesNote;
import com.mindoo.domino.jna.NotesTimeDate;
import com.mindoo.domino.jna.NotesUniversalNoteId;
import com.mindoo.domino.jna.constants.CalendarActionOptions;
import com.mindoo.domino.jna.constants.CalendarNoteOpen;
import com.mindoo.domino.jna.constants.CalendarProcess;
import com.mindoo.domino.jna.constants.CalendarRangeRepeat;
import com.mindoo.domino.jna.constants.CalendarRead;
import com.mindoo.domino.jna.constants.CalendarReadRange;
import com.mindoo.domino.jna.constants.CalendarWrite;
import com.mindoo.domino.jna.errors.INotesErrorConstants;
import com.mindoo.domino.jna.errors.NotesError;
import com.mindoo.domino.jna.errors.NotesErrorUtils;
import com.mindoo.domino.jna.gc.NotesGC;
import com.mindoo.domino.jna.internal.CalNoteOpenData32;
import com.mindoo.domino.jna.internal.CalNoteOpenData64;
import com.mindoo.domino.jna.internal.DisposableMemory;
import com.mindoo.domino.jna.internal.INotesNativeAPIV901;
import com.mindoo.domino.jna.internal.Mem32;
import com.mindoo.domino.jna.internal.Mem64;
import com.mindoo.domino.jna.internal.NotesConstants;
import com.mindoo.domino.jna.internal.NotesNativeAPI;
import com.mindoo.domino.jna.internal.NotesNativeAPI32;
import com.mindoo.domino.jna.internal.NotesNativeAPI64;
import com.mindoo.domino.jna.internal.NotesNativeAPIV901;
import com.mindoo.domino.jna.internal.structs.NotesCalendarActionDataStruct;
import com.mindoo.domino.jna.internal.structs.NotesTimeDateStruct;
import com.mindoo.domino.jna.internal.structs.NotesUniversalNoteIdStruct;
import com.sun.jna.Memory;
import com.sun.jna.Native;
import com.sun.jna.Pointer;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.LongByReference;
import com.sun.jna.ptr.ShortByReference;
/**
* Utility class to access the Calendaring and Scheduling APIs of Domino.
*
* Please note that this class is not feature complete. We currently support
* creating, updating and reading appointments, but we do not yet support Domino's
* meeting workflow (accept/decline etc.)
*
* @author Karsten Lehmann
*/
public class NotesCalendarUtils {
/**
* Creates a calendar entry.
*
* This supports either a single entry, or a recurring entry which may contain multiple
* VEVENTS represenging both the series and exception data. The iCalendar input must only
* contain data for a single UID.For meetings, ATTENDEE PARTSTAT data is ignored.
* If the mailfile owner is the meeting organizer, invitations will be sent out to meeting
* participants (unless {@link CalendarWrite#DISABLE_IMPLICIT_SCHEDULING} is specified)
*
* The following errors will be thrown by this method:
*
* - NOERROR - on success
* - {@link INotesErrorConstants#ERR_NULL_DBHANDLE} - The database handle is NULL
* - ERR_MISC_INVALID_ARGS - Unexpected arguments provided
* - {@link INotesErrorConstants#ERR_NO_CALENDAR_FOUND} - Unable to find the entry because the required view does not exist in this database
* - ERR_EXISTS An entry already exists
* - ERR_CS_PROFILE_NOOWNER - Calendar Profile does not specify owner
* - ERR_UNEXPECTED_METHOD - Provided iCalendar contains a method (no method expected here)
* - {@link INotesErrorConstants#ERR_ICAL2NOTE_CONVERT} - Error interpreting iCalendar input
* - ERR_MISC_UNEXPECTED_ERROR - Unexpected internal error
* - {@link INotesErrorConstants#ERR_IMPLICIT_SCHED_FAILED} - Entry was updated, but errors were encountered sending notices to meeting participants
*
*
* @param dbMail The database where the entry will be created.
* @param iCal The iCalendar data representing the entry to create
* @param flags {@link CalendarWrite} flags to control non-default behavior
* @return the UID of the created iCalendar
*/
public static String createCalendarEntry(NotesDatabase dbMail, String iCal, EnumSet flags) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
Memory icalMem = NotesStringUtils.toLMBCS(iCal, true, false);
int dwFlags = flags==null ? 0 : CalendarWrite.toBitMask(flags);
String retUID=null;
short result;
if (PlatformUtils.is64Bit()) {
LongByReference hRetUID = new LongByReference();
result = NotesNativeAPI64.get().CalCreateEntry(dbMail.getHandle64(), icalMem, dwFlags, hRetUID, null);
NotesErrorUtils.checkResult(result);
long hRetUIDLong = hRetUID.getValue();
if (hRetUIDLong!=0) {
Pointer retUIDPtr = Mem64.OSMemoryLock(hRetUIDLong);
try {
retUID = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
finally {
Mem64.OSMemoryUnlock(hRetUIDLong);
Mem64.OSMemoryFree(hRetUIDLong);
}
}
}
else {
IntByReference hRetUID = new IntByReference();
result = NotesNativeAPI32.get().CalCreateEntry(dbMail.getHandle32(), icalMem, dwFlags, hRetUID, null);
NotesErrorUtils.checkResult(result);
int hRetUIDInt = hRetUID.getValue();
if (hRetUIDInt!=0) {
Pointer retUIDPtr = Mem32.OSMemoryLock(hRetUIDInt);
try {
retUID = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
finally {
Mem32.OSMemoryUnlock(hRetUIDInt);
Mem32.OSMemoryFree(hRetUIDInt);
}
}
}
return retUID;
}
/**
* This will modify an existing calendar entry.
*
* This supports either single entries or recurring entries, but recurring entries will only
* support updates for a single instance specified via RECURRENCE-ID that may not include a
* RANGE (This may be permitted in the future but for now will return an error).
*
* The iCalendar input may only contain a single VEVENT and must contain a UID.
* By default, attachments and custom data (for fields contained in $CSCopyItems) will be
* maintained from the existing calendar entry. Similarly, description will also be maintained
* if it is not specified in the iCalendar content that is updating.
*
* Both of these behaviors can be canceled via the CAL_WRITE_COMPLETE_REPLACE flag.
* If the mailfile owner is the meeting organizer, appropriate notices will be sent out
* to meeting participants (unless {@link CalendarWrite#DISABLE_IMPLICIT_SCHEDULING} is specified).
*
* The following errors will be thrown by this method:
*
* - NOERROR - on success
* - {@link INotesErrorConstants#ERR_NULL_DBHANDLE} - The database handle is NULL
* - ERR_MISC_INVALID_ARGS - Unexpected arguments provided
* - ERR_CALACTION_INVALID - This calendar entry is not in a state where updating it is supported.
* - {@link INotesErrorConstants#ERR_NO_CALENDAR_FOUND} - Unable to find the entry because the required view does not exist in this database
* - ERR_NOT_FOUND - There are no entries that match the specified UID or UID/recurid in the database
* - ERR_NOT_YET_IMPLEMENTED - This update is not yet supported (update range or multiple VEVENTs?)
* - ERR_CS_PROFILE_NOOWNER - Calendar Profile does not specify owner
* - ERR_UNEXPECTED_METHOD - Provided iCalendar contains a method (no method expected here)
* - ERR_ICAL2NOTE_OUTOFDATE - iCalendar input is out of date in regards to sequence information.
* - {@link INotesErrorConstants#ERR_ICAL2NOTE_CONVERT} - Error interpereting iCalendar input
* - ERR_MISC_UNEXPECTED_ERROR - Unexpected internal error
* - {@link INotesErrorConstants#ERR_IMPLICIT_SCHED_FAILED} - Entry was updated, but errors were encountered sending notices to meeting participants
*
*
* @param dbMail The database containing the entry to update
* @param iCal The iCalendar data representing the updated entry
* @param uid If non-NULL, this value MUST match the UID value in the iCalendar input. If present,or else this returns ERR_InvalidVEventPropertyFound. If the iCalendar input has no UID this value will be used.
* @param recurId If non-NULL, this value MUST match the RECURRENCE-ID value in the iCalendar input if present, or else this returns ERR_InvalidVEventPropertyFound. If the iCalendar input has no RECURRENCE-ID this value will be used.
* @param comments If non-NULL, this text will be sent as comments on any notices sent to meeting participants as a result of this call. that will be included on the notices. Can be NULL.
* @param flags {@link CalendarWrite} flags to control non-default behavior. Supported: CAL_WRITE_MODIFY_LITERAL, {@link CalendarWrite#DISABLE_IMPLICIT_SCHEDULING}, {@link CalendarWrite#IGNORE_VERIFY_DB}.
*/
public static void updateCalendarEntry(NotesDatabase dbMail, String iCal, String uid, String recurId, String comments,
EnumSet flags) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
Memory icalMem = NotesStringUtils.toLMBCS(iCal, true, false);
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
Memory recurIdMem = NotesStringUtils.toLMBCS(recurId, true);
Memory commentsMem = NotesStringUtils.toLMBCS(comments, true);
int dwFlags = flags==null ? 0 : CalendarWrite.toBitMask(flags);
short result;
if (PlatformUtils.is64Bit()) {
result = NotesNativeAPI64.get().CalUpdateEntry(dbMail.getHandle64(), icalMem, uidMem, recurIdMem, commentsMem, dwFlags, null);
}
else {
result = NotesNativeAPI32.get().CalUpdateEntry(dbMail.getHandle32(), icalMem, uidMem, recurIdMem, commentsMem, dwFlags, null);
}
NotesErrorUtils.checkResult(result);
}
/**
* This is a convinience method that returns a UID from a NOTEID.
* NOTEID->UID is a many to one mapping since one or several notes may represent
* a calendar entry (especially if it repeats) and its related notices.
*
* As such, the UID output will be the same for all notes that refer to the same calendar entry.
* This method may incur a note open, so there could be performance impact.
*
* The following errors will be thrown by this method:
*
* - NOERROR - on success
* - {@link INotesErrorConstants#ERR_NULL_DBHANDLE} - The database handle is NULL
* - ERR_INVALID_NOTE - Note is not valid or is not a calendar note
* - ERR_MISC_INVALID_ARGS - Unexpected arguments provided
* - ERR_VALUE_LENGTH - The value is too long for the allocated buffer
*
*
* @param note note
* @return UID
*/
public static String getUIDfromNote(NotesNote note) {
return getUIDfromNoteID(note.getParent(), note.getNoteId());
}
/**
* This is a convinience method that returns a UID from a NOTEID.
* NOTEID->UID is a many to one mapping since one or several notes may represent
* a calendar entry (especially if it repeats) and its related notices.
*
* As such, the UID output will be the same for all notes that refer to the same calendar entry.
* This method may incur a note open, so there could be performance impact.
*
* The following errors will be thrown by this method:
*
* - NOERROR - on success
* - {@link INotesErrorConstants#ERR_NULL_DBHANDLE} - The database handle is NULL
* - ERR_INVALID_NOTE - Note is not valid or is not a calendar note
* - ERR_MISC_INVALID_ARGS - Unexpected arguments provided
* - ERR_VALUE_LENGTH - The value is too long for the allocated buffer
*
*
* @param dbMail The database containing the note referenced by noteid.
* @param noteId note id
* @return UID
*/
public static String getUIDfromNoteID(NotesDatabase dbMail, int noteId) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
DisposableMemory retUID = new DisposableMemory(NotesConstants.MAXPATH);
try {
short result;
if (PlatformUtils.is64Bit()) {
result = NotesNativeAPI64.get().CalGetUIDfromNOTEID(dbMail.getHandle64(), noteId, retUID, (short) (NotesConstants.MAXPATH & 0xffff),
null, 0, null);
}
else {
result = NotesNativeAPI32.get().CalGetUIDfromNOTEID(dbMail.getHandle32(), noteId, retUID, (short) (NotesConstants.MAXPATH & 0xffff),
null, 0, null);
}
NotesErrorUtils.checkResult(result);
String uid = NotesStringUtils.fromLMBCS(retUID, -1);
return uid;
}
finally {
retUID.dispose();
}
}
/**
* This is a convinience method that returns a UID from a UNID.
*
* UNID->UID is a many to one mapping since one or several notes may represent a
* calendar entry (especially if it repeats) and its related notices.
* As such, the UID output will be the same for all notes that refer to the same
* calendar entry.
* This method may incur a note open, so there could be performance impact.
*
* The following errors will be thrown by this method:
*
* - NOERROR - on success
* - {@link INotesErrorConstants#ERR_NULL_DBHANDLE} - The database handle is NULL
* - ERR_INVALID_NOTE - Note is not valid or is not a calendar note
* - ERR_MISC_INVALID_ARGS - Unexpected arguments provided
* - ERR_VALUE_LENGTH - The value is too long for the allocated buffer
*
*
* @param dbMail The database containing the note referenced by unid.
* @param unid UNID of a calendar note
* @return UID
*/
public static String getUIDFromUNID(NotesDatabase dbMail, String unid) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
NotesUniversalNoteId unidObj = new NotesUniversalNoteId(unid);
NotesUniversalNoteIdStruct unidStruct = unidObj.getAdapter(NotesUniversalNoteIdStruct.class);
DisposableMemory retUID = new DisposableMemory(NotesConstants.MAXPATH);
try {
short result;
if (PlatformUtils.is64Bit()) {
result = NotesNativeAPI64.get().CalGetUIDfromUNID(dbMail.getHandle64(), unidStruct, retUID,
(short) (NotesConstants.MAXPATH & 0xffff), null, 0, null);
}
else {
result = NotesNativeAPI32.get().CalGetUIDfromUNID(dbMail.getHandle32(), unidStruct, retUID,
(short) (NotesConstants.MAXPATH & 0xffff), null, 0, null);
}
NotesErrorUtils.checkResult(result);
String uid = NotesStringUtils.fromLMBCS(retUID, -1);
return uid;
}
finally {
retUID.dispose();
}
}
/**
* This is a convenience method that returns an Apptunid value that corresponds to a UID.
*
* @param uid UID of the icalendar entry
* @return ApptUnid
*/
public static String getApptUnidFromUID(String uid) {
//this may fail if the C API is too old, e.g. 9.0
INotesNativeAPIV901 api;
try {
api = NotesNativeAPIV901.get();
}
catch (Exception e) {
throw new NotesError(0, "Error initializing API. Notes C API version must be 9.0.1 or higher", e);
}
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
DisposableMemory retApptUnidMem = new DisposableMemory(NotesConstants.MAXPATH);
try {
short result = api.CalGetApptunidFromUID(uidMem, retApptUnidMem, 0, null);
NotesErrorUtils.checkResult(result);
String apptUnid = NotesStringUtils.fromLMBCS(retApptUnidMem, -1);
return apptUnid;
}
finally {
retApptUnidMem.dispose();
}
}
/**
* This is a method to get a note handle for an entry on the calendar.
*
* The intent is that the note handle can be used to get information about an
* entry or instance or to write additional information to the entry or
* instance (beyond what is defined in iCalendar and/or available in this API).
* It is the callers responsibility to close the note via {@link NotesNote#recycle()} or
* let it be auto-GC'ed.
* When opening a recurring entry, a valid recurrence ID MUST also be provided.
*
* A note representing the single instance will be returned. This might cause notes to be created or modified as a side effect.
*
* The following errors will be thrown by this method:
*
* - NOERROR - on success
* - {@link INotesErrorConstants#ERR_NULL_DBHANDLE} - The database handle is NULL
* - {@link INotesErrorConstants#ERR_NO_CALENDAR_FOUND} - Unable to find the entry because the required view does not exist in this database
* - ERR_NOT_FOUND - There are no entries that match the specified UID or UID/recurid in the database
* - ERR_MISC_INVALID_ARGS - Unexpected arguments provided
* - ERR_TDI_CONV - The recurrence ID specified cannot be interpreted
* - ERR_MISC_UNEXPECTED_ERROR - Unexpected internal error
*
*
* @param dbMail The database containing the entry to open.
* @param uid The UID of the entry to get a note handle for.
* @param recurId The RECURRENCE-ID of the instance to get a note handle for. Timezones not permitted (time values must be in UTC time). NULL for single entries. Must be present for recurring entries.
* @param flags {@link CalendarNoteOpen} flags to control non-default behavior. Supported: {@link CalendarNoteOpen#HANDLE_NOSPLIT}.
* @return note
*/
public static NotesNote openCalendarEntryNote(NotesDatabase dbMail, String uid, String recurId,
EnumSet flags) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
Memory recurIdMem = NotesStringUtils.toLMBCS(recurId, true);
int dwFlags = flags==null ? 0 : CalendarNoteOpen.toBitMask(flags);
short result;
if (PlatformUtils.is64Bit()) {
LongByReference rethNote = new LongByReference();
result = NotesNativeAPI64.get().CalOpenNoteHandle(dbMail.getHandle64(), uidMem, recurIdMem, rethNote, dwFlags, null);
NotesErrorUtils.checkResult(result);
long hNote = rethNote.getValue();
if (hNote==0)
return null;
CalNoteOpenData64 calNoteOpen = new CalNoteOpenData64(dbMail, hNote);
NotesNote note = new NotesNote(calNoteOpen);
NotesGC.__objectCreated(NotesNote.class, note);
return note;
}
else {
IntByReference rethNote = new IntByReference();
result = NotesNativeAPI32.get().CalOpenNoteHandle(dbMail.getHandle32(), uidMem, recurIdMem, rethNote, dwFlags, null);
NotesErrorUtils.checkResult(result);
int hNote = rethNote.getValue();
if (hNote==0)
return null;
CalNoteOpenData32 calNoteOpen = new CalNoteOpenData32(dbMail, hNote);
NotesNote note = new NotesNote(calNoteOpen);
NotesGC.__objectCreated(NotesNote.class, note);
return note;
}
}
/**
* This will return complete iCalendar data for the specified entry.
*
* For recurring entries, this may result in multiple VEVENTs in the returned
* iCalendar data.
* In this case, the first VEVENT represents the recurrence set and additional
* entries represent exceptions to the recurrence set.
*
* All instances that differ from the recurrence set will be returned as additional
* VEVENTs containing the exceptional data. There is no concept of 'runs' of
* instances or RANGE of instances.
* Alternatively, a specific instance may be requested using recurId
* and only the data for that instance will be returned.
* Returned data will not include rich text description.
* All participants of a meeting will be returned as PARTSTAT=NEEDS-ACTION even if they have responded.
*
* @param dbMail The database from which entries are returned.
* @param uid The UID of the entry to be returned.
* @param recurId NULL for single entries or to read data for an entire recurring series. If populated, this is the RECURRENCE-ID of the specific instance to read.
* @param flags {@link CalendarRead} flags to control non-default behavior
* @return iCalendar data
*/
public static String readCalendarEntry(NotesDatabase dbMail, String uid, String recurId, EnumSet flags) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
Memory recurIdMem = NotesStringUtils.toLMBCS(recurId, true);
int dwFlags = flags==null ? 0 : CalendarRead.toBitMask(flags);
String retIcal = null;
short result;
if (PlatformUtils.is64Bit()) {
LongByReference hRetCalData = new LongByReference();
result = NotesNativeAPI64.get().CalReadEntry(dbMail.getHandle64(), uidMem, recurIdMem, hRetCalData, null, dwFlags, null);
NotesErrorUtils.checkResult(result);
long hRetCalDataLong = hRetCalData.getValue();
if (hRetCalDataLong!=0) {
Pointer retUIDPtr = Mem64.OSMemoryLock(hRetCalDataLong);
try {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
finally {
Mem64.OSMemoryUnlock(hRetCalDataLong);
Mem64.OSMemoryFree(hRetCalDataLong);
}
}
}
else {
IntByReference hRetCalData = new IntByReference();
result = NotesNativeAPI32.get().CalReadEntry(dbMail.getHandle32(), uidMem, recurIdMem, hRetCalData, null, dwFlags, null);
NotesErrorUtils.checkResult(result);
int hRetCalDataInt = hRetCalData.getValue();
if (hRetCalDataInt!=0) {
Pointer retUIDPtr = Mem32.OSMemoryLock(hRetCalDataInt);
try {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
finally {
Mem32.OSMemoryUnlock(hRetCalDataInt);
Mem32.OSMemoryFree(hRetCalDataInt);
}
}
}
return retIcal;
}
/**
* Gets a summary of calendar entries for a range of times
*
* @param dbMail The database from which entries are returned.
* @param start the start time of the range
* @param end the end time of the range. An exception occurs if the end time is not greater than the start time
* @param retICal if not null, we return a summary in iCalendar format of the entries from the start date to the end date, inclusive. An exception occurs if the range contains no entries.
* @param retUIDs if not null, we return a list of UIDs found within the range
* @throws IOException if writing iCalendar data fails
*/
public static void readRange(NotesDatabase dbMail, NotesTimeDate start, NotesTimeDate end,
Appendable retICal, List retUIDs) throws IOException {
readRange(dbMail, start, end, 0, Integer.MAX_VALUE, null, retICal, retUIDs);
}
/**
* Gets a summary of calendar entries for a range of times
*
* @param dbMail The database from which entries are returned.
* @param start the start time of the range
* @param end the end time of the range. An exception occurs if the end time is not greater than the start time
* @param skipCount the number of entries to skip from the beginning of the range. This parameter can be used in conjunction with entriesprocessed to read the entries in a series of calls
* @param maxRead the maximum number of entries to read
* @param retICal if not null, we return a summary in iCalendar format of the entries from the start date to the end date, inclusive. An exception occurs if the range contains no entries.
* @param retUIDs if not null, we return a list of UIDs found within the range
* @throws IOException if writing iCalendar data fails
*/
public static void readRange(NotesDatabase dbMail, NotesTimeDate start, NotesTimeDate end, int skipCount, int maxRead,
Appendable retICal, List retUIDs) throws IOException {
readRange(dbMail, start, end, skipCount, maxRead, null, retICal, retUIDs);
}
/**
* Gets a summary of calendar entries for a range of times
*
* @param dbMail The database from which entries are returned.
* @param start the start time of the range
* @param end the end time of the range. An exception occurs if the end time is not greater than the start time
* @param skipCount the number of entries to skip from the beginning of the range. This parameter can be used in conjunction with entriesprocessed to read the entries in a series of calls
* @param maxRead the maximum number of entries to read
* @param readMask flags that control what properties about the calendar entries will be returned
* @param retICal if not null, we return a summary in iCalendar format of the entries from the start date to the end date, inclusive. An exception occurs if the range contains no entries.
* @param retUIDs if not null, we return a list of UIDs found within the range
* @throws IOException if writing iCalendar data fails
*/
public static void readRange(NotesDatabase dbMail, NotesTimeDate start, NotesTimeDate end, int skipCount, int maxRead,
EnumSet readMask, Appendable retICal, List retUIDs) throws IOException {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
NotesTimeDateStruct.ByValue startStruct = start==null ? null : NotesTimeDateStruct.ByValue.newInstance(start.getInnards());
NotesTimeDateStruct.ByValue endStruct = end==null ? null : NotesTimeDateStruct.ByValue.newInstance(end.getInnards());
int dwReturnMask = CalendarReadRange.toBitMask(readMask);
int dwReturnMaskExt = CalendarReadRange.toBitMask2(readMask);
//variables to collect the whole lookup result
StringBuilder sbIcalAllData = retICal==null ? null : new StringBuilder();
List uidAllData = retUIDs==null ? null : new ArrayList();
while (true) {
int currSkipCount = skipCount;
int remainingToRead = maxRead;
short result;
boolean hasMoreToDo;
boolean hasConflict;
//clear current lookup result, while(true) loop may be run multiple times
//if lookup view changes
if (sbIcalAllData!=null) {
sbIcalAllData.setLength(0);
}
if (uidAllData!=null) {
uidAllData.clear();
}
do {
if (PlatformUtils.is64Bit()) {
LongByReference hRetCalData = retICal==null ? null : new LongByReference();
LongByReference hRetUIDData = retUIDs==null ? null : new LongByReference();
ShortByReference retCalBufferLength = new ShortByReference();
ShortByReference retSignalFlags = new ShortByReference();
IntByReference retNumEntriesProcessed = new IntByReference();
result = NotesNativeAPI64.get().CalReadRange(dbMail.getHandle64(), startStruct, endStruct, currSkipCount,
remainingToRead, dwReturnMask, dwReturnMaskExt, null, hRetCalData,
retCalBufferLength, hRetUIDData, retNumEntriesProcessed, retSignalFlags, 0, null);
if ((result & NotesConstants.ERR_MASK)==1028) { //no data found
return;
}
NotesErrorUtils.checkResult(result);
int numEntriesProcessed = retNumEntriesProcessed.getValue();
currSkipCount += numEntriesProcessed;
remainingToRead -= numEntriesProcessed;
if (hRetCalData!=null && retICal!=null && sbIcalAllData!=null) {
//decode iCalendar
int iCalBufLength = (int) (retCalBufferLength.getValue() & 0xffff);
if (iCalBufLength>0) {
long hRetCalDataLong = hRetCalData.getValue();
if (hRetCalDataLong!=0) {
Pointer retUIDPtr = Mem64.OSMemoryLock(hRetCalDataLong);
try {
String currICal = NotesStringUtils.fromLMBCS(retUIDPtr, iCalBufLength);
sbIcalAllData.append(currICal);
}
finally {
Mem64.OSMemoryUnlock(hRetCalDataLong);
Mem64.OSMemoryFree(hRetCalDataLong);
}
}
}
}
if (hRetUIDData!=null && retUIDs!=null && uidAllData!=null) {
//decode UID list
long hRetUIDDataLong = hRetUIDData.getValue();
if (hRetUIDDataLong!=0) {
Pointer pUIDData = Mem64.OSMemoryLock(hRetUIDDataLong);
ShortByReference retTextLength = new ShortByReference();
Memory retTextPointer = new Memory(Native.POINTER_SIZE);
try {
int numEntriesAsInt = (int) (NotesNativeAPI.get().ListGetNumEntries(pUIDData, 0) & 0xffff);
for (int i=0; i0) {
int hRetCalDataInt = hRetCalData.getValue();
if (hRetCalDataInt!=0) {
Pointer retUIDPtr = Mem32.OSMemoryLock(hRetCalDataInt);
try {
String currICal = NotesStringUtils.fromLMBCS(retUIDPtr, iCalBufLength);
sbIcalAllData.append(currICal);
}
finally {
Mem32.OSMemoryUnlock(hRetCalDataInt);
Mem32.OSMemoryFree(hRetCalDataInt);
}
}
}
}
if (hRetUIDData!=null && retUIDs!=null && uidAllData!=null) {
//decode UID list
int hRetUIDDataInt = hRetUIDData.getValue();
if (hRetUIDDataInt!=0) {
Pointer pUIDData = Mem32.OSMemoryLock(hRetUIDDataInt);
ShortByReference retTextLength = new ShortByReference();
Memory retTextPointer = new Memory(Native.POINTER_SIZE);
try {
int numEntriesAsInt = (int) (NotesNativeAPI.get().ListGetNumEntries(pUIDData, 0) & 0xffff);
for (int i=0; i0);
if (!hasConflict) {
//no read conflict in view, we are done
break;
}
else {
//retry the whole lookup
continue;
}
}
//return what we have read
if (retICal!=null && sbIcalAllData!=null) {
retICal.append(sbIcalAllData.toString());
}
if (retUIDs!=null && uidAllData!=null) {
retUIDs.addAll(uidAllData);
}
}
/**
* This is a convinience method that returns a RECURRENCE-ID (in UTC time) from a {@link NotesTimeDate} object.
*
* @param td Input time/date object
* @return RECURRENCE-ID
*/
public static String getRecurrenceID(NotesTimeDate td) {
NotesTimeDateStruct.ByValue tdByVal = NotesTimeDateStruct.ByValue.newInstance(td.getInnards());
DisposableMemory retRecurId = new DisposableMemory(NotesConstants.MAXPATH);
try {
short result = NotesNativeAPI.get().CalGetRecurrenceID(tdByVal, retRecurId, (short) ((retRecurId.size()-1) & 0xffff));
NotesErrorUtils.checkResult(result);
String recurId = NotesStringUtils.fromLMBCS(retRecurId, -1);
return recurId;
}
finally {
retRecurId.dispose();
}
}
/**
* Retrieve the unapplied notices that exist for a participant of calendar entry representing a meeting.
*
* This will return things like: Reschedules, informational updates, cancelations, confirmations, etc.
*
* Notices will only be returned if the initial invitation has already been responded to, otherwise
* this method will return ERR_INVITE_NOT_ACCEPTED.
*
* For recurring meetings, notices that apply to any instances in the series will be returned, with
* the exception of instances where the initial invitation has not yet been responded to.
*
* Calendar entries that are not meetings will return ERR_INVALID_NOTE.
*
* We do not currently support getting unprocessed calendar entries if you are the owner (such as
* a counter proposal request or a request for updated information), so this will return
* ERR_NOT_YET_IMPLEMENTED.
*
* Note: For recurring meetings, it is possible that multiple notices will contain current information
* for a particular occurence, so it is not possible to guarantee that there is a single "most current"
* notice.
*
* For example, the subject might be changed for a single instance, and then the time may be changed
* across instances.
*
* Because only one notice will have the current subject and another notice will have the current
* time but NOT the current subject, both notices will be returned and both must be processed to
* guarantee accuracy.
*
* Process returned notices via the CalNoticeAction method.
*
* @param dbMail The database to search for calendar entries
* @param uid The UID of the entry to return notices for.
* @param retNoteIds return list of note ids or NULL
* @param retUNIDs return list of UNIDs or NULL
* @return number of notices
*/
public static int getUnappliedNotices(NotesDatabase dbMail, String uid, List retNoteIds, List retUNIDs) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
short result;
ShortByReference retNumNotices = new ShortByReference();
if (PlatformUtils.is64Bit()) {
LongByReference phRetNOTEIDs = retNoteIds==null ? null : new LongByReference();
LongByReference phRetUNIDs = retUNIDs==null ? null : new LongByReference();
result = NotesNativeAPI64.get().CalGetUnappliedNotices(dbMail.getHandle64(), uidMem,
retNumNotices, phRetNOTEIDs, phRetUNIDs, null, 0, null);
NotesErrorUtils.checkResult(result);
int numNotices = (int) (retNumNotices.getValue() & 0xffff);
if (numNotices>0) {
long hRetNOTEIDs = phRetNOTEIDs.getValue();
if (hRetNOTEIDs!=0) {
Pointer ptrNoteIds = Mem64.OSMemoryLock(hRetNOTEIDs);
try {
for (int i=0; i0) {
if (retNoteIds!=null) {
int hRetNOTEIDs = phRetNOTEIDs.getValue();
if (hRetNOTEIDs!=0) {
Pointer ptrNoteIds = Mem32.OSMemoryLock(hRetNOTEIDs);
try {
for (int i=0; i
*
* This returns the number of new invitations as well as optional NOTEID and/or UNID lists.
* This returns only invitations (and delegated invitations), and not reschedules, information
* updates, cancels, etc.
*
* This method does not filter out any invitations that have since been canceled/rescheduled,
* or are otherwise out of date.
*
* Once the invitation is accepted, other notices that apply to that meeting can be discovered
* with a call to {@link #getUnappliedNotices(NotesDatabase, String, List, List)}
* must be used (on a per-UID level).
* Only invitations for meetings that are current (at least one instance starts within the
* last day or in the future) are returned, although the starting time can be specified by
* the caller to override the default.A caller can retrieve only invitations that have arrived
* since a prior call to {@link #getNewInvitations(NotesDatabase, NotesTimeDate, String, NotesTimeDate, NotesTimeDate, List, List)}
* by using tdSince and ptdretUntil.If uid is provided, invitations only for a
* particular meeting will be returned.
*
* This is useful if you are looking for an invitation or invitations that correspond to an
* updated notice that has arrived.
*
* Note: Multiple invitations might exist for a particular UID if that meeting is recurring
* and you were added to an instance or instances after the initial creation.
* The returned notices are not guaranteed to be in any particular order.
*
* @param dbMail The database from which entries are returned.
* @param tdStart Optional: If provided, only invitations for meetings that occur on or after this time will be returned.Passing in NULL will use the default value (one day before current time).
* @param uid Optional: If present only invitations with a matching UID will be returned. Note: For some repeating meetings there could be multiple invites for the same UID (for separate instances).
* @param tdSince Optional: Only return invitations that have been received/modified since the provided time.Passing in NULL will return invitations regardless of when they arrived.
* @param retUntil Optional: If provided, this is populated with the time of this method call, which can then be used as the ptdSince argument of a subsequent call.
* @param retNoteIds return list of note ids or NULL
* @param retUNIDs return list of UNIDs or NULL
* @return number of invitations
*/
public static int getNewInvitations(NotesDatabase dbMail, NotesTimeDate tdStart, String uid, NotesTimeDate tdSince,
NotesTimeDate retUntil, List retNoteIds, List retUNIDs) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
NotesTimeDateStruct tdStartStruct = tdStart==null ? null : NotesTimeDateStruct.newInstance(tdStart.getInnards());
NotesTimeDateStruct tdSinceStruct = tdSince==null ? null : NotesTimeDateStruct.newInstance(tdSince.getInnards());
NotesTimeDateStruct retTdUntilStruct = retUntil==null ? null : NotesTimeDateStruct.newInstance();
ShortByReference retNumInvites = new ShortByReference();
short result;
if (PlatformUtils.is64Bit()) {
LongByReference phRetNOTEIDs = retNoteIds==null ? null : new LongByReference();
LongByReference phRetUNIDs = retUNIDs==null ? null : new LongByReference();
result = NotesNativeAPI64.get().CalGetNewInvitations(dbMail.getHandle64(), tdStartStruct,
uidMem, tdSinceStruct,
retTdUntilStruct, retNumInvites, phRetNOTEIDs, phRetUNIDs, null, 0, null);
NotesErrorUtils.checkResult(result);
if (retUntil!=null) {
retTdUntilStruct.read();
retUntil.setTime(retTdUntilStruct.Innards);
}
int numInvites = (int) (retNumInvites.getValue() & 0xffff);
if (numInvites>0) {
if (retNoteIds!=null) {
long hRetNOTEIDs = phRetNOTEIDs.getValue();
if (hRetNOTEIDs!=0) {
Pointer ptrNoteIds = Mem64.OSMemoryLock(hRetNOTEIDs);
try {
for (int i=0; i0) {
if (retNoteIds!=null) {
int hRetNOTEIDs = phRetNOTEIDs.getValue();
if (hRetNOTEIDs!=0) {
Pointer ptrNoteIds = Mem32.OSMemoryLock(hRetNOTEIDs);
try {
for (int i=0; i
*
* A notice may not yet be applied to the calendar entries itself, but an application
* may want to read the notice (and process it).
*
* Examples of notices include invitations, reschedules, information updates, confirmations,
* cancelations, counterproposals, requests for information, acceptances, declines,
* tenative acceptances, etc.
*
* @param dbMail The database from which entries are returned.
* @param noteId The NOTEID of the notice to be returned.
* @param flags {@link CalendarRead} flags to control non-default behavior. Supported: {@link CalendarRead#HIDE_X_LOTUS}, {@link CalendarRead#INCLUDE_X_LOTUS}.
* @return iCalendar data
*/
public static String readNotice(NotesDatabase dbMail, int noteId, EnumSet flags) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
int dwFlags = flags==null ? 0 : CalendarRead.toBitMask(flags);
String retIcal = null;
short result;
if (PlatformUtils.is64Bit()) {
LongByReference hRetCalData = new LongByReference();
result = NotesNativeAPI64.get().CalReadNotice(dbMail.getHandle64(), noteId, hRetCalData, null, dwFlags, null);
NotesErrorUtils.checkResult(result);
long hRetCalDataLong = hRetCalData.getValue();
if (hRetCalDataLong!=0) {
Pointer retUIDPtr = Mem64.OSMemoryLock(hRetCalDataLong);
try {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
finally {
Mem64.OSMemoryUnlock(hRetCalDataLong);
Mem64.OSMemoryFree(hRetCalDataLong);
}
}
}
else {
IntByReference hRetCalData = new IntByReference();
result = NotesNativeAPI32.get().CalReadNotice(dbMail.getHandle32(), noteId, hRetCalData, null, dwFlags, null);
NotesErrorUtils.checkResult(result);
int hRetCalDataInt = hRetCalData.getValue();
if (hRetCalDataInt!=0) {
Pointer retUIDPtr = Mem32.OSMemoryLock(hRetCalDataInt);
try {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
finally {
Mem32.OSMemoryUnlock(hRetCalDataInt);
Mem32.OSMemoryFree(hRetCalDataInt);
}
}
}
return retIcal;
}
/**
* This will return iCalendar data representing a notice with the specified NOTIED.
*
* A notice may not yet be applied to the calendar entries itself, but an application
* may want to read the notice (and process it).
*
* Examples of notices include invitations, reschedules, information updates, confirmations,
* cancelations, counterproposals, requests for information, acceptances, declines,
* tenative acceptances, etc.
*
* @param dbMail The database from which entries are returned.
* @param unid The UNID of the notice to be returned.
* @param flags {@link CalendarRead} flags to control non-default behavior. Supported: {@link CalendarRead#HIDE_X_LOTUS}, {@link CalendarRead#INCLUDE_X_LOTUS}.
* @return iCalendar data
*/
public static String readNotice(NotesDatabase dbMail, String unid, EnumSet flags) {
if (dbMail.isRecycled())
throw new NotesError(0, "Target database already recycled");
NotesUniversalNoteId unidObj = new NotesUniversalNoteId(unid);
NotesUniversalNoteIdStruct unidStruct = unidObj.getAdapter(NotesUniversalNoteIdStruct.class);
int dwFlags = flags==null ? 0 : CalendarRead.toBitMask(flags);
String retIcal = null;
short result;
if (PlatformUtils.is64Bit()) {
LongByReference hRetCalData = new LongByReference();
result = NotesNativeAPI64.get().CalReadNoticeUNID(dbMail.getHandle64(), unidStruct, hRetCalData, null, dwFlags, null);
NotesErrorUtils.checkResult(result);
long hRetCalDataLong = hRetCalData.getValue();
if (hRetCalDataLong!=0) {
Pointer retUIDPtr = Mem64.OSMemoryLock(hRetCalDataLong);
try {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
finally {
Mem64.OSMemoryUnlock(hRetCalDataLong);
Mem64.OSMemoryFree(hRetCalDataLong);
}
}
}
else {
IntByReference hRetCalData = new IntByReference();
result = NotesNativeAPI32.get().CalReadNoticeUNID(dbMail.getHandle32(), unidStruct, hRetCalData, null, dwFlags, null);
NotesErrorUtils.checkResult(result);
int hRetCalDataInt = hRetCalData.getValue();
if (hRetCalDataInt!=0) {
Pointer retUIDPtr = Mem32.OSMemoryLock(hRetCalDataInt);
try {
retIcal = NotesStringUtils.fromLMBCS(retUIDPtr, -1);
}
finally {
Mem32.OSMemoryUnlock(hRetCalDataInt);
Mem32.OSMemoryFree(hRetCalDataInt);
}
}
}
return retIcal;
}
/**
* Perform an action on a calendar entry.
*
* For instance, change the response of an accepted meeting to counter or delegate.
* This must be applied to meetings (with the exception of {@link CalendarProcess#DELETE},
* which can be applied to any calendar entry).
* This makes the appropriate modifications to the invitee calendar and also sends appropriate notices out.
* @param dbMail The database containing calendar entries to act on
* @param uid The UID of the entry to act on
* @param recurId The RECURRENCE-ID of the instance to act on. May be specified for recurring meetings (omission acts on all). MUST be NULL for single meetings. Timezones not permitted (time values must be in UTC time)
* @param action The action to perform as defined in {@link CalendarProcess} values
* @param scope {@link CalendarRangeRepeat} as defined above (ignored for non-repeating entries)
* @param comment Comments to include on the outgoing notice(s) to organizer or participants (can be NULL).
* @param data Conveys any additional information required to perform action - NULL for actions that do not require additional information to perform, required for {@link CalendarProcess#DELEGATE}, {@link CalendarProcess#DECLINE} and {@link CalendarProcess#COUNTER} and {@link CalendarProcess#UPDATEINVITEES}.
* @param flags Flags - Only {@link CalendarActionOptions#UPDATE_ALL_PARTICIPANTS} is allowed (and only for {@link CalendarProcess#UPDATEINVITEES}
*/
public static void entryAction(NotesDatabase dbMail, String uid, String recurId, EnumSet action,
CalendarRangeRepeat scope, String comment, NotesCalendarActionData data, EnumSet flags) {
NotesCalendarActionDataStruct dataStruct = data==null ? null : data.getAdapter(NotesCalendarActionDataStruct.class);
if (dataStruct!=null) {
System.out.println("Size 1: "+dataStruct.size());
System.out.println("Size 2: "+dataStruct.wLen);
}
short result;
Memory uidMem = NotesStringUtils.toLMBCS(uid, true);
Memory recurIdMem = NotesStringUtils.toLMBCS(recurId, true);
int dwFlags = CalendarActionOptions.toBitMask(flags);
int dwAction = CalendarProcess.toBitMask(action);
int dwRange = scope.getValue();
Memory commentMem = NotesStringUtils.toLMBCS(comment, true);
if (PlatformUtils.is64Bit()) {
result = NotesNativeAPI64.get().CalEntryAction(dbMail.getHandle64(), uidMem, recurIdMem,
dwAction, dwRange, commentMem, dataStruct, dwFlags, null);
}
else {
result = NotesNativeAPI32.get().CalEntryAction(dbMail.getHandle32(), uidMem, recurIdMem,
dwAction, dwRange, commentMem, dataStruct, dwFlags, null);
}
NotesErrorUtils.checkResult(result);
}
/**
* Process a calendar notice.
* This makes the appropriate modifications to the calendar entry and also sends appropriate notices out.
*
* @param dbMail The database containing the notice to act on.
* @param noteId The noteid of the notice to act on.
* @param action The action to perform as defined in {@link CalendarProcess} values.
* @param comment Comments to include on the outgoing notice(s) to organizer or participants (can be NULL).
* @param data Conveys any additional information required to perform action - NULL for actions that do not require additional information to perform, required for {@link CalendarProcess#DELEGATE} and {@link CalendarProcess#COUNTER}
* @param flags Flags - (a {@link CalendarActionOptions} value).
*/
public static void noticeAction(NotesDatabase dbMail, int noteId, EnumSet action,
String comment, NotesCalendarActionData data, EnumSet flags) {
NotesCalendarActionDataStruct dataStruct = data==null ? null : data.getAdapter(NotesCalendarActionDataStruct.class);
short result;
int dwFlags = CalendarActionOptions.toBitMask(flags);
int dwAction = CalendarProcess.toBitMask(action);
Memory commentMem = NotesStringUtils.toLMBCS(comment, true);
if (PlatformUtils.is64Bit()) {
result = NotesNativeAPI64.get().CalNoticeAction(dbMail.getHandle64(), noteId, dwAction,
commentMem, dataStruct, dwFlags, null);
}
else {
result = NotesNativeAPI32.get().CalNoticeAction(dbMail.getHandle32(), noteId, dwAction,
commentMem, dataStruct, dwFlags, null);
}
NotesErrorUtils.checkResult(result);
}
/**
* Process a calendar notice.
* This makes the appropriate modifications to the calendar entry and also sends appropriate notices out.
*
* @param dbMail The database containing the notice to act on.
* @param unid The UNID of the notice to act on
* @param action The action to perform as defined in {@link CalendarProcess} values.
* @param comment Comments to include on the outgoing notice(s) to organizer or participants (can be NULL).
* @param data Conveys any additional information required to perform action - NULL for actions that do not require additional information to perform, required for {@link CalendarProcess#DELEGATE} and {@link CalendarProcess#COUNTER}
* @param flags Flags - (a {@link CalendarActionOptions} value).
*/
public static void noticeAction(NotesDatabase dbMail, String unid, EnumSet action,
String comment, NotesCalendarActionData data, EnumSet flags) {
NotesCalendarActionDataStruct dataStruct = data==null ? null : data.getAdapter(NotesCalendarActionDataStruct.class);
short result;
NotesUniversalNoteId unidObj = new NotesUniversalNoteId(unid);
NotesUniversalNoteIdStruct unidStruct = unidObj.getAdapter(NotesUniversalNoteIdStruct.class);
int dwFlags = CalendarActionOptions.toBitMask(flags);
int dwAction = CalendarProcess.toBitMask(action);
Memory commentMem = NotesStringUtils.toLMBCS(comment, true);
if (PlatformUtils.is64Bit()) {
result = NotesNativeAPI64.get().CalNoticeActionUNID(dbMail.getHandle64(), unidStruct, dwAction,
commentMem, dataStruct, dwFlags, null);
}
else {
result = NotesNativeAPI32.get().CalNoticeActionUNID(dbMail.getHandle32(), unidStruct, dwAction,
commentMem, dataStruct, dwFlags, null);
}
NotesErrorUtils.checkResult(result);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy