org.apache.wiki.auth
Class UserManager.SaveUserProfileTask

java.lang.Object
  org.apache.wiki.workflow.AbstractStep
      org.apache.wiki.workflow.Task
          org.apache.wiki.auth.UserManager.SaveUserProfileTask

All Implemented Interfaces:

Serializable, Step

Enclosing class:

UserManager

public static class UserManager.SaveUserProfileTask
extends Task

Inner class that handles the actual profile save action. Instances of this class are assumed to have been added to an approval workflow via WorkflowBuilder.buildApprovalWorkflow(Principal, String, Task, String, org.apache.wiki.workflow.Fact[], Task, String); they will not function correctly otherwise.

See Also:

Serialized Form

Constructor Summary

UserManager.SaveUserProfileTask(WikiEngine engine)
Deprecated. will be removed in 2.10 scope. Consider using #SaveUserProfileTask(WikiEngine, Locale) instead

UserManager.SaveUserProfileTask(WikiEngine engine, Locale loc)

Method Summary

Outcome

execute() Saves the user profile to the user database.

Methods inherited from class org.apache.wiki.workflow.Task

getActor, getSuccessor, setSuccessor

Methods inherited from class org.apache.wiki.workflow.AbstractStep

addError, addSuccessor, getAvailableOutcomes, getEndTime, getErrors, getMessageArguments, getMessageKey, getOutcome, getOwner, getStartTime, getSuccessor, getWorkflow, isCompleted, isStarted, setOutcome, setWorkflow, start

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManager.SaveUserProfileTask

@Deprecated
public UserManager.SaveUserProfileTask(WikiEngine engine)

Deprecated. will be removed in 2.10 scope. Consider using #SaveUserProfileTask(WikiEngine, Locale) instead

Constructs a new Task for saving a user profile.

Parameters:

engine - the wiki engine

UserManager.SaveUserProfileTask

public UserManager.SaveUserProfileTask(WikiEngine engine,
                                       Locale loc)

Method Detail

execute

public Outcome execute()
                throws WikiException

Saves the user profile to the user database.

Specified by:

execute in interface Step

Specified by:

execute in class AbstractStep

Returns:

Outcome.STEP_COMPLETE if the task completed successfully

Throws:

WikiException - if the save did not complete for some reason