net.fortuna.ical4j.connector.jcr

Class AbstractJcrObjectStore<C extends AbstractJcrObjectCollection<?>>

java.lang.Object

net.fortuna.ical4j.connector.jcr.AbstractJcrObjectStore<C>

Type Parameters:

C - the supported collection type

All Implemented Interfaces:

ObjectStore<C>

Direct Known Subclasses:

JcrCalendarStore, JcrCardStore

public abstract class AbstractJcrObjectStore<C extends AbstractJcrObjectCollection<?>>
extends Object
implements ObjectStore<C>

Author:

Ben Created on: 23/01/2009 $Id$

Constructor Summary

Constructors

Constructor and Description
AbstractJcrObjectStore(javax.jcr.Repository repository, String path, org.jcrom.Jcrom jcrom)

Method Summary

Methods

Modifier and Type	Method and Description
C	addCollection(String name) Adds the specified collection to the store.
C	addCollection(String name, String displayName, String description, String[] supportedComponents, net.fortuna.ical4j.model.Calendar timezone)
protected void	assertConnected()
boolean	connect() Connect to a object store anonymously.
boolean	connect(String username, char[] password) Connect to a object store using the specified credentials.
void	disconnect()
C	getCollection(String name)
protected abstract AbstractJcrObjectCollectionDao<C>	getCollectionDao()
List<C>	getCollections()
boolean	isConnected()
protected abstract C	newCollection()
C	removeCollection(String name) Removes the collection with specified id from the store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJcrObjectStore

public AbstractJcrObjectStore(javax.jcr.Repository repository,
                      String path,
                      org.jcrom.Jcrom jcrom)

Parameters:

repository - a repository instance

path - a repository store path

jcrom - a JCROM instance

Method Detail

connect

public final boolean connect()
                      throws ObjectStoreException

Connect to a object store anonymously.

Specified by:

connect in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

Returns:

true if connection is successful, otherwise false

Throws:

ObjectStoreException - where an unexpected error occurs

connect

public final boolean connect(String username,
              char[] password)
                      throws ObjectStoreException

Connect to a object store using the specified credentials.

Specified by:

connect in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

Parameters:

username - connection username

password - connection password

Returns:

true if connection is successful, otherwise false

Throws:

ObjectStoreException - where an unexpected error occurs

disconnect

public final void disconnect()
                      throws ObjectStoreException

Specified by:

disconnect in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

Throws:

ObjectStoreException - where an unexpected error occurs

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

addCollection

public final C addCollection(String name)
                                                             throws ObjectStoreException

Adds the specified collection to the store.

Specified by:

addCollection in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

Parameters:

name - a collection identifier

Returns:

the new collection instance

Throws:

ObjectStoreException - if a calendar with the specified id already exists in the store

addCollection

public final C addCollection(String name,
              String displayName,
              String description,
              String[] supportedComponents,
              net.fortuna.ical4j.model.Calendar timezone)
                                                             throws ObjectStoreException

Specified by:

addCollection in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

Parameters:

name - a collection identifier

displayName - the collection name

description - the collection description

supportedComponents - supported collection objects

timezone - collection timezone

Returns:

the new collection instance

Throws:

ObjectStoreException - where an unexpected error occurs

getCollection

public final C getCollection(String name)
                                                             throws ObjectStoreException,
                                                                    ObjectNotFoundException

Specified by:

getCollection in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

Parameters:

name - a collection identifier

Returns:

an object collection with the specified id. If no collection with the specified id is found in this store, an ObjectNotFoundException is thrown.

Throws:

ObjectStoreException - where an unexpected error occurs

ObjectNotFoundException - if a collection with the specified identifier doesn't exist

getCollections

public List<C> getCollections()
                                                              throws ObjectStoreException,
                                                                     ObjectNotFoundException

Specified by:

getCollections in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

Throws:

ObjectStoreException

ObjectNotFoundException

removeCollection

public final C removeCollection(String name)
                                                                throws ObjectStoreException,
                                                                       ObjectNotFoundException

Removes the collection with specified id from the store.

Specified by:

removeCollection in interface ObjectStore<C extends AbstractJcrObjectCollection<?>>

Parameters:

name - a collection identifier

Returns:

if a collection with the specified id exists in the store it is returned. Otherwise returns null.

Throws:

ObjectStoreException - where an unexpected error occurs

ObjectNotFoundException - if a collection with the specified identifier doesn't exist

assertConnected

protected final void assertConnected()
                              throws ObjectStoreException

Throws:

ObjectStoreException - where the store is not connected

newCollection

protected abstract C newCollection()

Returns:

a new collection instance

getCollectionDao

protected abstract AbstractJcrObjectCollectionDao<C> getCollectionDao()

Returns:

the underlying collection DAO