org.opencrx.kernel.backend

Class UserHomes

java.lang.Object

org.opencrx.kernel.backend.AbstractImpl

org.opencrx.kernel.backend.UserHomes

public class UserHomes
extends AbstractImpl

UserHomes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserHomes.AlertState AlertState
static class	UserHomes.OpenCrxUserSettings OpenCrxUserSettings
static class	UserHomes.TimerState TimerState

Field Summary

Fields

Modifier and Type	Field and Description
static short	CAN_NOT_CHANGE_PASSWORD
static short	CAN_NOT_RETRIEVE_REQUESTED_PRINCIPAL
static short	CHANGE_PASSWORD_OK
static short	MISSING_NEW_PASSWORD
static short	MISSING_NEW_PASSWORD_VERIFICATION
static short	MISSING_OLD_PASSWORD
static short	OLD_PASSWORD_VERIFICATION_MISMATCH
static short	PASSWORD_POLICY_VIOLATION
static short	PASSWORD_VERIFICATION_MISMATCH
static String	RESET_PASSWORD_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserHomes() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyUserSettings(UserHome userHome, int currentPerspective, Properties settings, boolean doNotInitUserHome, boolean storeSettings, PrincipalGroup primaryGroup, String settingTimezone, String settingStoreSettingsOnLogoff, String settingDefaultEmailAccount, String settingSendmailSubjectPrefix, String settingWebAccessUrl, String settingTopNavigationShowMax, Boolean settingHideWorkspaceDashboard, List<String> settingRootObjects, Map<String,String> settingSubscriptions) Initializes a user's home and settings.
void	applyUserSettings(UserHome userHome, int currentPerspective, Properties settings, boolean storeSettings, PrincipalGroup primaryGroup, UserHomes.OpenCrxUserSettings newSettings, boolean doNotInitUserHome) Applies the newSettings to settings.
short	changePassword(org.openmdx.security.authentication1.jmi1.Password passwordCredential, String oldPassword, String password) Change password.
short	changePassword(UserHome userHome, String oldPassword, String newPassword, String newPasswordVerification) Change password for given user.
org.openmdx.security.authentication1.jmi1.Password	createPasswordCredential(org.openmdx.security.realm1.jmi1.Subject subject, List<String> errors) Create a password credential for given subject.
UserHome	createUserHome(org.openmdx.security.realm1.jmi1.Realm realm, Contact contact, PrincipalGroup primaryGroup, String principalName, List<org.openmdx.security.realm1.jmi1.Group> requiredGroups, boolean isAdministrator, String initialPassword, String initialPasswordVerification, String eMailAddress, String timezone, List<String> errors) Create a new user home.
Properties	getDefaultUserSettings(UserHome userHome) Get default user settings for given user.
static UserHomes	getInstance() Get registered UserHomes backend.
protected Object	getMessageValue(Object message, String feature) Extract value for given feature from message.
protected String	getRequestPasswordResetNotificationTemplate(UserHome userHome) Get template for the request password reset notification alert.
UserHome	getUserHome(org.openmdx.base.naming.Path from, javax.jdo.PersistenceManager pm) Get user home.
UserHome	getUserHome(org.openmdx.base.naming.Path from, javax.jdo.PersistenceManager pm, boolean useRunAsPrincipal) Get user home.
UserHome	getUserHome(String user, org.openmdx.base.naming.Path from, javax.jdo.PersistenceManager pm) Get user home.
UserHome	getUserHome(String user, org.openmdx.base.naming.Path from, javax.jdo.PersistenceManager pm, boolean useRunAsPrincipal) Get user home.
Segment	getUserHomeSegment(javax.jdo.PersistenceManager pm, String providerName, String segmentName) Returns the user home segment.
Properties	getUserSettings(UserHome userHome) Get settings of given user.
String	getUserTimezone(Properties settings) Get timezone property.
String	getWebAccessUrl(UserHome userHome) Get web access url.
String	importUsers(Segment homeSegment, byte[] item) Import users from given stream (as byte[]).
void	initUserHome(UserHome userHome) Initializes user home.
void	markAsAccepted(Alert alert) Set alert state to ACCEPTED.
void	markAsNew(Alert alert) Set alert state to NEW.
void	markAsRead(Alert alert) Set alert state to READ.
void	preDelete(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object, boolean preDelete) Pre-delete callback.
void	preStore(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object) Pre-store callback.
void	refreshItems(UserHome userHome) Refresh items on given user home.
static void	register() Register this backend.
void	requestPasswordReset(UserHome userHome) Request password reset.
ObjectFinder	searchAdvanced(UserHome userHome, String allWords, String atLeastOneOfTheWords, String withoutWords) Create object finder according to given advanced search criteria.
ObjectFinder	searchBasic(UserHome userHome, String searchExpression) Create object finder according to given basic search criteria.
protected boolean	subscriptionEventTypeMatches(Subscription subscription, org.openmdx.base.jmi1.ContextCapable message) Test whether subscription accepts given event type.
protected boolean	subscriptionFilterMatches(Subscription subscription, Object message, String filterName, Set<String> filterValues) Test if message matches the given subscription filter.
boolean	subscriptionMatches(Subscription subscription, org.openmdx.base.jmi1.ContextCapable message) Return true if subscription matches message.
boolean	subscriptionTopicMatches(Subscription subscription, org.openmdx.base.jmi1.ContextCapable message) Return true if the topic XRI pattern matches the message XRI.
boolean	testPasswordPolicy(String password) Default implementation does not enforce a password policy.
void	updateTimer(Timer timer) Update derived attributes of given timer.

