io.milton.http.annotated

Class AnnoCollectionResource

java.lang.Object

io.milton.http.annotated.AnnoResource

io.milton.http.annotated.AnnoCollectionResource

All Implemented Interfaces:

CommonResource, ConditionalCompatibleResource, AccessControlledResource, CollectionResource, CopyableResource, DeletableCollectionResource, DeletableResource, DigestResource, DisplayNameResource, ExtMakeCalendarResource, GetableResource, LockableResource, LockingCollectionResource, MakeCollectionableResource, MoveableResource, PostableResource, PropFindableResource, PutableResource, ReportableResource, Resource

Direct Known Subclasses:

AnnoAddressBookResource, AnnoCalendarHomeResource, AnnoCalendarResource, AnnoPrincipalResource, AnnoSchedulingInboxResource

public class AnnoCollectionResource
extends AnnoResource
implements CollectionResource, PutableResource, MakeCollectionableResource, LockingCollectionResource, DeletableCollectionResource, ExtMakeCalendarResource

Placeholder object to represent a node in an annotations hierachy acting as a collection A source object (ie your pojo) is considered a collection if it can have children , ie if there exists at least one @ChildOf or @ChildrenOf method which has that object as its source type. Note this is keyed on the class. This class includes methods suitable for use in page templating logic for navigating through the hierarchy.

Author:

brad

Nested Class Summary

Nested classes/interfaces inherited from interface io.milton.resource.AccessControlledResource

AccessControlledResource.Priviledge

Field Summary

Fields inherited from class io.milton.http.annotated.AnnoResource

acl, annoFactory, jsonResult, nameOverride, parent, realm, source

Fields inherited from interface io.milton.resource.AccessControlledResource

NONE, READ_BROWSE, READ_CONTENT, READ_WRITE

Constructor Summary

Constructors

Constructor and Description
AnnoCollectionResource(AnnotationResourceFactory outer, Object source, AnnoCollectionResource parent)

Method Summary

Modifier and Type	Method and Description
Resource	child(String childName)
LockToken	createAndLock(String name, LockTimeout timeout, LockInfo lockInfo)
CollectionResource	createCalendar(String newName, Map<QName,String> fieldsToSet)
CollectionResource	createCollection(String newName)
Resource	createNew(String newName, InputStream inputStream, Long length, String contentType)
Resource	find(String s)
protected ResourceList	findChildren(boolean isChildLookup)
Resource	findPath(Path p) Locate a resource from the given path evaluated relative to this resource.
List<? extends Resource>	getChildren()
List<? extends Resource>	getChildren(boolean isChildLookup)
Map<String,CommonResource>	getChildrenMap()
Map<String,ResourceList>	getChildrenOfType()
ResourceList	getFiles()
ResourceList	getResourceList()
AnnoCollectionResource	getRoot()
ResourceList	getSubFolders()
protected void	initChildren(boolean isChildLookup) Called when the children list is first accessed This will create the children ResourceList and populate it with known child resources
boolean	isLockedOutRecursive(Request request)

Methods inherited from class io.milton.http.annotated.AnnoResource

authenticate, authenticate, authorise, checkRedirect, copyTo, delete, getAccessControlList, getAnnoFactory, getAsList, getContentLength, getContentType, getContentType, getCreateDate, getCurrentLock, getDisplayName, getHref, getLink, getMaxAgeSeconds, getModifiedDate, getName, getNameOverride, getParent, getPrincipalCollectionHrefs, getPrincipalURL, getPriviledges, getRealm, getSource, getUniqueId, is, isCompatible, isDigestAllowed, lock, moveTo, processForm, refreshLock, sendContent, setAccessControlList, setDisplayName, setNameOverride, unlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.milton.resource.LockableResource

getCurrentLock, lock, refreshLock, unlock

Methods inherited from interface io.milton.resource.DeletableResource

delete

Methods inherited from interface io.milton.resource.Resource

authenticate, authorise, checkRedirect, getModifiedDate, getName, getRealm, getUniqueId

Constructor Detail

AnnoCollectionResource

