EntityPropertiesServiceSpringImpl (Sakai Entity Broker Utilities 23.1 API)

java.lang.Object
- org.sakaiproject.entitybroker.util.core.AbstractEntityPropertiesService
- - org.sakaiproject.entitybroker.util.spring.EntityPropertiesServiceSpringImpl

All Implemented Interfaces:

EntityPropertiesService
```
public class EntityPropertiesServiceSpringImpl
extends AbstractEntityPropertiesService
implements EntityPropertiesService
```
This service allows us to track all the properties files related to describing the capabilities of our entities and the entities themselves, it allows lookup of strings as well
NOTE: Depends on spring and extends the spring based message bundle

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected class EntityPropertiesServiceSpringImpl.SpringMessageBundle
- Nested classes/interfaces inherited from class org.sakaiproject.entitybroker.util.core.AbstractEntityPropertiesService
  AbstractEntityPropertiesService.MessageBundle

Field Summary
- Fields inherited from class org.sakaiproject.entitybroker.util.core.AbstractEntityPropertiesService
  prefixMap

Constructor Summary

Constructors
Constructor Description

EntityPropertiesServiceSpringImpl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`registerLocaleMessages(String prefix, String baseName, Locale locale, ClassLoader classLoader)`	Override this to provide custom message handling, you must register the `AbstractEntityPropertiesService.MessageBundle` you create in this method so that the messages can be looked up later, register using `AbstractEntityPropertiesService.registerPrefixMessageBundle(String, MessageBundle)`

Methods inherited from class org.sakaiproject.entitybroker.util.core.AbstractEntityPropertiesService
getLocale, getProperty, getProperty, getProperty, loadProperties, registerPrefixMessageBundle, unloadProperties, unregisterPrefixMessageBundle

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

Methods inherited from interface org.sakaiproject.entitybroker.providers.EntityPropertiesService
getLocale, getProperty, getProperty, getProperty, loadProperties, unloadProperties

- Constructor Detail
  - EntityPropertiesServiceSpringImpl
```
public EntityPropertiesServiceSpringImpl()
```
- Method Detail
  - registerLocaleMessages
```
public List<String> registerLocaleMessages(String prefix,
                                           String baseName,
                                           Locale locale,
                                           ClassLoader classLoader)
```
    Description copied from class: AbstractEntityPropertiesService
    
    Override this to provide custom message handling, you must register the AbstractEntityPropertiesService.MessageBundle you create in this method so that the messages can be looked up later, register using AbstractEntityPropertiesService.registerPrefixMessageBundle(String, MessageBundle)
    
    Specified by:
    
    registerLocaleMessages in class AbstractEntityPropertiesService
    
    Parameters:
    
    prefix - an entity prefix
    
    baseName - (optional) the part before the .properties or _en.properties, example: location/dir/myentity.properties, if null then prefix is used
    
    locale - the Locale to register messages for
    
    classLoader - (optional) the ClassLoader to find the properties files in, if null then the default thread ClassLoader is used
    
    Returns:
    
    the list of registered keys for this Locale