Methods inherited from class org.opencrx.kernel.backend.AbstractImpl

getInstance, getUidAsString, registerImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHANGE_PASSWORD_OK

public static final short CHANGE_PASSWORD_OK

See Also:

Constant Field Values

MISSING_NEW_PASSWORD

public static final short MISSING_NEW_PASSWORD

See Also:

Constant Field Values

MISSING_NEW_PASSWORD_VERIFICATION

public static final short MISSING_NEW_PASSWORD_VERIFICATION

See Also:

Constant Field Values

PASSWORD_VERIFICATION_MISMATCH

public static final short PASSWORD_VERIFICATION_MISMATCH

See Also:

Constant Field Values

CAN_NOT_RETRIEVE_REQUESTED_PRINCIPAL

public static final short CAN_NOT_RETRIEVE_REQUESTED_PRINCIPAL

See Also:

Constant Field Values

CAN_NOT_CHANGE_PASSWORD

public static final short CAN_NOT_CHANGE_PASSWORD

See Also:

Constant Field Values

MISSING_OLD_PASSWORD

public static final short MISSING_OLD_PASSWORD

See Also:

Constant Field Values

OLD_PASSWORD_VERIFICATION_MISMATCH

public static final short OLD_PASSWORD_VERIFICATION_MISMATCH

See Also:

Constant Field Values

PASSWORD_POLICY_VIOLATION

public static final short PASSWORD_POLICY_VIOLATION

See Also:

Constant Field Values

RESET_PASSWORD_PREFIX

public static final String RESET_PASSWORD_PREFIX

See Also:

Constant Field Values

Constructor Detail

UserHomes

protected UserHomes()

Constructor.

Method Detail

register

public static void register()

Register this backend.

getInstance

public static UserHomes getInstance()
                             throws org.openmdx.base.exception.ServiceException

Get registered UserHomes backend.

Returns:

Throws:

org.openmdx.base.exception.ServiceException

markAsAccepted

public void markAsAccepted(Alert alert)
                    throws org.openmdx.base.exception.ServiceException

Set alert state to ACCEPTED.

Parameters:

alert -

Throws:

org.openmdx.base.exception.ServiceException

markAsRead

public void markAsRead(Alert alert)
                throws org.openmdx.base.exception.ServiceException

Set alert state to READ.

Parameters:

alert -

Throws:

org.openmdx.base.exception.ServiceException

markAsNew

public void markAsNew(Alert alert)
               throws org.openmdx.base.exception.ServiceException

Set alert state to NEW.

Parameters:

alert -

Throws:

org.openmdx.base.exception.ServiceException

getUserHomeSegment

public Segment getUserHomeSegment(javax.jdo.PersistenceManager pm,
                         String providerName,
                         String segmentName)

Returns the user home segment.

Parameters:

pm -

providerName -

segmentName -

Returns:

refreshItems

public void refreshItems(UserHome userHome)
                  throws org.openmdx.base.exception.ServiceException

Refresh items on given user home. Currently these are:

• alerts

Parameters:

userHome -

Throws:

org.openmdx.base.exception.ServiceException

getRequestPasswordResetNotificationTemplate

protected String getRequestPasswordResetNotificationTemplate(UserHome userHome)
                                                      throws org.openmdx.base.exception.ServiceException

Get template for the request password reset notification alert. The template should contain the place-holders {RESET_CONFIRM_URL} and {RESET_CANCEL_URL}. Override this method if custom and/or locale specific templates are required.

Parameters:

userHome -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

