io.milton.http.annotated

Class AnnoResource

java.lang.Object

io.milton.http.annotated.AnnoResource

All Implemented Interfaces:

CommonResource, ConditionalCompatibleResource, AccessControlledResource, CopyableResource, DeletableResource, DigestResource, DisplayNameResource, GetableResource, LockableResource, MoveableResource, PostableResource, PropFindableResource, ReportableResource, Resource

Direct Known Subclasses:

AnnoCollectionResource, AnnoFileResource

public abstract class AnnoResource
extends Object
implements GetableResource, PropFindableResource, DeletableResource, CopyableResource, MoveableResource, LockableResource, ConditionalCompatibleResource, CommonResource, DigestResource, PostableResource, ReportableResource, AccessControlledResource, DisplayNameResource

Author:

brad

Nested Class Summary

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

AccessControlledResource.Priviledge

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<AccessControlledResource.Priviledge>	acl
protected AnnotationResourceFactory	annoFactory
protected JsonResult	jsonResult
protected String	nameOverride
protected AnnoCollectionResource	parent
protected String	realm
protected Object	source

Fields inherited from interface io.milton.resource.AccessControlledResource

NONE, READ_BROWSE, READ_CONTENT, READ_WRITE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Object	authenticate(DigestResponse digestRequest)
Object	authenticate(String user, String password)
boolean	authorise(Request request, Request.Method method, Auth auth)
String	checkRedirect(Request request)
void	copyTo(CollectionResource toCollection, String name)
void	delete()
Map<Principal,List<AccessControlledResource.Priviledge>>	getAccessControlList()
AnnotationResourceFactory	getAnnoFactory()
ResourceList	getAsList()
Long	getContentLength()
String	getContentType()
String	getContentType(String accepts)
Date	getCreateDate()
LockToken	getCurrentLock()
String	getDisplayName()
String	getHref()
String	getLink()
Long	getMaxAgeSeconds(Auth auth)
Date	getModifiedDate()
String	getName()
String	getNameOverride()
AnnoCollectionResource	getParent()
HrefList	getPrincipalCollectionHrefs()
String	getPrincipalURL()
List<AccessControlledResource.Priviledge>	getPriviledges(Auth auth)
String	getRealm()
AnnoCollectionResource	getRoot()
Object	getSource()
String	getUniqueId()
boolean	is(String type)
boolean	isCompatible(Request.Method m) Return whether or not this resource might be compatible with the given HTTP method.
boolean	isDigestAllowed()
LockResult	lock(LockTimeout timeout, LockInfo lockInfo)
void	moveTo(CollectionResource rDest, String name)
String	processForm(Map<String,String> parameters, Map<String,FileItem> files)
LockResult	refreshLock(String token, LockTimeout timeout)
void	sendContent(OutputStream out, Range range, Map<String,String> params, String contentType)
void	setAccessControlList(Map<Principal,List<AccessControlledResource.Priviledge>> privs)
void	setDisplayName(String s)
void	setNameOverride(String nameOverride)
void	unlock(String tokenId)

Methods inherited from class java.lang.Object

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

Field Detail

source

protected Object source

annoFactory

protected final AnnotationResourceFactory annoFactory

parent

protected AnnoCollectionResource parent

jsonResult

protected JsonResult jsonResult

nameOverride

protected String nameOverride

acl

protected Set<AccessControlledResource.Priviledge> acl

realm

protected String realm

Constructor Detail

AnnoResource

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

Method Detail

processForm

public String processForm(Map<String,String> parameters,
                          Map<String,FileItem> files)
                   throws BadRequestException,
                          NotAuthorizedException,
                          ConflictException

Specified by:

processForm in interface PostableResource

Throws:

BadRequestException

NotAuthorizedException

ConflictException

sendContent

public void sendContent(OutputStream out,
                        Range range,
                        Map<String,String> params,
                        String contentType)
                 throws IOException,
                        NotAuthorizedException,
                        BadRequestException,
                        NotFoundException

Specified by:

sendContent in interface GetableResource

Throws:

IOException

NotAuthorizedException

BadRequestException

NotFoundException

getUniqueId

public String getUniqueId()

Specified by:

getUniqueId in interface Resource

getName

public String getName()

Specified by:

getName in interface Resource

authenticate

public Object authenticate(String user,
                           String password)

Specified by:

authenticate in interface Resource

authenticate

public Object authenticate(DigestResponse digestRequest)

Specified by:

authenticate in interface DigestResource

authorise

public boolean authorise(Request request,
                         Request.Method method,
                         Auth auth)

Specified by:

authorise in interface Resource

