org.bedework.calsvci

Interface ResourcesI

All Superinterfaces:

Serializable

public interface ResourcesI
extends Serializable

Interface for handling bedework stored resources.

Usually this will be an attachment but it may also be an image resource or some other type of downloadable resource.

Resources are stored within folders which can be located anywhere in the hierarchy but MUST NOT be calendar collections. This allows us to remain compliant with CalDAV.

Author:

Mike Douglass

Method Summary

Modifier and Type	Method and Description
boolean	copyMove(BwResource val, String to, String name, boolean copy, boolean overwrite) Move or copy the given resource to the destination collection.
void	delete(String path) Delete a resource and content given the path
BwResource	get(String path) Get a resource given the path - does not get content
List<BwResource>	get(String path, int count) Get resources to which this user has access - content is not fetched.
List<BwResource>	getAll(String path) Get resources to which this user has access - content is not fetched.
void	getContent(BwResource val) Retrieve resource content given the resource.
int[]	reindex(BwIndexer indexer, BwIndexer contentIndexer, BwIndexer collectionIndexer) Reindex current users entities
boolean	save(BwResource val, boolean returnIfExists) Save a resource.
boolean	saveNotification(BwResource val) Save a notification resource.
void	update(BwResource val, boolean updateContent) Update a resource.

Method Detail

save

boolean save(BwResource val,
             boolean returnIfExists)
      throws CalFacadeException

Save a resource. The collection MUST exist. The named resource MUST NOT exist.

Parameters:

val - resource with attached content

returnIfExists - false to throw an exception

Returns:

true if created, false if already exists

Throws:

CalFacadeException - for errors including duplicate name

saveNotification

boolean saveNotification(BwResource val)
                  throws CalFacadeException

Save a notification resource. The collection MUST exist and MUST be a notification collection. The named resource MUST NOT exist

Parameters:

val - resource with attached content

Returns:

true if created, false if already exists

Throws:

CalFacadeException - for errors including duplicate name

get

BwResource get(String path)
        throws CalFacadeException

Get a resource given the path - does not get content

Parameters:

path - String path to resource

Returns:

BwResource null for unknown resource

Throws:

CalFacadeException - on fatal error

getContent

void getContent(BwResource val)
         throws CalFacadeException

Retrieve resource content given the resource. It will be set in the resource object

Parameters:

val - BwResource

Throws:

CalFacadeException - on fatal error

getAll

List<BwResource> getAll(String path)
                 throws CalFacadeException

Get resources to which this user has access - content is not fetched.

Parameters:

path - String path to containing collection

Returns:

List of BwResource

Throws:

CalFacadeException - on fatal error

get

List<BwResource> get(String path,
                     int count)
              throws CalFacadeException

Get resources to which this user has access - content is not fetched.

Parameters:

path - String path to containing collection

count - this many

Returns:

List of BwResource

Throws:

CalFacadeException - on fatal error

update

void update(BwResource val,
            boolean updateContent)
     throws CalFacadeException

Update a resource.

Parameters:

val - resource

updateContent - if true we also update the content

Throws:

CalFacadeException - for errors including duplicate name

delete

void delete(String path)
     throws CalFacadeException

Delete a resource and content given the path

Parameters:

path - String path to resource

Throws:

CalFacadeException - on fatal error

copyMove

boolean copyMove(BwResource val,
                 String to,
                 String name,
                 boolean copy,
                 boolean overwrite)
          throws CalFacadeException

Move or copy the given resource to the destination collection.

Parameters:

val - BwResource

to - Path of estination collection

name - String name of new entity

copy - true for copying

overwrite - destination exists

Returns:

true if destination created (i.e. not updated)

Throws:

CalFacadeException - on fatal error

reindex

int[] reindex(BwIndexer indexer,
              BwIndexer contentIndexer,
              BwIndexer collectionIndexer)
       throws CalFacadeException

Reindex current users entities

Parameters:

indexer - to use for this operation

contentIndexer - to use for this operation

collectionIndexer - to use for this operation

Returns:

number of resources and resourcecontents reindexed

Throws:

CalFacadeException - on fatal error