StaticResource (milton-b3p 4.2.1 API)

java.lang.Object
- com.bradmcevoy.http.StaticResource

All Implemented Interfaces:

GetableResource, Resource, Comparable<Resource>
```
public class StaticResource
extends Object
implements GetableResource
```
Used to provide access to static files via Milton For a full implementation of webdav on a filesystem use the milton-filesysten project

Author:

brad

Constructor Summary

Constructors
Constructor and Description

StaticResource(File file, String url, String contentType)

Constructors
Constructor and Description
`StaticResource(File file, String url, String contentType)`

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.
`int`	`compareTo(Resource res)`
`Long`	`getContentLength()` The length of the content in this resource.
`String`	`getContentType(String accepts)` Given a comma seperated listed of preferred content types acceptable for a client, return one content type which is the best.
`Long`	`getMaxAgeSeconds()` How many seconds to allow the content to be cached for, or null if caching is not allowed
`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()`
`void`	`sendContent(OutputStream out, Range range, Map<String,String> params)` If range not null is a Partial content request

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StaticResource
```
public StaticResource(File file,
              String url,
              String contentType)
```
- Method Detail
  - getUniqueId
```
public String getUniqueId()
```
    Specified by:
    
    getUniqueId in interface Resource
    
    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
  - compareTo
```
public int compareTo(Resource res)
```
    Specified by:
    
    compareTo in interface Comparable<Resource>
  - sendContent
```
public void sendContent(OutputStream out,
               Range range,
               Map<String,String> params)
                 throws IOException
```
    Description copied from interface: GetableResource
    
    If range not null is a Partial content request
    
    Specified by:
    
    sendContent in interface GetableResource
    
    Throws:
    
    IOException
  - getName
```
public String getName()
```
    Description copied from interface: Resource
    
    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
    
    Specified by:
    
    getName in interface Resource
    
    Returns:
    - the name of this resource. Ie just the local name, within its folder
  - authenticate
```
public Object authenticate(String user,
                  String password)
```
    Description copied from interface: Resource
    
    Check the given credentials, and return a relevant object if accepted. Returning null indicates credentials were not accpeted
    
    Specified by:
    
    authenticate in interface Resource
    
    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
```
public boolean authorise(Request request,
                Request.Method method,
                Auth auth)
```
    Description copied from interface: Resource
    
    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
    
    Specified by:
    
    authorise in interface Resource
  - getRealm
```
public String getRealm()
```
    Description copied from interface: Resource
    
    Return the security realm for this resource. Just any string identifier
    
    Specified by:
    
    getRealm in interface Resource
  - getModifiedDate
```
public Date getModifiedDate()
```
    Description copied from interface: Resource
    
    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
    
    Specified by:
    
    getModifiedDate in interface Resource
  - getContentLength
```
public Long getContentLength()
```
    Description copied from interface: GetableResource
    
    The length of the content in this resource. If unknown return nnull
    
    Specified by:
    
    getContentLength in interface GetableResource
  - getContentType
```
public String getContentType(String accepts)
```
    Description copied from interface: GetableResource
    
    Given a comma seperated listed of preferred content types acceptable for a client, return one content type which is the best. Returns the most preferred MIME type. Eg text/html, image/jpeg, etc Must be IANA registered accepts is the accepts header. Eg: Accept: text/*, text/html, text/html;level=1 See - http://www.iana.org/assignments/media-types/ for a list of content types See - http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html for details about the accept header If you can't handle accepts interpretation, just return a single content type - Eg text/html
    
    Specified by:
    
    getContentType in interface GetableResource
  - checkRedirect
```
public String checkRedirect(Request request)
```
    Description copied from interface: Resource
    
    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
    
    Specified by:
    
    checkRedirect in interface Resource
  - getMaxAgeSeconds
```
public Long getMaxAgeSeconds()
```
    Description copied from interface: GetableResource
    
    How many seconds to allow the content to be cached for, or null if caching is not allowed
    
    Specified by:
    
    getMaxAgeSeconds in interface GetableResource

Class StaticResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StaticResource

Method Detail

getUniqueId

compareTo

sendContent

getName

authenticate

authorise

getRealm

getModifiedDate

getContentLength

getContentType

checkRedirect

getMaxAgeSeconds