Class PropertiesRoleMappingListener
java.lang.Object
org.apache.catalina.core.PropertiesRoleMappingListener
- All Implemented Interfaces:
LifecycleListener
Implementation of
LifecycleListener that will populate the context's role mapping from a properties file.
This listener must only be nested within Context elements.
The keys represent application roles (e.g., admin, user, uservisor, etc.) while the values represent technical roles
(e.g., DNs, SIDs, UUIDs, etc.). A key can also be prefixed if, e.g., the properties file contains generic application
configuration as well: app-roles..
Note: The default value for the roleMappingFile is webapp:/WEB-INF/role-mapping.properties.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the prefix to filter from property keys.Gets the path to the role mapping properties file.voidlifecycleEvent(LifecycleEvent event) Acknowledge the occurrence of the specified event.voidsetKeyPrefix(String keyPrefix) Sets the prefix to filter from property keys.voidsetRoleMappingFile(String roleMappingFile) Sets the path to the role mapping properties file.
-
Constructor Details
-
PropertiesRoleMappingListener
public PropertiesRoleMappingListener()
-
-
Method Details
-
setRoleMappingFile
Sets the path to the role mapping properties file. You can use protocolwebapp:and whateverConfigFileLoadersupports.- Parameters:
roleMappingFile- the role mapping properties file to load from- Throws:
NullPointerException- if roleMappingFile is nullIllegalArgumentException- if roleMappingFile is empty
-
getRoleMappingFile
Gets the path to the role mapping properties file.- Returns:
- the path to the role mapping properties file
-
setKeyPrefix
Sets the prefix to filter from property keys. All other keys will be ignored which do not have the prefix.- Parameters:
keyPrefix- the properties key prefix
-
getKeyPrefix
Gets the prefix to filter from property keys.- Returns:
- the properties key prefix
-
lifecycleEvent
Description copied from interface:LifecycleListenerAcknowledge the occurrence of the specified event.- Specified by:
lifecycleEventin interfaceLifecycleListener- Parameters:
event- LifecycleEvent that has occurred
-