CalSvcI (bw-calendar-engine-api 3.12.5 API)

java.lang.Object
- org.bedework.calsvci.CalSvcI

All Implemented Interfaces:

Serializable, AutoCloseable
```
public abstract class CalSvcI
extends Object
implements AutoCloseable, Serializable
```
This is the service interface to the calendar suite. This will be used by web applications and web services as well as other applications which wish to integrate calendar actions into their interface.
This is a high level interface which carries out commonly used calendar operations which may involve a number of interactions with the underlying database implementation.
Within the bedework system events and todos are treated identically. An entity type field defines which is what and allows filtering based on type of entity. Explicit calls to fetch an event always return the addressed object which may be an event or a todo.
Calls for collections of event objects may include filters to specify which type of entity is desired.

Author:

Mike Douglass douglm rpi.edu

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CalSvcI()

Constructors
Constructor and Description
`CalSvcI()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract void`	`beginTransaction()` Start a (possibly long-running) transaction.
`abstract void`	`changeAccess(BwShareableDbentity ent, Collection<org.bedework.access.Ace> aces, boolean replaceAll)` Change the access to the given calendar entity.
`abstract org.bedework.access.CurrentAccess`	`checkAccess(BwShareableDbentity ent, int desiredAccess, boolean returnResult)` Check the access for the given entity.
`abstract void`	`close()` Call on the way out after handling a request..
`abstract void`	`defaultAccess(BwShareableDbentity ent, org.bedework.access.AceWho who)` Remove any explicit access for the given who to the given calendar entity.
`abstract void`	`dumpDbStats()` Dump db statistics
`abstract void`	`endTransaction()` End a (possibly long-running) transaction.
`abstract BwGroup`	`findGroup(String account, boolean admin)` Find a group given its account name
`abstract void`	`flushAll()` Flush any backend data we may be hanging on to ready for a new sequence of interactions.
`abstract List<IfInfo>`	`getActiveIfInfos()`
`abstract Directories`	`getAdminDirectories()` Get a Groups object for administrators.
`abstract AdminI`	`getAdminHandler()` Obtain an object which handles admin functions
`abstract AuthProperties`	`getAuthProperties()` Return properties about the system that depend on authentication state.
`abstract AuthProperties`	`getAuthProperties(boolean auth)` Return properties about the system that depend on authentication state.
`abstract BasicSystemProperties`	`getBasicSystemProperties()` Return basic properties about the system.
`abstract Blob`	`getBlob(byte[] val)`
`abstract CalendarsI`	`getCalendarsHandler()` Obtain an object which handles calendars
`abstract CalSuitesI`	`getCalSuitesHandler()` Obtain an object which handles calendar suites
`abstract Categories`	`getCategoriesHandler()` Return the categories maintenance object.
`abstract Contacts`	`getContactsHandler()` Return the contacts maintenance object.
`abstract Timestamp`	`getCurrentTimestamp()` Only valid during a transaction.
`abstract Collection<BwStats.StatsEntry>`	`getDbStats()` Get db statistics
`abstract boolean`	`getDbStatsEnabled()`
`abstract Directories`	`getDirectories()` Return an object to handle directory information.
`abstract DumpIntf`	`getDumpHandler()` Obtain a dump handler
`abstract EventsI`	`getEventsHandler()` Obtain an object which handles events
`abstract SimpleFilterParser`	`getFilterParser()` Obtain a filter parser
`abstract FiltersI`	`getFiltersHandler()` Obtain an object which handles filters
`abstract IcalCallback`	`getIcalCallback()`
`abstract IcalCallback`	`getIcalCallback(Boolean timezonesByReference)`
`abstract IfInfo`	`getIfInfo()`
`abstract BwIndexer`	`getIndexer(boolean publick, String docType)`
`abstract BwIndexer`	`getIndexer(BwOwnedDbentity entity)`
`abstract BwIndexer`	`getIndexer(String principal, String docType)`
`abstract BwIndexer`	`getIndexerForReindex(String principal, String docType, String name)` .
`abstract IndexProperties`	`getIndexProperties()` Return properties for indexing.
`abstract Locations`	`getLocationsHandler()` Return the locations maintenance object.
`abstract MailerIntf`	`getMailer()` Get currently configured mailer.
`abstract NotificationProperties`	`getNotificationProperties()` Return notification properties.
`abstract NotificationsI`	`getNotificationsHandler()` Obtain an object which handles notifications
`abstract <T> Iterator<T>`	`getObjectIterator(Class<T> cl)`
`abstract BwPreferences`	`getPreferences(String principalHref)` Fetch the preferences for the given principal href.
`abstract PreferencesI`	`getPrefsHandler()` Obtain an object which handles user preferences
`abstract BwPrincipal`	`getPrincipal()` Returns an object representing the current principal.
`abstract BwPrincipal`	`getPrincipal(String href)` Find the principal with the given href.
`abstract PrincipalInfo`	`getPrincipalInfo()` This structure is set up early during init.
`abstract <T> Iterator<T>`	`getPrincipalObjectIterator(Class<T> cl)`
`abstract byte[]`	`getPublicKey(String domain, String service)` Returns a public key for the given domain and service - either or both of which may be null.
`abstract <T> Iterator<T>`	`getPublicObjectIterator(Class<T> cl)`
`abstract ResourcesI`	`getResourcesHandler()` Obtain an object which handles resources
`abstract RestoreIntf`	`getRestoreHandler()` Obtain a restore handler
`abstract SchedulingI`	`getScheduler()` Get an object which implements scheduling methods.
`abstract SharingI`	`getSharingHandler()` Obtain an object which handles sharing
`abstract BwStats`	`getStats()` Get the current stats
`abstract boolean`	`getSuperUser()`
`abstract SynchI`	`getSynch()` Get an object which interacts with the synch engine.
`abstract SynchReport`	`getSynchReport(String path, String token, int limit, boolean recurse)`
`abstract SysparsI`	`getSysparsHandler()` Obtain an object which handles system parameters
`abstract SystemProperties`	`getSystemProperties()` Return properties about the system.
`abstract UserAuth`	`getUserAuth()` Get an initialised UserAuth object for the current user.
`abstract Directories`	`getUserDirectories()` Get a Groups object for non-admin users.
`abstract long`	`getUserMaxEntitySize()`
`abstract UsersI`	`getUsersHandler()` Obtain an object which handles user objects
`abstract ViewsI`	`getViewsHandler()` Obtain an object which handles views
`abstract void`	`init(CalSvcIPars pars)` (Re)initialise the object for a particular use.
`abstract boolean`	`isOpen()`
`abstract boolean`	`isRolledback()`
`abstract void`	`kill(IfInfo ifInfo)` Kill an errant interface.
`abstract void`	`logStats()` Log the current stats
`abstract BwUnversionedDbentity`	`merge(BwUnversionedDbentity val)` Call to merge an entity with the current database session
`abstract void`	`open()` Signal the start of a sequence of operations.
`abstract void`	`postNotification(SysEventBase ev)` Send a notification event
`abstract void`	`reAttach(BwDbentity val)` Call to reassociate an entity with the current database session
`abstract void`	`removeFromAllPrefs(BwShareableDbentity val)` Remove any refs to this object
`abstract void`	`rollbackTransaction()` Call if there has been an error during an update process.
`abstract void`	`setCalSuite(String name)` Set the calendar suite we are running as.
`abstract void`	`setDbStatsEnabled(boolean enable)` Enable/disable db statistics
`abstract void`	`setState(String val)`
`abstract UpdateFromTimeZonesInfo`	`updateFromTimeZones(String colHref, int limit, boolean checkOnly, UpdateFromTimeZonesInfo info)` Update the system after changes to timezones.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CalSvcI
```
public CalSvcI()
```
- Method Detail
  - init
