org.norther.tammi.spray.media
Interface ServiceFilter

All Superinterfaces:

AccessController, BranchingFilter, CacheClient, Container, ContainerFilter, ContainerKeyFilter, FallbackMap, FallbackResources, Filter, KeyFilter, LinkFilter, Localizer, PipeFilter, Refreshable, ResourceFilter, ResourceMap, SecureContainerFilter, SecureContainerKeyFilter, SecureFilter

All Known Implementing Classes:

DefaultServiceFilter

public interface ServiceFilter
extends PipeFilter

ServiceFilter extends PipeFilter by providing support for distributing requests to service level filters and pipes.

Author:

Ilkka Priha

Field Summary

Fields inherited from interface org.norther.tammi.acorn.locale.Localizer

ANY_NAME

Method Summary

String	getContentKey() Gets the content filter key.
boolean	isMediaPriority() Checks whether media content has priority over other services.
void	setContentKey(String key) Sets the content filter key.
void	setMediaPriority(boolean flag) Sets whether media content has priority over other services and the content key applied to the requested service instead of the default key when an explicit service is not specified, the path info of the request is not empty and it contains a valid media type extension, which is not terminal's default extension.

Methods inherited from interface org.norther.tammi.spray.filter.LinkFilter

clearLinkAnchors, containsLinkAnchor, getLinkAnchor, getLinkAnchor, getLinkName, indexOfLinkAnchor, linkAnchorMap, linkAnchorMap, removeLinkAnchor, removeLinkAnchor, setLinkAnchor, setLinkAnchor, setLinkName, setLinkName

Methods inherited from interface org.norther.tammi.spray.filter.BranchingFilter

checkPermission, checkPermission, getBranchKey, getDefaultKey, getFilter, setDefaultKey

Methods inherited from interface org.norther.tammi.core.base.Container

clear, containsKey, get, getContainerKey, getContainerKey, getContainerKey, getMBean, getMBeanInterface, getMBeanInterface, getObjectName, getObjectNames, getQueryPattern, registryKeySet, registryKeySet, registryKeySet, registryKeySet, registryMap, registrySize, remove, setMBeanInterface, setQueryPattern, setQueryPattern

Methods inherited from interface javax.servlet.Filter

destroy, doFilter, init

Methods inherited from interface org.norther.tammi.spray.filter.SecureFilter

checkPermission, checkPermission, checkPermission

Methods inherited from interface org.norther.tammi.core.security.AccessController

addAllowedPermission, addDeniedPermission, allowedPermissions, allowedRoleSet, checkPermission, checkPermission, checkPermission, clearAllowedPermissions, clearDeniedPermissions, deniedPermissions, deniedRoleSet, getPermissibleRoles, getPermissibleRoles, getPermissibleRoles, isProtected, removeAllowedPermissions, removeDeniedPermissions, setAllowedPermissions, setDeniedPermissions

Methods inherited from interface javax.servlet.Filter

destroy, doFilter, init

Methods inherited from interface org.norther.tammi.core.base.Container

clear, containsKey, get, getContainerKey, getContainerKey, getContainerKey, getMBean, getMBeanInterface, getMBeanInterface, getObjectName, getObjectNames, getQueryPattern, registryKeySet, registryKeySet, registryKeySet, registryKeySet, registryMap, registrySize, remove, setMBeanInterface, setQueryPattern, setQueryPattern

Methods inherited from interface javax.servlet.Filter

destroy, doFilter, init

Methods inherited from interface org.norther.tammi.spray.filter.KeyFilter

getKey, getKeyValue, getKeyValues, isLinkedKey, setKey, setLinkedKey

Methods inherited from interface javax.servlet.Filter

destroy, doFilter, init

Methods inherited from interface org.norther.tammi.core.locale.ResourceMap

clearResourceBundleNames, getDefaultBaseName, getFallbackResourcesName, getPlugInBaseName, getResourceBundle, getResourceBundle, getResourceBundleName, getResourceFinderName, qualifierSet, removeResourceBundleName, resolveResourceBundle, resolveResourceBundle, resolveResourceBundleName, setDefaultBaseName, setFallbackResourcesName, setResourceBundleName, setResourceFinderName

Methods inherited from interface org.norther.tammi.acorn.locale.Localizer

resolveLocalizedObject, resolveLocalizedObject, resolveLocalizedResource, resolveLocalizedResource, resolveLocalizedString, resolveLocalizedString, resolveLocalizedStrings, resolveLocalizedStrings

Methods inherited from interface org.norther.tammi.core.cache.CacheClient

clearCached, expireCached, expireFraction, getCache, isCachingDisabled, removeCache, setCachingDisabled

Methods inherited from interface org.norther.tammi.core.locale.FallbackResources

getFallbackBaseName, getFallbackBundle, getFallbackBundle, resolveFallbackBundle, resolveFallbackBundle, resolveFallbackBundleName, resolveFallbackResource

Method Detail

getContentKey

String getContentKey()

Gets the content filter key.

Returns:

the content key or null.

setContentKey

void setContentKey(String key)

Sets the content filter key. The content key is applied to media content handled by one of the content filter MBeans.

Parameters:

key - the content key.

isMediaPriority

boolean isMediaPriority()

Checks whether media content has priority over other services.

Returns:

true if priority, false otherwise.

setMediaPriority

void setMediaPriority(boolean flag)

Sets whether media content has priority over other services and the content key applied to the requested service instead of the default key when an explicit service is not specified, the path info of the request is not empty and it contains a valid media type extension, which is not terminal's default extension.

Parameters:

flag - true if priority, false otherwise.