requestPasswordReset

public void requestPasswordReset(UserHome userHome)
                          throws org.openmdx.base.exception.ServiceException

Request password reset.

Parameters:

userHome -

Throws:

org.openmdx.base.exception.ServiceException

getUserHome

public UserHome getUserHome(org.openmdx.base.naming.Path from,
                   javax.jdo.PersistenceManager pm)
                     throws org.openmdx.base.exception.ServiceException

Get user home.

Parameters:

from -

pm -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getUserHome

public UserHome getUserHome(org.openmdx.base.naming.Path from,
                   javax.jdo.PersistenceManager pm,
                   boolean useRunAsPrincipal)
                     throws org.openmdx.base.exception.ServiceException

Get user home.

Parameters:

from -

pm -

useRunAsPrincipal -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getUserHome

public UserHome getUserHome(String user,
                   org.openmdx.base.naming.Path from,
                   javax.jdo.PersistenceManager pm)
                     throws org.openmdx.base.exception.ServiceException

Get user home.

Parameters:

user -

from -

pm -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getUserHome

public UserHome getUserHome(String user,
                   org.openmdx.base.naming.Path from,
                   javax.jdo.PersistenceManager pm,
                   boolean useRunAsPrincipal)
                     throws org.openmdx.base.exception.ServiceException

Get user home.

Parameters:

user -

from -

pm -

useRunAsPrincipal -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

createPasswordCredential

public org.openmdx.security.authentication1.jmi1.Password createPasswordCredential(org.openmdx.security.realm1.jmi1.Subject subject,
                                                                          List<String> errors)

Create a password credential for given subject.

Parameters:

subject -

errors -

Returns:

changePassword

public short changePassword(org.openmdx.security.authentication1.jmi1.Password passwordCredential,
                   String oldPassword,
                   String password)

Change password.

Parameters:

passwordCredential -

oldPassword -

password -

Returns:

testPasswordPolicy

public boolean testPasswordPolicy(String password)

Default implementation does not enforce a password policy.

Parameters:

password -

Returns:

changePassword

public short changePassword(UserHome userHome,
                   String oldPassword,
                   String newPassword,
                   String newPasswordVerification)

Change password for given user.

Parameters:

userHome -

oldPassword -

newPassword -

newPasswordVerification -

Returns:

createUserHome

public UserHome createUserHome(org.openmdx.security.realm1.jmi1.Realm realm,
                      Contact contact,
                      PrincipalGroup primaryGroup,
                      String principalName,
                      List<org.openmdx.security.realm1.jmi1.Group> requiredGroups,
                      boolean isAdministrator,
                      String initialPassword,
                      String initialPasswordVerification,
                      String eMailAddress,
                      String timezone,
                      List<String> errors)
                        throws org.openmdx.base.exception.ServiceException

Create a new user home.

Parameters:

realm -

contact -

primaryGroup -

principalName -

requiredGroups -

isAdministrator -

initialPassword -

initialPasswordVerification -

eMailAddress -

timezone -

errors -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

importUsers

public String importUsers(Segment homeSegment,
                 byte[] item)
                   throws org.openmdx.base.exception.ServiceException

Import users from given stream (as byte[]).

Parameters:

homeSegment -

item -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

searchBasic

public ObjectFinder searchBasic(UserHome userHome,
                       String searchExpression)
                         throws org.openmdx.base.exception.ServiceException

Create object finder according to given basic search criteria.

Parameters:

userHome -

searchExpression -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

searchAdvanced

public ObjectFinder searchAdvanced(UserHome userHome,
                          String allWords,
                          String atLeastOneOfTheWords,
                          String withoutWords)
                            throws org.openmdx.base.exception.ServiceException

Create object finder according to given advanced search criteria.

Parameters:

userHome -

allWords -

atLeastOneOfTheWords -

withoutWords -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getWebAccessUrl

public String getWebAccessUrl(UserHome userHome)

Get web access url.

Parameters:

userHome -

Returns:

applyUserSettings

public void applyUserSettings(UserHome userHome,
                     int currentPerspective,
                     Properties settings,
                     boolean doNotInitUserHome,
                     boolean storeSettings,
                     PrincipalGroup primaryGroup,
                     String settingTimezone,
                     String settingStoreSettingsOnLogoff,
                     String settingDefaultEmailAccount,
                     String settingSendmailSubjectPrefix,
                     String settingWebAccessUrl,
                     String settingTopNavigationShowMax,
                     Boolean settingHideWorkspaceDashboard,
                     List<String> settingRootObjects,
                     Map<String,String> settingSubscriptions)
                       throws org.openmdx.base.exception.ServiceException

