org.bedework.calsvci

Interface SharingI

All Superinterfaces:

Serializable

public interface SharingI
extends Serializable

Interface for handling bedework sharing - looks like Apple sharing.

Author:

Mike Douglass

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SharingI.ReplyResult
static class	SharingI.SubscribeResult

Method Summary

Modifier and Type	Method and Description
void	delete(BwCalendar col) Do any cleanup necessary for a collection delete.
org.bedework.caldav.util.sharing.InviteType	getInviteStatus(BwCalendar col)
void	publish(BwCalendar col) Publish the collection - that is make it available for subscriptions.
SharingI.ReplyResult	reply(BwCalendar col, org.bedework.caldav.util.sharing.InviteReplyType reply)
org.bedework.caldav.util.sharing.ShareResultType	share(BwCalendar col, org.bedework.caldav.util.sharing.ShareType share)
org.bedework.caldav.util.sharing.ShareResultType	share(String principalHref, BwCalendar col, org.bedework.caldav.util.sharing.ShareType share)
SharingI.SubscribeResult	subscribe(String colPath, String subscribedName) Subscribe to the collection - must be a published collection.
SharingI.SubscribeResult	subscribeExternal(String extUrl, String subscribedName, int refresh, String remoteId, String remotePw) Subscribe to an external url.
void	unpublish(BwCalendar col) Unpublish the collection - that is make it unavailable for subscriptions and remove any existing subscriptions.
void	unsubscribe(BwCalendar col) Unsubscribe the collection - that is col MUST be an alias to another collection.

Method Detail

share

org.bedework.caldav.util.sharing.ShareResultType share(String principalHref,
                                                       BwCalendar col,
                                                       org.bedework.caldav.util.sharing.ShareType share)
                                                throws CalFacadeException

Parameters:

principalHref - share as this user.

col - MUST be a sharable collection

share - the request

Returns:

list of ok and !ok sharees

Throws:

CalFacadeException - on fatal error

share

org.bedework.caldav.util.sharing.ShareResultType share(BwCalendar col,
                                                       org.bedework.caldav.util.sharing.ShareType share)
                                                throws CalFacadeException

Parameters:

col - MUST be a sharable collection

share - the request

Returns:

list of ok and !ok sharees

Throws:

CalFacadeException - on fatal error

reply

SharingI.ReplyResult reply(BwCalendar col,
                           org.bedework.caldav.util.sharing.InviteReplyType reply)
                    throws CalFacadeException

Parameters:

col - MUST be current sharees home

reply - the request

Returns:

a ReplyResult object.

Throws:

CalFacadeException - on fatal error

getInviteStatus

org.bedework.caldav.util.sharing.InviteType getInviteStatus(BwCalendar col)
                                                     throws CalFacadeException

Parameters:

col - to check

Returns:

current invitations

Throws:

CalFacadeException - on fatal error

delete

void delete(BwCalendar col)
     throws CalFacadeException

Do any cleanup necessary for a collection delete.

Parameters:

col - to delete

Throws:

CalFacadeException - on fatal error

publish

void publish(BwCalendar col)
      throws CalFacadeException

Publish the collection - that is make it available for subscriptions.

Parameters:

col - to publish

Throws:

CalFacadeException - on fatal error

unpublish

void unpublish(BwCalendar col)
        throws CalFacadeException

Unpublish the collection - that is make it unavailable for subscriptions and remove any existing subscriptions.

Parameters:

col - to unpublish

Throws:

CalFacadeException - on fatal error

subscribe

SharingI.SubscribeResult subscribe(String colPath,
                                   String subscribedName)
                            throws CalFacadeException

Subscribe to the collection - must be a published collection.

Parameters:

colPath - of collection

subscribedName - name for new alias

Returns:

path of new alias and flag

Throws:

CalFacadeException - on fatal error

subscribeExternal

SharingI.SubscribeResult subscribeExternal(String extUrl,
                                           String subscribedName,
                                           int refresh,
                                           String remoteId,
                                           String remotePw)
                                    throws CalFacadeException

Subscribe to an external url.

Parameters:

extUrl - external url

subscribedName - name for new alias

refresh - - refresh rate in minutes <= 0 for default

remoteId - - may be null

remotePw - - may be null

Returns:

path of new alias and flag

Throws:

CalFacadeException - on fatal error

unsubscribe

void unsubscribe(BwCalendar col)
          throws CalFacadeException

Unsubscribe the collection - that is col MUST be an alias to another collection. Update any existing invite status for the current principal.

Parameters:

col - alias to unsubscribe

Throws:

CalFacadeException - on fatal error