de.fraunhofer.fokus.oefit.adhoc.custom

Class CustomPortalServiceHandler

java.lang.Object

de.fraunhofer.fokus.oefit.adhoc.custom.CustomPortalServiceHandler

public class CustomPortalServiceHandler
extends Object

Custom utility methods for tasks related to portal datastructures

Constructor Summary

Constructors

Constructor and Description
CustomPortalServiceHandler()

Method Summary

Modifier and Type	Method and Description
static void	changeUserProfile(com.liferay.portal.model.User oldUser, ProfileForm newProfile, org.springframework.validation.BindingResult result) Validates a given form object and changes user settings accordingly
static void	checkInit(long groupId, long userId) Provides an entry point to initialize basic settings and data-structures.
static com.liferay.portal.model.Role	checkRole(long userId, long companyId, E_Role role) Check for a specific role name and create a regular role if not existent
static com.liferay.portal.model.Role	checkRole(long userId, long companyId, String roleName, int roleType) Check for a specific role name and create a regular role if not existent
static void	createOrganisationLogoFolder(long groupId, long userId)
static com.liferay.portal.model.User	createPortalUser(String firstName, String lastName, String mail, long companyId, long groupId, Locale locale, boolean sendMail) Creates a new portal user
static com.liferay.portal.model.User	createPortalUser(String firstName, String lastName, String mail, long companyId, long groupId, Locale locale, boolean sendMail, String password, boolean isAdmin)
static com.liferay.portal.model.User	createPortalUser(String firstName, String lastName, String mail, long companyId, long groupId, Locale locale, boolean sendMail, String password, boolean isAdmin, E_Role defaultRole) Creates a new portal user
static String	getConfigValue(E_ConfigKey key) Gets the value for a given configuration key (or the default setting if not found) This method may either access the portlet data-source for local settings or the portal properties for global configuration settings
static String	getRoleName(E_Role role) Get actual/dynamic role name of a role containing a configuration reference
static boolean	hasUser(long companyId, String mail) Check whether a given user exists
static boolean	isConfigEnabled(E_ConfigKey key) Checks if a configuration key that holds a boolean setting is set to true
static boolean	isSystemInitialized() Checks if is system initialized.
static E_Role	matchesRole(com.liferay.portal.model.Role cmpRole) Check whether a Liferay-Role matches any role defined by this enum
static void	saveConfig(javax.portlet.ActionRequest request) Save a set of configuration changes right from the portlet request The request is parsed for configuration values with names out of E_ConfigKey As a result, social media plugins and messagec composers will be reinitialized to address the changes
static void	setConfig(E_ConfigKey key, String value) Set a given configuration value

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomPortalServiceHandler

public CustomPortalServiceHandler()

Method Detail

changeUserProfile

public static void changeUserProfile(com.liferay.portal.model.User oldUser,
                                     ProfileForm newProfile,
                                     org.springframework.validation.BindingResult result)

Validates a given form object and changes user settings accordingly

Parameters:

oldUser - the old Liferay user model

newProfile - the profile containing new values

result - the message handler to bind validation errors to

checkInit

public static void checkInit(long groupId,
                             long userId)

Provides an entry point to initialize basic settings and data-structures. Due to use of Liferay's document library and permission settings, this should be run only on login by an administrator.

Parameters:

themeDisplay - the theme display of the administrator

createOrganisationLogoFolder

public static void createOrganisationLogoFolder(long groupId,
                                                long userId)
                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

matchesRole

public static E_Role matchesRole(com.liferay.portal.model.Role cmpRole)

Check whether a Liferay-Role matches any role defined by this enum

Parameters:

cmpRole - the Liferay role

Returns:

the supported enum or null, if not supported

getRoleName

public static String getRoleName(E_Role role)

Get actual/dynamic role name of a role containing a configuration reference

Parameters:

role - The role

Returns:

The role name

checkRole

public static com.liferay.portal.model.Role checkRole(long userId,
                                                      long companyId,
                                                      E_Role role)

Check for a specific role name and create a regular role if not existent

Parameters:

companyId - the company Id of the given role

role - the role enum

Returns:

the role

checkRole

public static com.liferay.portal.model.Role checkRole(long userId,
                                                      long companyId,
                                                      String roleName,
                                                      int roleType)

Check for a specific role name and create a regular role if not existent

Parameters:

companyId - the company Id of the given role

roleName - the role name

Returns:

the role

createPortalUser

public static com.liferay.portal.model.User createPortalUser(String firstName,
                                                             String lastName,
                                                             String mail,
                                                             long companyId,
                                                             long groupId,
                                                             Locale locale,
                                                             boolean sendMail)

Creates a new portal user

Parameters:

firstName - the first name

lastName - the last name

mail - the email address

companyId - the company id

locale - the user's locale

Returns:

the user object

createPortalUser

public static com.liferay.portal.model.User createPortalUser(String firstName,
                                                             String lastName,
                                                             String mail,
                                                             long companyId,
                                                             long groupId,
                                                             Locale locale,
                                                             boolean sendMail,
                                                             String password,
                                                             boolean isAdmin)

createPortalUser

public static com.liferay.portal.model.User createPortalUser(String firstName,
                                                             String lastName,
                                                             String mail,
                                                             long companyId,
                                                             long groupId,
                                                             Locale locale,
                                                             boolean sendMail,
                                                             String password,
                                                             boolean isAdmin,
                                                             E_Role defaultRole)

Creates a new portal user

Parameters:

firstName - the first name

lastName - the last name

mail - the email address

companyId - the company id

locale - the user's locale

Returns:

the user object

getConfigValue

public static String getConfigValue(E_ConfigKey key)

Gets the value for a given configuration key (or the default setting if not found) This method may either access the portlet data-source for local settings or the portal properties for global configuration settings

Parameters:

key - the configuration key

Returns:

the configuration value

isConfigEnabled

public static boolean isConfigEnabled(E_ConfigKey key)

Checks if a configuration key that holds a boolean setting is set to true

Parameters:

key - the configuration key

Returns:

true, if the configuration key is a string representation of Boolean.TRUE

hasUser

public static boolean hasUser(long companyId,
                              String mail)

Check whether a given user exists

Parameters:

companyId - the company id

mail - the email address of the user in question

Returns:

true, if the user exists, false otherwise

isSystemInitialized

public static boolean isSystemInitialized()

Checks if is system initialized. Uses a portlet configuration setting to determine, if #checkInit()) checkInit was called before.

Returns:

true, if #checkInit()) checkInit was successfully called before

saveConfig

public static void saveConfig(javax.portlet.ActionRequest request)

Save a set of configuration changes right from the portlet request The request is parsed for configuration values with names out of E_ConfigKey As a result, social media plugins and messagec composers will be reinitialized to address the changes

Parameters:

request - the portlet request

setConfig

public static void setConfig(E_ConfigKey key,
                             String value)

Set a given configuration value

Parameters:

key - the configuration key

value - the configuration value