```
public abstract void init(CalSvcIPars pars)
                   throws CalFacadeException
```
    (Re)initialise the object for a particular use.
    
    Parameters:
    
    pars - Defines the global parameters for the object
    
    Throws:
    
    CalFacadeException
  - getBasicSystemProperties
```
public abstract BasicSystemProperties getBasicSystemProperties()
```
    Return basic properties about the system.
    
    Returns:
    
    BasicSystemProperties object - never null.
  - getAuthProperties
```
public abstract AuthProperties getAuthProperties()
```
    Return properties about the system that depend on authentication state.
    
    Returns:
    
    AuthProperties object - never null.
  - getAuthProperties
```
public abstract AuthProperties getAuthProperties(boolean auth)
```
    Return properties about the system that depend on authentication state.
    
    Parameters:
    
    auth - - true for auth proiperties false for unauth
    
    Returns:
    
    AuthProperties object - never null.
  - getSystemProperties
```
public abstract SystemProperties getSystemProperties()
```
    Return properties about the system.
    
    Returns:
    
    SystemProperties object - never null.
  - getNotificationProperties
```
public abstract NotificationProperties getNotificationProperties()
```
    Return notification properties.
    
    Returns:
    
    NotificationProperties object - never null.
  - getIndexProperties
```
public abstract IndexProperties getIndexProperties()
```
    Return properties for indexing.
    
    Returns:
    
    IndexProperties object - never null.
  - setCalSuite
