com.plumtree.portalpages.rest.user
Class UserRESTControl

java.lang.Object
  com.plumtree.portalpages.rest.user.UserRESTControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class UserRESTControl
extends java.lang.Object
implements IControl

This control handles processing the User REST API requests.

Field Summary

static java.lang.String	CURRENT_USER The default value - current user.
protected AActivitySpace	m_asOwner The owning space for this control.
protected IUserRestModel	m_model The User REST model.
static java.lang.String	STR_MVC_CLASS_NAME
static java.lang.String	USER_ID The control argument for the user ID passed in from the friendly URL.

Constructor Summary

UserRESTControl()

Method Summary

Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
Redirect	GetDPRedirect()
java.lang.String	GetName() Return the name of the MVC object.
void	Init(IModel model, AActivitySpace space) Initialize the control with the model it should use and it's parent AActivitySpace.
Redirect	ProcessAction(IJSONParser _parser) This method handles parsing the JSON body and executing the appropriate command.
Redirect	ProcessError(IRESTError _error) This helper method sets the error on the model and redirects to the REST API display page.

Methods inherited from class java.lang.Object

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

The control argument for the user ID passed in from the friendly URL.

See Also:

Constant Field Values

CURRENT_USER

public static final java.lang.String CURRENT_USER

The default value - current user.

See Also:

Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

The owning space for this control.

m_model

protected IUserRestModel m_model

The User REST model.

Constructor Detail

UserRESTControl

public UserRESTControl()

Method Detail

CheckActionSecurityAndExecute

public Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

Description copied from interface: IControl

Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace. Returning null means that the user should return to the parent AActivitySpace's current page. This method is designed to check that the user has access to perform the actions with the given parameters. If the user does not, a redirect object which has had Redirect.SetRedirectToLogin(true) called on it. If the user is the Guest, this will bounce to the login page and back to the Redirect after the user has logged on. If the user is already logged on, they will be redirected to an error page. In general, the error redirect that is returned should contain all of the query string parameters that made up the URL that originally led to the control. Checking whether or not a particular user ever has any access to the space, page, and control should be done in IPTActivitySpace.CheckBasicAccess().

Specified by:

CheckActionSecurityAndExecute in interface IControl

Returns:

Redirect where to redirect to after the control is finished executing. This will go to the login page or an error page if Redirect.SetRedirectToLogin(true) has been called.

ProcessAction

public Redirect ProcessAction(IJSONParser _parser)

This method handles parsing the JSON body and executing the appropriate command.

Parameters:

_parser - The parser with the JSON object already loaded.

Returns:

An error redirect, if necessary. Null if there were no errors.

ProcessError

public Redirect ProcessError(IRESTError _error)

This helper method sets the error on the model and redirects to the REST API display page.

Parameters:

_nErrorID - the current error code.

Returns:

The redirect to the User REST API display page.

GetDPRedirect

public Redirect GetDPRedirect()

Returns:

the redirect to the User REST API display page.

Init

public void Init(IModel model,
                 AActivitySpace space)

Description copied from interface: IControl

Initialize the control with the model it should use and it's parent AActivitySpace. This method needs to be called before any other methods. This method also clears all internal data so the control can be used again without fear of mixing data.

Specified by:

Init in interface IControl

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Returns:

the name of the object.

Create

public java.lang.Object Create()

Description copied from interface: IManagedObject

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Returns:

A new instance of the managed class (i.e. return new Foo();)