net.bluemind.folder.service.internal

Class FolderHierarchyService

java.lang.Object

net.bluemind.folder.service.internal.FolderHierarchyService

All Implemented Interfaces:

IFolderHierarchy, IInternalFolderHierarchy

Direct Known Subclasses:

MailboxFolderHierarchyService

public class FolderHierarchyService
extends java.lang.Object
implements IInternalFolderHierarchy

Field Summary

Fields

Modifier and Type	Field and Description
protected Container	container
protected BmContext	context
protected FolderHierarchyEventProducer	eventProducer
protected FolderHierarchyStore	folderStore
protected static java.util.List<IFolderHook>	hooks
protected static org.slf4j.Logger	logger
protected java.lang.String	mailboxUid
protected SecurityContext	securityContext
protected FolderStoreService	storeService

Constructor Summary

Constructors

Constructor and Description
FolderHierarchyService(BmContext context, Container container, java.lang.String mailboxUid)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allUids()
ItemValue<Folder>	byContentUri(java.lang.String uri)
ItemValue<Folder>	byId(java.lang.Long id)
java.util.List<ItemValue<Folder>>	byParentId(java.lang.Long pid)
ItemValue<Folder>	byUid(java.lang.Long uid)
ContainerChangelog	changelog(java.lang.Long since) ChangeLog of the container since
ContainerChangeset<java.lang.String>	changeset(java.lang.Long since) ChangeSet of the container since
ContainerChangeset<java.lang.Long>	changesetById(java.lang.Long since) ChangeSet of the container since
void	create(java.lang.String uid, Folder folder) Creates a new Folder entry.
ItemValue<Folder>	createFolder(ContainerDescriptor cd, java.lang.Long parentId) Creates a folder corresponding to the given container Not exposed over http
void	delete(java.lang.String uid) Delete Folder entry
void	deleteAll() Delete the entire hierarchy
ItemValue<Folder>	getComplete(java.lang.String uid) Fetch a Folder from its unique uid
protected static java.util.List<IFolderHook>	getHooks()
java.util.List<ItemValue<Folder>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple Folders from theirs uniques uids
void	reset()
ListResult<ItemValue<Folder>>	search(FolderQuery query) Searches for the Folders items in the container using the given query
void	update(java.lang.String uid, Folder folder) Modifies an existing Folder entry.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

folderStore

protected final FolderHierarchyStore folderStore

storeService

protected final FolderStoreService storeService

context

protected final BmContext context

mailboxUid

protected final java.lang.String mailboxUid

securityContext

protected final SecurityContext securityContext

container

protected final Container container

eventProducer

protected final FolderHierarchyEventProducer eventProducer

hooks

protected static final java.util.List<IFolderHook> hooks

Constructor Detail

FolderHierarchyService

public FolderHierarchyService(BmContext context,
                              Container container,
                              java.lang.String mailboxUid)
                       throws ServerFault

Throws:

ServerFault

Method Detail

create

public void create(java.lang.String uid,
                   Folder folder)
            throws ServerFault

Description copied from interface: IInternalFolderHierarchy

Creates a new Folder entry.

Specified by:

create in interface IInternalFolderHierarchy

Parameters:

uid - uid of the entry

folder - value of the entry

Throws:

ServerFault

update

public void update(java.lang.String uid,
                   Folder folder)
            throws ServerFault

Description copied from interface: IInternalFolderHierarchy

Modifies an existing Folder entry.

Specified by:

update in interface IInternalFolderHierarchy

Parameters:

uid - uid of the entry

folder - value of the entry

Throws:

ServerFault

getComplete

public ItemValue<Folder> getComplete(java.lang.String uid)
                              throws ServerFault

Description copied from interface: IFolderHierarchy

Fetch a Folder from its unique uid

Specified by:

getComplete in interface IFolderHierarchy

Returns:

ItemValue

Throws:

ServerFault

multipleGet

public java.util.List<ItemValue<Folder>> multipleGet(java.util.List<java.lang.String> uids)
                                              throws ServerFault

Description copied from interface: IFolderHierarchy

Fetch multiple Folders from theirs uniques uids

Specified by:

multipleGet in interface IFolderHierarchy

Returns:

List>

Throws:

ServerFault

delete

public void delete(java.lang.String uid)
            throws ServerFault

Description copied from interface: IInternalFolderHierarchy

Delete Folder entry

Specified by:

delete in interface IInternalFolderHierarchy

Throws:

ServerFault

deleteAll

public void deleteAll()
               throws ServerFault

Description copied from interface: IInternalFolderHierarchy

Delete the entire hierarchy

Specified by:

deleteAll in interface IInternalFolderHierarchy

Throws:

ServerFault

getHooks

protected static java.util.List<IFolderHook> getHooks()

changelog

public ContainerChangelog changelog(java.lang.Long since)
                             throws ServerFault

Description copied from interface: IFolderHierarchy

ChangeLog of the container since

Specified by:

changelog in interface IFolderHierarchy

Parameters:

since - timestamp of first changes we want to retrieve

Returns:

ContainerChangelog

Throws:

ServerFault

changeset

public ContainerChangeset<java.lang.String> changeset(java.lang.Long since)
                                               throws ServerFault

Description copied from interface: IFolderHierarchy

ChangeSet of the container since

Specified by:

changeset in interface IFolderHierarchy

Parameters:

since - timestamp of first changes we want to retrieve

Throws:

ServerFault

changesetById

public ContainerChangeset<java.lang.Long> changesetById(java.lang.Long since)
                                                 throws ServerFault

Description copied from interface: IFolderHierarchy

ChangeSet of the container since

Specified by:

changesetById in interface IFolderHierarchy

Parameters:

since - timestamp of first changes we want to retrieve

Throws:

ServerFault

byContentUri

public ItemValue<Folder> byContentUri(java.lang.String uri)
                               throws ServerFault

Specified by:

byContentUri in interface IFolderHierarchy

Throws:

ServerFault

byParentId

public java.util.List<ItemValue<Folder>> byParentId(java.lang.Long pid)
                                             throws ServerFault

Specified by:

byParentId in interface IFolderHierarchy

Throws:

ServerFault

byUid

public ItemValue<Folder> byUid(java.lang.Long uid)
                        throws ServerFault

Specified by:

byUid in interface IFolderHierarchy

Throws:

ServerFault

byId

public ItemValue<Folder> byId(java.lang.Long id)
                       throws ServerFault

Specified by:

byId in interface IFolderHierarchy

Throws:

ServerFault

search

public ListResult<ItemValue<Folder>> search(FolderQuery query)
                                     throws ServerFault

Description copied from interface: IFolderHierarchy

Searches for the Folders items in the container using the given query

Specified by:

search in interface IFolderHierarchy

Parameters:

query - the search criteria

Returns:

matching Folder objects

Throws:

ServerFault

createFolder

public ItemValue<Folder> createFolder(ContainerDescriptor cd,
                                      java.lang.Long parentId)
                               throws ServerFault

Description copied from interface: IInternalFolderHierarchy

Creates a folder corresponding to the given container Not exposed over http

Specified by:

createFolder in interface IInternalFolderHierarchy

Parameters:

cd - the container

parentId - the parent id

Returns:

the created folder or null if the container does not require a folder

Throws:

ServerFault

allUids

public java.util.List<java.lang.String> allUids()
                                         throws ServerFault

Specified by:

allUids in interface IFolderHierarchy

Throws:

ServerFault

reset

public void reset()
           throws ServerFault

Specified by:

reset in interface IFolderHierarchy

Throws:

ServerFault