public AnnoCollectionResource(AnnotationResourceFactory outer,
                              Object source,
                              AnnoCollectionResource parent)

Method Detail

child

public Resource child(String childName)
               throws NotAuthorizedException,
                      BadRequestException

Specified by:

child in interface CollectionResource

Throws:

NotAuthorizedException

BadRequestException

getChildren

public List<? extends Resource> getChildren()
                                     throws NotAuthorizedException,
                                            BadRequestException

Specified by:

getChildren in interface CollectionResource

Throws:

NotAuthorizedException

BadRequestException

getChildren

public List<? extends Resource> getChildren(boolean isChildLookup)
                                     throws NotAuthorizedException,
                                            BadRequestException

Throws:

NotAuthorizedException

BadRequestException

getResourceList

public ResourceList getResourceList()
                             throws NotAuthorizedException,
                                    BadRequestException

Throws:

NotAuthorizedException

BadRequestException

getSubFolders

public ResourceList getSubFolders()
                           throws NotAuthorizedException,
                                  BadRequestException

Throws:

NotAuthorizedException

BadRequestException

getFiles

public ResourceList getFiles()
                      throws NotAuthorizedException,
                             BadRequestException

Throws:

NotAuthorizedException

BadRequestException

findChildren

protected ResourceList findChildren(boolean isChildLookup)
                             throws NotAuthorizedException,
                                    BadRequestException

Throws:

NotAuthorizedException

BadRequestException

initChildren

protected void initChildren(boolean isChildLookup)
                     throws NotAuthorizedException,
                            BadRequestException

Called when the children list is first accessed This will create the children ResourceList and populate it with known child resources

Parameters:

isChildLookup - - indicates this is being called in the context of a call to load a single child by name

Throws:

NotAuthorizedException

BadRequestException

getChildrenMap

public Map<String,CommonResource> getChildrenMap()
                                          throws NotAuthorizedException,
                                                 BadRequestException

Throws:

NotAuthorizedException

BadRequestException

getChildrenOfType

public Map<String,ResourceList> getChildrenOfType()
                                           throws NotAuthorizedException,
                                                  BadRequestException

Throws:

NotAuthorizedException

BadRequestException

createCollection

public CollectionResource createCollection(String newName)
                                    throws NotAuthorizedException,
                                           ConflictException,
                                           BadRequestException

Specified by:

createCollection in interface MakeCollectionableResource

Throws:

NotAuthorizedException

ConflictException

BadRequestException

createCalendar

public CollectionResource createCalendar(String newName,
                                         Map<QName,String> fieldsToSet)
                                  throws NotAuthorizedException,
                                         ConflictException,
                                         BadRequestException

Specified by:

createCalendar in interface ExtMakeCalendarResource

Throws:

NotAuthorizedException

ConflictException

BadRequestException

createNew

public Resource createNew(String newName,
                          InputStream inputStream,
                          Long length,
                          String contentType)
                   throws IOException,
                          ConflictException,
                          NotAuthorizedException,
                          BadRequestException

Specified by:

createNew in interface PutableResource

Throws:

IOException

ConflictException

NotAuthorizedException

BadRequestException

getRoot

public AnnoCollectionResource getRoot()

Overrides:

getRoot in class AnnoResource

createAndLock

public LockToken createAndLock(String name,
                               LockTimeout timeout,
                               LockInfo lockInfo)
                        throws NotAuthorizedException

Specified by:

createAndLock in interface LockingCollectionResource

Throws:

NotAuthorizedException

isLockedOutRecursive

public boolean isLockedOutRecursive(Request request)

Specified by:

isLockedOutRecursive in interface DeletableCollectionResource

find

public Resource find(String s)
              throws NotAuthorizedException,
                     BadRequestException

Throws:

NotAuthorizedException

BadRequestException

findPath

public Resource findPath(Path p)
                  throws NotAuthorizedException,
                         BadRequestException

Locate a resource from the given path evaluated relative to this resource. Supports ".." and "." segments, any other strings are considered file names

Parameters:

p -

Returns:

Throws:

NotAuthorizedException

BadRequestException