```
public abstract void setCalSuite(String name)
                          throws CalFacadeException
```
    Set the calendar suite we are running as. Must be running as an unauthenticated user.
    
    Parameters:
    
    name - unique name for the suite
    
    Throws:
    
    CalFacadeException
  - getPrincipalInfo
```
public abstract PrincipalInfo getPrincipalInfo()
```
    This structure is set up early during init. Provides information about the current principal.
    
    Returns:
    
    lots of info
  - getSuperUser
```
public abstract boolean getSuperUser()
```
    Returns:
    
    boolean true if super user
  - getPublicKey
```
public abstract byte[] getPublicKey(String domain,
                                    String service)
                             throws CalFacadeException
```
    Returns a public key for the given domain and service - either or both of which may be null.
    This allows us to have different keys for communication with different domains and for different services. At its simplest, both are ignored and a single key (pair) is used to secure all communications.
    This is used, for example, by iSchedule for DKIM verification.
    In keeping with the DKIM approach,
    - if there are no keys an empty object is returned.
    - To refuse keys for a domain/service return null.
    Parameters:
    
    domain -
    
    service -
    
    Returns:
    
    key, empty key object or null.
    
    Throws:
    
    CalFacadeException
  - getStats
```
public abstract BwStats getStats()
                          throws CalFacadeException
```
    Get the current stats
    
    Returns:
    
    BwStats object
    
    Throws:
    
    CalFacadeException - if not admin
  - setDbStatsEnabled
```
public abstract void setDbStatsEnabled(boolean enable)
                                throws CalFacadeException
```
    Enable/disable db statistics
    
    Parameters:
    
    enable - boolean true to turn on db statistics collection
    
    Throws:
    
    CalFacadeException - if not admin
  - getDbStatsEnabled
```
public abstract boolean getDbStatsEnabled()
                                   throws CalFacadeException
```
    Returns:
    
    boolean true if statistics collection enabled
    
    Throws:
    
    CalFacadeException - if not admin
  - dumpDbStats
```
public abstract void dumpDbStats()
                          throws CalFacadeException
```
    Dump db statistics
    
    Throws:
    
    CalFacadeException - if not admin
  - getDbStats
```
public abstract Collection<BwStats.StatsEntry> getDbStats()
                                                   throws CalFacadeException
```
    Get db statistics
    
    Returns:
    
    Collection of BwStats.StatsEntry objects
    
    Throws:
    
    CalFacadeException - if not admin
  - logStats
```
public abstract void logStats()
                       throws CalFacadeException
```
    Log the current stats
    
    Throws:
    
    CalFacadeException - if not admin
  - getIfInfo
```
public abstract IfInfo getIfInfo()
                          throws CalFacadeException
```
    Returns:
    
    info for this interface
    
    Throws:
    
    CalFacadeException - on fatal error
  - getActiveIfInfos
```
public abstract List<IfInfo> getActiveIfInfos()
                                       throws CalFacadeException
```
    Returns:
    
    list of info about open interfaces
    
    Throws:
    
    CalFacadeException
  - kill
```
public abstract void kill(IfInfo ifInfo)
```
    Kill an errant interface.
    
    Parameters:
    
    ifInfo - IfInfo for process
  - setState
