jet.server.api

Interface UserMailList

public interface UserMailList

Customized Mail List

JReport Server provides the ability to use customized user mail list scheme. A customized user mail list scheme must implement the interface jet.server.api.UserMailList, and import the customized class file by modifying the following JReport Server's properties file:
<SERVER PATH>/bin/classes.properties

When using customized user mail list scheme, users should:
1. Write a class which implements the interface jet.server.api.UserMailList.
2. Put the class into CLASSPATH which is used by launching JReport Server
3. Edit the file <SERVER PATH>/bin/classes.properties, let UserMailList point to the customized class
4. Restart JReport Server and the customized user mail list is working.

Method Summary

Modifier and Type	Method and Description
Enumeration	getAllMailAddresses(String realmName) Gets all user's mail addresses in the realm specified by "realmName".
Enumeration	getGroupMailAddresses(String realmName, String groupName) Gets all user's mail addresses in a group specified by the realm "realmName" and the group "groupName".
String	getMailAddress(String realmName, String userName) Gets user's mail address specified by "realmName" and "userName".
Enumeration	getRoleMailAddresses(String realmName, String roleName) Gets all user's mail addresses which refer to a role specified by the realm "realmName" and the group "roleNameName".

Method Detail

getAllMailAddresses

Enumeration getAllMailAddresses(String realmName)

Gets all user's mail addresses in the realm specified by "realmName".

Parameters:

realmName - the realm name

Returns:

all user mail addresses in the realm. Each element is a String.

getGroupMailAddresses

Enumeration getGroupMailAddresses(String realmName,
                                  String groupName)

Gets all user's mail addresses in a group specified by the realm "realmName" and the group "groupName".

Parameters:

realmName - the realm name

groupName - the group name

Returns:

all user mail addresses in the group. Each element is a String.

getMailAddress

String getMailAddress(String realmName,
                      String userName)

Gets user's mail address specified by "realmName" and "userName".

Parameters:

realmName - the realm name

userName - the user name

Returns:

user mail address. If "realmName" or "userName" is invalid, return null.

getRoleMailAddresses

Enumeration getRoleMailAddresses(String realmName,
                                 String roleName)

Gets all user's mail addresses which refer to a role specified by the realm "realmName" and the group "roleNameName".

Parameters:

realmName - the realm name

roleName - the role name

Returns:

all user mail addresses which refer to the role. Each element is a String.