org.bedework.calsvci

Interface SynchI

All Superinterfaces:

Serializable

public interface SynchI
extends Serializable

Interface for handling interactions with the synch engine from within bedework.

Author:

Mike Douglass

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SynchI.Connection Represents a synch connection - an opaque object managed by the implementation of this interface

Method Summary

Modifier and Type	Method and Description
CalendarsI.CheckSubscriptionResult	checkSubscription(BwCalendar val) Check the subscription if this is an external subscription.
boolean	getActive() Is synchronization active?
SynchI.Connection	getSynchConnection() Get a connection to the synch server.
BwSynchInfo	getSynchInfo() Returns the synch service information.
CalendarsI.SynchStatusResponse	getSynchStatus(BwCalendar val)
boolean	subscribe(BwCalendar val) Make a default file subscription for the given collection.
boolean	unsubscribe(BwCalendar val, boolean forDelete) Remove a subscription for the given collection.

Method Detail

getActive

boolean getActive()
           throws CalFacadeException

Is synchronization active?

Returns:

true if synchronization active.

Throws:

CalFacadeException

getSynchConnection

SynchI.Connection getSynchConnection()
                              throws CalFacadeException

Get a connection to the synch server.

Returns:

null if synch not active otherwise a connection.

Throws:

CalFacadeException

subscribe

boolean subscribe(BwCalendar val)
           throws CalFacadeException

Make a default file subscription for the given collection.

Parameters:

val - the collection representing the subscription

Returns:

true if subscribed OK.

Throws:

CalFacadeException

getSynchStatus

CalendarsI.SynchStatusResponse getSynchStatus(BwCalendar val)
                                       throws CalFacadeException

Parameters:

val - Collection

Returns:

status - never null.

Throws:

CalFacadeException

checkSubscription

CalendarsI.CheckSubscriptionResult checkSubscription(BwCalendar val)
                                              throws CalFacadeException

Check the subscription if this is an external subscription. Will contact the synch server and check the validity. If there is no subscription on the synch server will attempt to resubscribe.

Parameters:

val - the collection representing the subscription

Returns:

result of call

Throws:

CalFacadeException

unsubscribe

boolean unsubscribe(BwCalendar val,
                    boolean forDelete)
             throws CalFacadeException

Remove a subscription for the given collection.

Parameters:

val - the collection representing the subscription

forDelete - - we're deleting the collection - use Oracle workround

Returns:

true if unsubscribed OK.

Throws:

CalFacadeException

getSynchInfo

BwSynchInfo getSynchInfo()
                  throws CalFacadeException

Returns the synch service information.

Returns:

full synch info

Throws:

CalFacadeException