com.bradmcevoy.http

Interface Resource

All Superinterfaces:

Comparable<Resource>

All Known Subinterfaces:

CollectionResource, CopyableResource, DeletableResource, FileResource, FolderResource, GetableResource, LockableResource, LockingCollectionResource, MakeCollectionableResource, MoveableResource, PostableResource, PropFindableResource, PutableResource

All Known Implementing Classes:

StaticResource

public interface Resource
extends Comparable<Resource>

Implementations should implemenet compareTo as an alphabetic comparison on the name property

Author:

Alienware1

Method Summary

Methods

Modifier and Type	Method and Description
Object	authenticate(String user, String password) Check the given credentials, and return a relevant object if accepted.
boolean	authorise(Request request, Request.Method method, Auth auth) Return true if the current user is permitted to access this resource using the specified method.
String	checkRedirect(Request request) Determine if a redirect is required for this request, and if so return the URL to redirect to.
Date	getModifiedDate() The date and time that this resource, or any part of this resource, was last modified.
String	getName() Note that this name MUST be consistent with URL resolution in your ResourceFactory If they arent consistent Milton will generate a different href in PropFind responses then what clients have request and this will cause either an error or no resources to be displayed
String	getRealm() Return the security realm for this resource.
String	getUniqueId()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getUniqueId

String getUniqueId()

Returns:

- a string which uniquely identifies this resource. This will be used in the ETag header field, and affects caching of resources. Returning a null value is allowed, and disables the ETag field

getName

String getName()

Note that this name MUST be consistent with URL resolution in your ResourceFactory If they arent consistent Milton will generate a different href in PropFind responses then what clients have request and this will cause either an error or no resources to be displayed

Returns:

- the name of this resource. Ie just the local name, within its folder

authenticate

Object authenticate(String user,
                  String password)

Check the given credentials, and return a relevant object if accepted. Returning null indicates credentials were not accpeted

Parameters:

user - - the username provided by the user's agent

password - - the password provided by the user's agent

Returns:

- if credentials are accepted, some object to attach to the Auth object. otherwise null

authorise

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

Return true if the current user is permitted to access this resource using the specified method. Note that the current user may be determined by the Auth associated with the request, or by a seperate, application specific, login mechanism such as a session variable or cookie based system. This method should correctly interpret all such mechanisms The auth given as a parameter will be null if authentication failed. The auth associated with the request will still exist

getRealm

String getRealm()

Return the security realm for this resource. Just any string identifier

getModifiedDate

Date getModifiedDate()

The date and time that this resource, or any part of this resource, was last modified. For dynamic rendered resources this should consider everything which will influence its output. Resources for which no such date can be calculated should return null

checkRedirect

String checkRedirect(Request request)

Determine if a redirect is required for this request, and if so return the URL to redirect to. May be absolute or relative. Called after authorization check but before any method specific processing Return null for no redirect