Interface VirtualHostRealmConfig
- All Superinterfaces:
- Config
Virtual Host Realm Configuration.
 
 This is part of the configuration of a Virtual Host
 . It defines the users of the realm.
- Since:
- 4.4
- 
Method SummaryModifier and TypeMethodDescriptionAdd a realm user.getName()Gets the realm name.getPath()Gets the realm path.Gets a named realm user.getUsers()Gets the realm users.removeUser(String name) Remove a realm user.
- 
Method Details- 
getNameString getName()Gets the realm name.- Returns:
- realm name
 
- 
getPathString getPath()Gets the realm path.- Returns:
- path
 
- 
getUsersList<VirtualHostRealmUserConfig> getUsers()Gets the realm users.- Returns:
- list of realm users which can be empty if none defined.
 
- 
getUserGets a named realm user.- Parameters:
- name- the user name
- Returns:
- the realm user or null if not defined
 
- 
addUserAdd a realm user.- Parameters:
- name- user name
- password- the password
- Returns:
- realm user
- Throws:
- ConfigException- if unable to add realm user
 
- 
removeUserRemove a realm user.- Parameters:
- name- realm user name
- Returns:
- user removed or null if it did not exist
- Throws:
- ConfigException- if unable to remove
 
 
-