Initializes a user's home and settings.

Parameters:

userHome -

currentPerspective -

settings -

doNotInitUserHome -

storeSettings -

primaryGroup -

settingTimezone -

settingStoreSettingsOnLogoff -

settingDefaultEmailAccount -

settingSendmailSubjectPrefix -

settingWebAccessUrl -

settingTopNavigationShowMax -

settingHideWorkspaceDashboard -

settingRootObjects -

settingSubscriptions -

Throws:

org.openmdx.base.exception.ServiceException

applyUserSettings

public void applyUserSettings(UserHome userHome,
                     int currentPerspective,
                     Properties settings,
                     boolean storeSettings,
                     PrincipalGroup primaryGroup,
                     UserHomes.OpenCrxUserSettings newSettings,
                     boolean doNotInitUserHome)
                       throws org.openmdx.base.exception.ServiceException

Applies the newSettings to settings. If !noInitUserHome is set then the user home first is initialized, i.e. method initUserHome(UserHome) is called. The settings are stored on userHome if storeSettings is true.

Parameters:

userHome -

currentPerspective -

settings -

storeSettings -

primaryGroup -

newSettings -

doNotInitUserHome -

Throws:

org.openmdx.base.exception.ServiceException

initUserHome

public void initUserHome(UserHome userHome)
                  throws org.openmdx.base.exception.ServiceException

Initializes user home. It creates

• Private activity trackers, activity creators for incidents, meetings, tasks
• Private document folders
• Private account groups
• Sync profiles

Throws:

org.openmdx.base.exception.ServiceException

getUserSettings

public Properties getUserSettings(UserHome userHome)
                           throws org.openmdx.base.exception.ServiceException

Get settings of given user.

Parameters:

userHome -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getDefaultUserSettings

public Properties getDefaultUserSettings(UserHome userHome)
                                  throws org.openmdx.base.exception.ServiceException

Get default user settings for given user. Default settings are stored in documents with name pattern UserSettings.{role.name}. The content of the document must be text/plain and in the standard Java properties format. The assigned roles of the user are iterated by the order returned by principal).getGrantedRole() and override properties with the same key (defaultSettings.putAll(settings))

Parameters:

userHome -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getUserTimezone

public String getUserTimezone(Properties settings)
                       throws org.openmdx.base.exception.ServiceException

Get timezone property.

Parameters:

settings -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

updateTimer

public void updateTimer(Timer timer)
                 throws org.openmdx.base.exception.ServiceException

Update derived attributes of given timer.

Parameters:

timer -

Throws:

org.openmdx.base.exception.ServiceException

getMessageValue

protected Object getMessageValue(Object message,
                     String feature)

Extract value for given feature from message.

Parameters:

message -

feature -

Returns:

subscriptionEventTypeMatches

protected boolean subscriptionEventTypeMatches(Subscription subscription,
                                   org.openmdx.base.jmi1.ContextCapable message)

Test whether subscription accepts given event type.

Parameters:

subscription -

eventType -

Returns:

subscriptionFilterMatches

protected boolean subscriptionFilterMatches(Subscription subscription,
                                Object message,
                                String filterName,
                                Set<String> filterValues)

Test if message matches the given subscription filter.

Parameters:

filterName -

filterValue -

message -

Returns:

subscriptionTopicMatches

public boolean subscriptionTopicMatches(Subscription subscription,
                               org.openmdx.base.jmi1.ContextCapable message)

Return true if the topic XRI pattern matches the message XRI.

Parameters:

subscription -

message -

Returns:

subscriptionMatches

public boolean subscriptionMatches(Subscription subscription,
                          org.openmdx.base.jmi1.ContextCapable message)
                            throws org.openmdx.base.exception.ServiceException

Return true if subscription matches message.

Parameters:

subscription -

message -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

preDelete

public void preDelete(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object,
             boolean preDelete)
               throws org.openmdx.base.exception.ServiceException

Description copied from class: AbstractImpl

Pre-delete callback. This method is called before can object is deleted. Override this method for custom-specific behaviour.

Overrides:

preDelete in class AbstractImpl

Throws:

org.openmdx.base.exception.ServiceException

preStore

public void preStore(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 object)
              throws org.openmdx.base.exception.ServiceException

Description copied from class: AbstractImpl

Pre-store callback. This method is called before an object is made persistent. Override this method for custom-specific behaviour.

Overrides:

preStore in class AbstractImpl

Throws:

org.openmdx.base.exception.ServiceException