```
public abstract void setState(String val)
                       throws CalFacadeException
```
    Parameters:
    
    val - a hopefully informative message
    
    Throws:
    
    CalFacadeException
  - postNotification
```
public abstract void postNotification(SysEventBase ev)
                               throws CalFacadeException
```
    Send a notification event
    
    Parameters:
    
    ev - - system event
    
    Throws:
    
    CalFacadeException
  - flushAll
```
public abstract void flushAll()
                       throws CalFacadeException
```
    Flush any backend data we may be hanging on to ready for a new sequence of interactions. This is intended to help with web based applications, especially those which follow the action/render url pattern used in portlets.
    A flushAll can discard a back end session allowing open to get a fresh one. close() can then be either a no-op or something like a hibernate disconnect.
    This method should be called before calling open (or after calling close).
    
    Throws:
    
    CalFacadeException
  - open
```
public abstract void open()
                   throws CalFacadeException
```
    Signal the start of a sequence of operations. These overlap transactions in that there may be 0 to many transactions started and ended within an open/close call and many open/close calls within a transaction.
    The open close methods are mainly associated with web style requests and open will usually be called early in the incoming request handling and close will always be called on the way out allowing the interface an opportunity to reacquire (on open) and release (on close) any resources such as connections.
    
    Throws:
    
    CalFacadeException
  - isOpen
```
public abstract boolean isOpen()
```
    Returns:
    
    boolean true if open
  - isRolledback
```
public abstract boolean isRolledback()
                              throws CalFacadeException
```
    Returns:
    
    boolean true if open and rolled back
    
    Throws:
    
    CalFacadeException
  - close
```
public abstract void close()
                    throws CalFacadeException
```
    Call on the way out after handling a request..
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    CalFacadeException
  - beginTransaction
```
public abstract void beginTransaction()
                               throws CalFacadeException
```
    Start a (possibly long-running) transaction. In the web environment this might do nothing. The endTransaction method should in some way check version numbers to detect concurrent updates and fail with an exception.
    
    Throws:
    
    CalFacadeException
  - endTransaction
```
public abstract void endTransaction()
                             throws CalFacadeException
```
    End a (possibly long-running) transaction. In the web environment this should in some way check version numbers to detect concurrent updates and fail with an exception.
    
    Throws:
    
    CalFacadeException
  - rollbackTransaction
```
public abstract void rollbackTransaction()
                                  throws CalFacadeException
```
    Call if there has been an error during an update process.
    
    Throws:
    
    CalFacadeException
  - getCurrentTimestamp
```
public abstract Timestamp getCurrentTimestamp()
                                       throws CalFacadeException
```
    Only valid during a transaction.
    
    Returns:
    
    a timestamp from the db
    
    Throws:
    
    CalFacadeException
  - getBlob
```
public abstract Blob getBlob(byte[] val)
                      throws CalFacadeException
```
    Returns:
    
    a blob
    
    Throws:
    
    CalFacadeException - on fatal error
  - reAttach
```
public abstract void reAttach(BwDbentity val)
                       throws CalFacadeException
```
    Call to reassociate an entity with the current database session
    
    Parameters:
    
    val -
    
    Throws:
    
    CalFacadeException
  - merge
```
public abstract BwUnversionedDbentity merge(BwUnversionedDbentity val)
                                     throws CalFacadeException
```
    Call to merge an entity with the current database session
    
    Parameters:
    
    val -
    
    Returns:
    
    - merged entity
    
    Throws:
    
    CalFacadeException
  - getIcalCallback
```
public abstract IcalCallback getIcalCallback()
```
    Returns:
    
    IcalCallback for ical
  - getIcalCallback
```
public abstract IcalCallback getIcalCallback(Boolean timezonesByReference)
```
  - getDumpHandler
```
public abstract DumpIntf getDumpHandler()
                                 throws CalFacadeException
```
    Obtain a dump handler
    
    Returns:
    
    DumpIntf handler
    
    Throws:
    
    CalFacadeException
  - getRestoreHandler
