org.norther.tammi.spray.media
Interface MediaProvider

All Known Subinterfaces:
CachedMediaProvider, ServletMediaProvider
All Known Implementing Classes:
DefaultCachedMediaProvider, DefaultMediaProvider, DefaultServletMediaProvider

public interface MediaProvider

An interface to media providers.

Version:
$Id: MediaProvider.java,v 1.5 2009/09/28 15:08:26 cvsimp Exp $
Author:
Ilkka Priha

Method Summary
 void addMediaKey(int index, String key)
          Adds a path finder media key to the specified index.
 void addMediaKey(String key)
          Adds a path finder media key.
 void clearMediaKeys()
          Clears all path finder media keys.
 String getDefaultIndex()
          Gets the default index file.
 String[] getMediaKeys()
          Gets the path finder keys for resolving media paths.
 Resource<?> getResource(String path, boolean localized, ServletRequest request, ServletResponse response, FilterChain chain)
          Gets the media content resource.
 void removeMediaKey(String key)
          Removes a path finder media key.
 void setDefaultIndex(String index)
          Sets the default index file.
 void setMediaKeys(String[] keys)
          Sets the path finder keys for resolving media paths.
 

Method Detail

getMediaKeys

String[] getMediaKeys()
Gets the path finder keys for resolving media paths.

Returns:
the path finder keys.

setMediaKeys

void setMediaKeys(String[] keys)
Sets the path finder keys for resolving media paths. The default key is PathFinder.MEDIA.

Parameters:
keys - an array of path finder keys.

addMediaKey

void addMediaKey(String key)
Adds a path finder media key.

Parameters:
key - the path finder key.

addMediaKey

void addMediaKey(int index,
                 String key)
Adds a path finder media key to the specified index.

Parameters:
index - the key index.
key - the path finder key.

removeMediaKey

void removeMediaKey(String key)
Removes a path finder media key.

Parameters:
key - the path finder key.

clearMediaKeys

void clearMediaKeys()
Clears all path finder media keys.


getDefaultIndex

String getDefaultIndex()
Gets the default index file.

Returns:
the default index file.

setDefaultIndex

void setDefaultIndex(String index)
Sets the default index file.

Parameters:
index - a default index file.

getResource

Resource<?> getResource(String path,
                        boolean localized,
                        ServletRequest request,
                        ServletResponse response,
                        FilterChain chain)
                        throws IOException,
                               ConstructionException,
                               AccessDeniedException
Gets the media content resource.

Parameters:
path - the content path.
localized - the localization option.
request - the servlet request.
response - the servlet response.
chain - the filter chain.
Returns:
the resource source.
Throws:
IOException - on I/O errors.
ConstructionException - on resource errors.
AccessDeniedException - for access restrictions.


Copyright © 2004 The Norther Organization. All rights reserved.