Package com.pushtechnology.diffusion.api.config

Interface VirtualHostRealmConfig

All Superinterfaces:

Config

public interface VirtualHostRealmConfig
extends 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 Summary

Modifier and Type	Method	Description
VirtualHostRealmUserConfig	addUser(String name, String password)	Add a realm user.
String	getName()	Gets the realm name.
String	getPath()	Gets the realm path.
VirtualHostRealmUserConfig	getUser(String name)	Gets a named realm user.
List<VirtualHostRealmUserConfig>	getUsers()	Gets the realm users.
VirtualHostRealmUserConfig	removeUser(String name)	Remove a realm user.

Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

isLocked

Method Details

getName

String getName()

Gets the realm name.

Returns:

realm name

getPath

String getPath()

Gets the realm path.

Returns:

path

getUsers

List<VirtualHostRealmUserConfig> getUsers()

Gets the realm users.

Returns:

list of realm users which can be empty if none defined.

getUser

VirtualHostRealmUserConfig getUser(String name)

Gets a named realm user.

Parameters:

name - the user name

Returns:

the realm user or null if not defined

addUser

VirtualHostRealmUserConfig addUser(String name,
 String password)
                            throws ConfigException

Add a realm user.

Parameters:

name - user name

password - the password

Returns:

realm user

Throws:

ConfigException - if unable to add realm user

removeUser

VirtualHostRealmUserConfig removeUser(String name)
                               throws ConfigException

Remove a realm user.

Parameters:

name - realm user name

Returns:

user removed or null if it did not exist

Throws:

ConfigException - if unable to remove