```
public abstract RestoreIntf getRestoreHandler()
                                       throws CalFacadeException
```
    Obtain a restore handler
    
    Returns:
    
    RestoreIntf handler
    
    Throws:
    
    CalFacadeException
  - getFilterParser
```
public abstract SimpleFilterParser getFilterParser()
```
    Obtain a filter parser
    
    Returns:
    
    SimpleFilterParser handler
  - getSysparsHandler
```
public abstract SysparsI getSysparsHandler()
                                    throws CalFacadeException
```
    Obtain an object which handles system parameters
    
    Returns:
    
    SysparsI handler
    
    Throws:
    
    CalFacadeException
  - getMailer
```
public abstract MailerIntf getMailer()
                              throws CalFacadeException
```
    Get currently configured mailer.
    
    Returns:
    
    MailerIntf object of class in config
    
    Throws:
    
    CalFacadeException
  - getPrefsHandler
```
public abstract PreferencesI getPrefsHandler()
                                      throws CalFacadeException
```
    Obtain an object which handles user preferences
    
    Returns:
    
    PreferencesI preferences handler
    
    Throws:
    
    CalFacadeException
  - getAdminHandler
```
public abstract AdminI getAdminHandler()
                                throws CalFacadeException
```
    Obtain an object which handles admin functions
    
    Returns:
    
    AdminI admin handler
    
    Throws:
    
    CalFacadeException
  - getEventsHandler
```
public abstract EventsI getEventsHandler()
```
    Obtain an object which handles events
    
    Returns:
    
    EventsI events handler
  - getFiltersHandler
```
public abstract FiltersI getFiltersHandler()
```
    Obtain an object which handles filters
    
    Returns:
    
    FiltersI filters handler
  - getCalendarsHandler
```
public abstract CalendarsI getCalendarsHandler()
                                        throws CalFacadeException
```
    Obtain an object which handles calendars
    
    Returns:
    
    CalendarsI calendars handler
    
    Throws:
    
    CalFacadeException
  - getCalSuitesHandler
```
public abstract CalSuitesI getCalSuitesHandler()
                                        throws CalFacadeException
```
    Obtain an object which handles calendar suites
    
    Returns:
    
    CalSuitesI handler
    
    Throws:
    
    CalFacadeException
  - getIndexer
```
public abstract BwIndexer getIndexer(boolean publick,
                                     String docType)
```
    Parameters:
    
    publick - true for public index
    
    Returns:
    
    the indexer
  - getIndexer
```
public abstract BwIndexer getIndexer(String principal,
                                     String docType)
```
    Parameters:
    
    principal - - for given principal
    
    Returns:
    
    the indexer
  - getIndexer
```
public abstract BwIndexer getIndexer(BwOwnedDbentity entity)
```
    Parameters:
    
    entity - may influence choice of indexer
    
    Returns:
    
    BwIndexer
  - getIndexerForReindex
```
public abstract BwIndexer getIndexerForReindex(String principal,
                                               String docType,
                                               String name)
```
    .
    
    Parameters:
    
    principal -
    
    docType -
    
    Returns:
    
    the indexer
  - getNotificationsHandler
```
public abstract NotificationsI getNotificationsHandler()
                                                throws CalFacadeException
```
    Obtain an object which handles notifications
    
    Returns:
    
    NotificationsI notifications handler
    
    Throws:
    
    CalFacadeException
  - getResourcesHandler
```
public abstract ResourcesI getResourcesHandler()
                                        throws CalFacadeException
```
    Obtain an object which handles resources
    
    Returns:
    
    ResourcesI resources handler
    
    Throws:
    
    CalFacadeException
  - getScheduler
```
public abstract SchedulingI getScheduler()
                                  throws CalFacadeException
```
    Get an object which implements scheduling methods.
    
    Returns:
    
    SchedulingI object
    
    Throws:
    
    CalFacadeException
  - getSharingHandler
```
public abstract SharingI getSharingHandler()
                                    throws CalFacadeException
```
    Obtain an object which handles sharing
    
    Returns:
    
    SharingI sharing handler
    
    Throws:
    
    CalFacadeException
  - getSynch
```
public abstract SynchI getSynch()
                         throws CalFacadeException
```
    Get an object which interacts with the synch engine.
    
    Returns:
    
    SynchI object
    
    Throws:
    
    CalFacadeException
  - getUsersHandler
