Package org.imixs.marty.profile

Class ProfilePlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.marty.profile.ProfilePlugin

All Implemented Interfaces:

org.imixs.workflow.Plugin

Direct Known Subclasses:

ProfilePlugin

public class ProfilePlugin
extends org.imixs.workflow.engine.plugins.AbstractPlugin

This plug-in supports additional business logic for profile entities. This Plugins is used by the System Workflow only.

The plugin verifies the userId and email address for input patterns and validates for duplicates. The input pattern for the userID can be defined by the imixs property

• security.userid.input.pattern

The default value is "^[A-Za-z0-9.@\\-\\w]+"

In addition the input mode can be set to LOWERCASE or UPPERCASE. This is controlled by the imixs property

• security.userid.input.mode

The default value is LOWERCASE.

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_USER_INPUT_MODE
static final String	DEFAULT_USERID_PATTERN
static String	EMAIL_ALREADY_TAKEN
static final String	EMAIL_PATTERN
static String	INVALID_EMAIL
static String	INVALID_USERNAME
static String	NO_PROFILE_SERVICE_FOUND
static String	USERNAME_ALREADY_TAKEN

Fields inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor	Description
ProfilePlugin()

Method Summary

Modifier and Type	Method	Description
void	close(boolean rollbackTransaction)	This method discards the cache for the current userID (ProfileService).
boolean	isValidEmailAddress(String email)	Validates a Emailaddress with regular expression
boolean	isValidUserId(String userid)	Validate userID with regular expression provided by the property 'security.userid.input.pattern'
org.imixs.workflow.ItemCollection	run(org.imixs.workflow.ItemCollection workItem, org.imixs.workflow.ItemCollection documentActivity)	The Plug-in verifies if the workitem is from the type 'profile'.

Methods inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

getCtx, getWorkflowService, init, mergeFieldList, uniqueList

Methods inherited from class java.lang.Object

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

Field Details

USERNAME_ALREADY_TAKEN

public static String USERNAME_ALREADY_TAKEN

INVALID_USERNAME

public static String INVALID_USERNAME

EMAIL_ALREADY_TAKEN

public static String EMAIL_ALREADY_TAKEN

INVALID_EMAIL

public static String INVALID_EMAIL

NO_PROFILE_SERVICE_FOUND

public static String NO_PROFILE_SERVICE_FOUND

EMAIL_PATTERN

public static final String EMAIL_PATTERN

See Also:

• Constant Field Values

DEFAULT_USERID_PATTERN

public static final String DEFAULT_USERID_PATTERN

See Also:

• Constant Field Values

DEFAULT_USER_INPUT_MODE

public static final String DEFAULT_USER_INPUT_MODE

See Also:

• Constant Field Values

Constructor Details

ProfilePlugin

public ProfilePlugin()

Method Details

run

public org.imixs.workflow.ItemCollection run(org.imixs.workflow.ItemCollection workItem,
 org.imixs.workflow.ItemCollection documentActivity)
                                      throws org.imixs.workflow.exceptions.PluginException

The Plug-in verifies if the workitem is from the type 'profile'. The plug-in tests if the usernam or email is unique

Throws:

org.imixs.workflow.exceptions.PluginException

close

public void close(boolean rollbackTransaction)
           throws org.imixs.workflow.exceptions.PluginException

This method discards the cache for the current userID (ProfileService). This is called only in case a profile was processed and no rollback is called.

Specified by:

close in interface org.imixs.workflow.Plugin

Overrides:

close in class org.imixs.workflow.engine.plugins.AbstractPlugin

Throws:

org.imixs.workflow.exceptions.PluginException

isValidUserId

public boolean isValidUserId(String userid)

Validate userID with regular expression provided by the property 'security.userid.input.pattern'

Parameters:

userid - - userID for validation

Returns:

true valid userID, false invalid userID

isValidEmailAddress

public boolean isValidEmailAddress(String email)

Validates a Emailaddress with regular expression

Parameters:

userid - - email for validation

Returns:

true valid email, false invalid email