ariba.ui.aribaweb.util
Class AWResourceManager

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.util.AWResourceManager

All Implemented Interfaces:

AWObject

Direct Known Subclasses:

AWMultiLocaleResourceManager, AWSingleLocaleResourceManager

public abstract class AWResourceManager
extends AWBaseObject

The application-wide manager of resource lookups. AWResourceManagers handle lookup of localized strings, webserver resources, and (packaged) UI templates. AWMultiLocaleResourceManager is the typical concrete master resource manager used by AWConcreteApplication. It, in turn, uses multiple AWSingleLocaleResourceManagers. ResourceManagers support "flattening out" multiple resgistered directories into a single coalesced lookup space, and support unpackaged lookups of packaged resources (via packageResourceNamed(String)) and classes (via classForName(String)).

Field Summary

Fields inherited from class ariba.ui.aribaweb.util.AWBaseObject

AribaHashtableClass, AribaVectorClass, ClassClass, EmptyHashtable, EmptyMap, EmptyVector, False, IntegerClass, JavaHashtableClass, JavaMapClass, JavaVectorClass, LogHandling, NullObject, ObjectClass, StringClass, True, UndefinedObject, UndefinedString, UninitializedRealNumber

Constructor Summary

AWResourceManager()

Method Summary

boolean	cacheEnabled()
abstract AWCharacterEncoding	characterEncoding()
abstract Class	classForName(String className)
abstract void	flush()
AWResourceManager	getBaseResourceManager()
abstract AWImageInfo	imageInfoForName(String imageFilename)
abstract Locale	locale()
abstract String	localizedString(String fileName, String keyName)
abstract String	localizedString(String fileName, String key, String defaultString)
abstract String	localizedString(String filename, String componentName, String keyName, String defaultString)
abstract String	localizedString(String filename, String extension, String componentName, String keyName, String defaultString)
abstract AWResource	packageResourceNamed(String resourceName)
abstract String	pathForResourceNamed(String resourceName) Deprecated. use resource().inputStream() to get contents of file
void	registerPackagedResourceExtension(String extension)
AWResourceManager	resolveBrand(String brandName, String version)
AWResourceManager	resolveBrand(String brandName, String version, boolean shouldCreate)
abstract AWResourceManager	resourceManagerForLocale(Locale locale)
abstract AWResource	resourceNamed(String resourceName)
abstract AWResource	resourceNamed(String resourceName, boolean isBrandable)
abstract AWResource[]	resourcesNamed(String resourceName)
void	setBaseResourceManager(AWResourceManager rm)
void	setCacheEnabled(boolean flag)
abstract void	setSystemDefaultLocale(Locale locale)
abstract AWStringsThunk	strings()
abstract String	urlForResourceNamed(String resourceFileName)
abstract String	urlForResourceNamed(String resourceFileName, boolean isFullUrl, boolean isSecure)
abstract String	urlForResourceNamed(String resourceFileName, boolean isFullUrl, boolean isSecure, boolean isVersioned)

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, ensureFieldValuesClear, getFieldValue, init, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AWResourceManager

public AWResourceManager()

Method Detail

setSystemDefaultLocale

public abstract void setSystemDefaultLocale(Locale locale)

classForName

public abstract Class classForName(String className)

flush

public abstract void flush()

resourceNamed

public abstract AWResource resourceNamed(String resourceName)

resourceNamed

public abstract AWResource resourceNamed(String resourceName,
                                         boolean isBrandable)

resourcesNamed

public abstract AWResource[] resourcesNamed(String resourceName)

pathForResourceNamed

public abstract String pathForResourceNamed(String resourceName)

Deprecated. use resource().inputStream() to get contents of file

urlForResourceNamed

public abstract String urlForResourceNamed(String resourceFileName)

urlForResourceNamed

public abstract String urlForResourceNamed(String resourceFileName,
                                           boolean isFullUrl,
                                           boolean isSecure)

urlForResourceNamed

public abstract String urlForResourceNamed(String resourceFileName,
                                           boolean isFullUrl,
                                           boolean isSecure,
                                           boolean isVersioned)

imageInfoForName

public abstract AWImageInfo imageInfoForName(String imageFilename)

packageResourceNamed

public abstract AWResource packageResourceNamed(String resourceName)

locale

public abstract Locale locale()

characterEncoding

public abstract AWCharacterEncoding characterEncoding()

strings

public abstract AWStringsThunk strings()

localizedString

public abstract String localizedString(String filename,
                                       String extension,
                                       String componentName,
                                       String keyName,
                                       String defaultString)

localizedString

public abstract String localizedString(String filename,
                                       String componentName,
                                       String keyName,
                                       String defaultString)

localizedString

public abstract String localizedString(String fileName,
                                       String key,
                                       String defaultString)

localizedString

public abstract String localizedString(String fileName,
                                       String keyName)

resourceManagerForLocale

public abstract AWResourceManager resourceManagerForLocale(Locale locale)

resolveBrand

public AWResourceManager resolveBrand(String brandName,
                                      String version)

resolveBrand

public AWResourceManager resolveBrand(String brandName,
                                      String version,
                                      boolean shouldCreate)

setBaseResourceManager

public void setBaseResourceManager(AWResourceManager rm)

getBaseResourceManager

public AWResourceManager getBaseResourceManager()

setCacheEnabled

public void setCacheEnabled(boolean flag)

cacheEnabled

public boolean cacheEnabled()

registerPackagedResourceExtension

public void registerPackagedResourceExtension(String extension)