```
public abstract UsersI getUsersHandler()
```
    Obtain an object which handles user objects
    
    Returns:
    
    UsersI handler
  - getViewsHandler
```
public abstract ViewsI getViewsHandler()
                                throws CalFacadeException
```
    Obtain an object which handles views
    
    Returns:
    
    ViewsI handler
    
    Throws:
    
    CalFacadeException
  - getDirectories
```
public abstract Directories getDirectories()
                                    throws CalFacadeException
```
    Return an object to handle directory information. This will be the default object for the current usage, i.e. admin or user.
    
    Returns:
    
    Directories
    
    Throws:
    
    CalFacadeException
  - getUserDirectories
```
public abstract Directories getUserDirectories()
                                        throws CalFacadeException
```
    Get a Groups object for non-admin users.
    
    Returns:
    
    Groups implementation.
    
    Throws:
    
    CalFacadeException
  - getAdminDirectories
```
public abstract Directories getAdminDirectories()
                                         throws CalFacadeException
```
    Get a Groups object for administrators. This allows the admin client to display or manipulate administrator groups.
    
    Returns:
    
    Groups implementation.
    
    Throws:
    
    CalFacadeException
  - getCategoriesHandler
```
public abstract Categories getCategoriesHandler()
```
    Return the categories maintenance object.
    
    Returns:
    
    Categories object
  - getLocationsHandler
```
public abstract Locations getLocationsHandler()
```
    Return the locations maintenance object.
    
    Returns:
    
    Locations
  - getContactsHandler
```
public abstract Contacts getContactsHandler()
```
    Return the contacts maintenance object.
    
    Returns:
    
    Contacts
  - getObjectIterator
```
public abstract <T> Iterator<T> getObjectIterator(Class<T> cl)
```
    Parameters:
    
    cl - Class of objects
    
    Returns:
    
    iterator over all the objects
  - getPrincipalObjectIterator
```
public abstract <T> Iterator<T> getPrincipalObjectIterator(Class<T> cl)
```
    Parameters:
    
    cl - Class of objects
    
    Returns:
    
    iterator over all the objects for current principal
  - getPublicObjectIterator
```
public abstract <T> Iterator<T> getPublicObjectIterator(Class<T> cl)
```
    Parameters:
    
    cl - class of objects
    
    Returns:
    
    iterator over all the public objects
  - getPrincipal
```
public abstract BwPrincipal getPrincipal()
```
    Returns an object representing the current principal.
    
    Returns:
    
    BwPrincipal representing the current principal
  - getPrincipal
```
public abstract BwPrincipal getPrincipal(String href)
                                  throws CalFacadeException
```
    Find the principal with the given href.
    
    Parameters:
    
    href - String principal hierarchy path
    
    Returns:
    
    BwPrincipal representing the principal or null if not there
    
    Throws:
    
    CalFacadeException
  - getUserAuth
```
public abstract UserAuth getUserAuth()
                              throws CalFacadeException
```
    Get an initialised UserAuth object for the current user.
    
    Returns:
    
    UserAuth implementation.
    
    Throws:
    
    CalFacadeException
  - getUserMaxEntitySize
```
public abstract long getUserMaxEntitySize()
                                   throws CalFacadeException
```
    Returns:
    
    System limit or user overrride - bytes.
    
    Throws:
    
    CalFacadeException
  - getPreferences
```
public abstract BwPreferences getPreferences(String principalHref)
                                      throws CalFacadeException
```
    Fetch the preferences for the given principal href.
    
    Parameters:
    
    principalHref -
    
    Returns:
    
    the preferences for the principal
    
    Throws:
    
    CalFacadeException
  - removeFromAllPrefs
```
public abstract void removeFromAllPrefs(BwShareableDbentity val)
                                 throws CalFacadeException
```
    Remove any refs to this object
    
    Parameters:
    
    val -
    
    Throws:
    
    CalFacadeException
  - findGroup