getRealm

public String getRealm()

Specified by:

getRealm in interface Resource

getModifiedDate

public Date getModifiedDate()

Specified by:

getModifiedDate in interface Resource

checkRedirect

public String checkRedirect(Request request)
                     throws NotAuthorizedException,
                            BadRequestException

Specified by:

checkRedirect in interface Resource

Throws:

NotAuthorizedException

BadRequestException

delete

public void delete()
            throws NotAuthorizedException,
                   ConflictException,
                   BadRequestException

Specified by:

delete in interface DeletableResource

Throws:

NotAuthorizedException

ConflictException

BadRequestException

isCompatible

public boolean isCompatible(Request.Method m)

Description copied from interface: ConditionalCompatibleResource

Return whether or not this resource might be compatible with the given HTTP method. Note that a resource MUST also implement the corresponding milton interface (E.g. GetableResource)

Specified by:

isCompatible in interface ConditionalCompatibleResource

Parameters:

m - - the HTTP method in the current request

Returns:

- false to say that this resource must not handle this request, true to indicate that it might, if it also implements the appropriate method interface

is

public boolean is(String type)

Specified by:

is in interface CommonResource

getCreateDate

public Date getCreateDate()

Specified by:

getCreateDate in interface PropFindableResource

moveTo

public void moveTo(CollectionResource rDest,
                   String name)
            throws ConflictException,
                   NotAuthorizedException,
                   BadRequestException

Specified by:

moveTo in interface MoveableResource

Throws:

ConflictException

NotAuthorizedException

BadRequestException

getSource

public Object getSource()

getAnnoFactory

public AnnotationResourceFactory getAnnoFactory()

getParent

public AnnoCollectionResource getParent()

Specified by:

getParent in interface CommonResource

copyTo

public void copyTo(CollectionResource toCollection,
                   String name)
            throws NotAuthorizedException,
                   BadRequestException,
                   ConflictException

Specified by:

copyTo in interface CopyableResource

Throws:

NotAuthorizedException

BadRequestException

ConflictException

getMaxAgeSeconds

public Long getMaxAgeSeconds(Auth auth)

Specified by:

getMaxAgeSeconds in interface GetableResource

getContentType

public String getContentType(String accepts)

Specified by:

getContentType in interface GetableResource

getContentType

public String getContentType()

getContentLength

public Long getContentLength()

Specified by:

getContentLength in interface GetableResource

isDigestAllowed

public boolean isDigestAllowed()

Specified by:

isDigestAllowed in interface DigestResource

getAsList

public ResourceList getAsList()

getHref

public String getHref()

getRoot

public AnnoCollectionResource getRoot()

getLink

public String getLink()

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface DisplayNameResource

setDisplayName

public void setDisplayName(String s)

Specified by:

setDisplayName in interface DisplayNameResource

lock

public LockResult lock(LockTimeout timeout,
                       LockInfo lockInfo)
                throws NotAuthorizedException,
                       PreConditionFailedException,
                       LockedException

Specified by:

lock in interface LockableResource

Throws:

NotAuthorizedException

PreConditionFailedException

LockedException

refreshLock

public LockResult refreshLock(String token,
                              LockTimeout timeout)
                       throws NotAuthorizedException,
                              PreConditionFailedException

Specified by:

refreshLock in interface LockableResource

Throws:

NotAuthorizedException

PreConditionFailedException

unlock

public void unlock(String tokenId)
            throws NotAuthorizedException,
                   PreConditionFailedException

Specified by:

unlock in interface LockableResource

Throws:

NotAuthorizedException

PreConditionFailedException

getCurrentLock

public LockToken getCurrentLock()

Specified by:

getCurrentLock in interface LockableResource

getNameOverride

public String getNameOverride()

setNameOverride

public void setNameOverride(String nameOverride)

getPrincipalCollectionHrefs

public HrefList getPrincipalCollectionHrefs()

Specified by:

getPrincipalCollectionHrefs in interface AccessControlledResource

getPriviledges

public List<AccessControlledResource.Priviledge> getPriviledges(Auth auth)

Specified by:

getPriviledges in interface AccessControlledResource

setAccessControlList

public void setAccessControlList(Map<Principal,List<AccessControlledResource.Priviledge>> privs)

Specified by:

setAccessControlList in interface AccessControlledResource

getAccessControlList

public Map<Principal,List<AccessControlledResource.Priviledge>> getAccessControlList()

Specified by:

getAccessControlList in interface AccessControlledResource

getPrincipalURL

public String getPrincipalURL()

Specified by:

getPrincipalURL in interface AccessControlledResource