uk.ac.ed.epcc.webapp.servlet.config

Class ServletConfigService

java.lang.Object

uk.ac.ed.epcc.webapp.servlet.config.ServletConfigService

All Implemented Interfaces:

AppContextCleanup, AppContextService<ConfigService>, ConfigService, Contexed

public class ServletConfigService
extends java.lang.Object
implements ConfigService

ConfigService that augments the properties with Servlet InitParams. This needs to be added to the AppContext within the servlet itself after any caching ConfigServices and once the ServletConfig is available.

Constructor Summary

Constructors

Constructor and Description
ServletConfigService(ServletConfig c, AppContext conn)

Method Summary

Modifier and Type	Method and Description
void	addListener(ConfigServiceListener listener) register a ConfigServiceListener
void	cleanup() AppContext is being closed.
void	clearServiceProperties() clear any cached properties.
AppContext	getContext()
java.util.Properties	getServiceProperties() return the set of properties defined by the service
java.lang.Class<? super ConfigService>	getType() Returns the type of service the class should be registered under.
void	setProperty(java.lang.String name, java.lang.String value) Set a property This method is for making persistent changes to the configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletConfigService

public ServletConfigService(ServletConfig c,
                            AppContext conn)

Method Detail

clearServiceProperties

public void clearServiceProperties()

Description copied from interface: ConfigService

clear any cached properties. This will cause the properties to be re-read the next time getServiceProperties is called. Implementations are permitted not to cache data in which case this is a No-op.

Specified by:

clearServiceProperties in interface ConfigService

getServiceProperties

public java.util.Properties getServiceProperties()

Description copied from interface: ConfigService

return the set of properties defined by the service

Specified by:

getServiceProperties in interface ConfigService

Returns:

Properties

getContext

public AppContext getContext()

Specified by:

getContext in interface Contexed

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws java.lang.UnsupportedOperationException

Description copied from interface: ConfigService

Set a property This method is for making persistent changes to the configuration. if the service is not capable of making persistent changes it should forward the request to a nested service or throw an UnsupportedOperationException

Specified by:

setProperty in interface ConfigService

Throws:

java.lang.UnsupportedOperationException

cleanup

public void cleanup()

Description copied from interface: AppContextCleanup

AppContext is being closed. Only use this for cleanup that can't be handled by normal garbage collection or for state which is never returned by reference.

Specified by:

cleanup in interface AppContextCleanup

addListener

public void addListener(ConfigServiceListener listener)

Description copied from interface: ConfigService

register a ConfigServiceListener

Specified by:

addListener in interface ConfigService

getType

public java.lang.Class<? super ConfigService> getType()

Description copied from interface: AppContextService

Returns the type of service the class should be registered under.

Specified by:

getType in interface AppContextService<ConfigService>

Returns:

registration type