```
public abstract BwGroup findGroup(String account,
                                  boolean admin)
                           throws CalFacadeException
```
    Find a group given its account name
    
    Parameters:
    
    account - String group name
    
    admin - true for an admin group
    
    Returns:
    
    BwGroup group object
    
    Throws:
    
    CalFacadeException - If there's a problem
  - changeAccess
```
public abstract void changeAccess(BwShareableDbentity ent,
                                  Collection<org.bedework.access.Ace> aces,
                                  boolean replaceAll)
                           throws CalFacadeException
```
    Change the access to the given calendar entity.
    
    Parameters:
    
    ent - BwShareableDbentity
    
    aces - Collection of ace
    
    replaceAll - true to replace the entire access list.
    
    Throws:
    
    CalFacadeException
  - defaultAccess
```
public abstract void defaultAccess(BwShareableDbentity ent,
                                   org.bedework.access.AceWho who)
                            throws CalFacadeException
```
    Remove any explicit access for the given who to the given calendar entity.
    
    Parameters:
    
    ent - BwShareableDbentity
    
    who - AceWho
    
    Throws:
    
    CalFacadeException
  - checkAccess
```
public abstract org.bedework.access.CurrentAccess checkAccess(BwShareableDbentity ent,
                                                              int desiredAccess,
                                                              boolean returnResult)
                                                       throws CalFacadeException
```
    Check the access for the given entity. Returns the current access or null or optionally throws a no access exception.
    
    Parameters:
    
    ent -
    
    desiredAccess -
    
    returnResult -
    
    Returns:
    
    CurrentAccess
    
    Throws:
    
    CalFacadeException - if returnResult false and no access
  - getSynchReport
```
public abstract SynchReport getSynchReport(String path,
                                           String token,
                                           int limit,
                                           boolean recurse)
                                    throws CalFacadeException
```
    Parameters:
    
    path -
    
    token -
    
    limit - - negative for no limit on result set size
    
    recurse -
    
    Returns:
    
    report
    
    Throws:
    
    CalFacadeException
  - updateFromTimeZones
```
public abstract UpdateFromTimeZonesInfo updateFromTimeZones(String colHref,
                                                            int limit,
                                                            boolean checkOnly,
                                                            UpdateFromTimeZonesInfo info)
                                                     throws CalFacadeException
```
    Update the system after changes to timezones. This is a lengthy process so the method allows the caller to specify how many updates are to take place before returning.
    To restart the update, call the method again, giving it the result from the last call as a parameter.
    If called again after all events have been checked the process will be redone using timestamps to limit the check to events added or updated since the first check. Keep calling until the number of updated events is zero.
    
    Parameters:
    
    limit - -1 for no limit
    
    checkOnly - don't update if true.
    
    info - null on first call, returned object from previous calls.
    
    Returns:
    
    UpdateFromTimeZonesInfo staus of the update
    
    Throws:
    
    CalFacadeException

Class CalSvcI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CalSvcI

Method Detail

init

getBasicSystemProperties

getAuthProperties

getAuthProperties

getSystemProperties

getNotificationProperties

getIndexProperties

setCalSuite

getPrincipalInfo

getSuperUser

getPublicKey

getStats

setDbStatsEnabled

getDbStatsEnabled

dumpDbStats

getDbStats

logStats

getIfInfo

getActiveIfInfos

kill

setState

postNotification

flushAll

open

isOpen

isRolledback

close

beginTransaction

endTransaction

rollbackTransaction

getCurrentTimestamp

getBlob

reAttach

merge

getIcalCallback

getIcalCallback

getDumpHandler

getRestoreHandler

getFilterParser

getSysparsHandler

getMailer

getPrefsHandler

getAdminHandler

getEventsHandler

getFiltersHandler

getCalendarsHandler

getCalSuitesHandler

getIndexer

getIndexer

getIndexer

getIndexerForReindex

getNotificationsHandler

getResourcesHandler

getScheduler

getSharingHandler

getSynch

getUsersHandler

getViewsHandler

getDirectories

getUserDirectories

getAdminDirectories

getCategoriesHandler

getLocationsHandler

getContactsHandler

getObjectIterator

getPrincipalObjectIterator

getPublicObjectIterator

getPrincipal

getPrincipal

getUserAuth

getUserMaxEntitySize

getPreferences

removeFromAllPrefs