jet.server.api.custom.security.user
Interface UserPrivilegeProvider

public interface UserPrivilegeProvider

Among the interfaces of JReport security API, UserPrivilegeProvider is used to provide customized privilege setting of user. In addition to getting user privilege setting from customer's external security system, this interface also provides the ability to modify user privilege setting in customer's external security system.
Privilege is a credential that is a special operation on JReport server, this operation is not referred to any node in JReport server resource tree. Currently there are these types of privileges in JReport server: jet.cs.util.APIConst.PRIVILEGE_PUBLISH_REPORT indicating credential to deploy reports/catalogs to the server, jet.cs.util.APIConst.PRIVILEGE_ACCESS_ADVANCED_PROPERTIES indicating credential to access advanced information

Since:

version 8

Method Summary

java.util.Hashtable	getUserPrivileges(java.lang.String realmName) Gets all users' privilege settings from customer's external security system.
boolean	isEnableEdit() Indicates whether customer's external security system will be modified by invoking some methods in UserPrivilegeProvider. In common cases, invoking setUserPrivileges() should take effect on customer's external security system, and cause modification of external security system, this method should return true in such cases.
void	setUserPrivileges(java.lang.String realmName, java.lang.String userName, java.lang.String[] privileges) Sets a user's privileges in customer's external security system.

Method Detail

getUserPrivileges

java.util.Hashtable getUserPrivileges(java.lang.String realmName)
                                      throws JRCustomerException

Gets all users' privilege settings from customer's external security system.

Parameters:

realmName - the realm name.

Returns:

A Hashtable object to represent all users' privilege settings. In the returned Hashtable, the key is user name, the value is a String array, which may contain below strings: jet.cs.util.APIConst.PRIVILEGE_PUBLISH_REPORT and jet.cs.util.APIConst.PRIVILEGE_ACCESS_ADVANCED_PROPERTIES jet.cs.util.APIConst.PRIVILEGE_PUBLISH_REPORT indicating credential to deploy reports/catalogs to the server, jet.cs.util.APIConst.PRIVILEGE_ACCESS_ADVANCED_PROPERTIES indicating credential to access advanced information.

Throws:

JRCustomerException - If an error occurs during JReport server security system invoking this method, and the implementation thinks this error should be thrown to JReport server security system.

setUserPrivileges

void setUserPrivileges(java.lang.String realmName,
                       java.lang.String userName,
                       java.lang.String[] privileges)
                       throws NoSuchUserException,
                              JRCustomerException

Sets a user's privileges in customer's external security system.

Parameters:

realmName - the realm name.

userName - the user name.

privileges - A String array, which may contain below strings: jet.cs.util.APIConst.PRIVILEGE_PUBLISH_REPORT and jet.cs.util.APIConst.PRIVILEGE_ACCESS_ADVANCED_PROPERTIES jet.cs.util.APIConst.PRIVILEGE_PUBLISH_REPORT indicating credential to deploy reports/catalogs to the server, jet.cs.util.APIConst.PRIVILEGE_ACCESS_ADVANCED_PROPERTIES indicating credential to access advanced information

Throws:

NoSuchUserException - If there is no user with the specified name in customer's external security system.

JRCustomerException - If an error occurs during JReport server security system invoking this method, and the implementation thinks this error should be thrown to JReport server security system.

isEnableEdit

boolean isEnableEdit()

Indicates whether customer's external security system will be modified by invoking some methods in UserPrivilegeProvider.
In common cases, invoking setUserPrivileges() should take effect on customer's external security system, and cause modification of external security system, this method should return true in such cases. If customer's external security system will not be affected by invoking setUserPrivileges(), this method should return false.
Returned value of the method isEditing() with parameter SecurityWebAdaptor.ACTION_EDIT_USER_PRIVILEGES in jet.server.api.SecurityWebAdaptor is the same as this method's return value.

Returns:

true if external security system will be affected by invoking setUserPrivileges(), otherwise return false.

See Also:

SecurityWebAdaptor