com.ibm.portal.state.accessors.action.engine.login
Interface LoginActionAccessorFactory

All Superinterfaces:

AccessorFactory

public interface LoginActionAccessorFactory
extends AccessorFactory

Factory interface which provides methods to obtain controllers that allow to set a "Login" action upon the given state holder or document model.
For instance the controllers may be used to create EngineURLs that trigger the portal login. Just request a controller that operates on the state holder /document model that has been associated with the respective EngineURL. NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:

5.1

Method Summary

LoginActionAccessorController	newLoginActionController(javax.servlet.http.HttpServletRequest request, StateHolderController state) Returns a LoginActionActionAccessorController in order to include a "Login" action into the state holder.
LoginActionAccessorController	newLoginActionController(Node action, DocumentController model) Returns a LoginActionAccessorController in order to include a "Login" action into the state holder. This controller should be used in case that no servlet request is available, e.g.
LoginActionAccessorController	newLoginActionController(StateHolderController state) Returns a LoginActionActionAccessorController in order to include a "Login" action into the state holder. This controller should be used in case that no servlet request is available, e.g.

Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory

compact

Method Detail

newLoginActionController

LoginActionAccessorController newLoginActionController(StateHolderController state)

Returns a LoginActionActionAccessorController in order to include a "Login" action into the state holder.
This controller should be used in case that no servlet request is available, e.g. when generating a URL from within an EJB. Otherwise a controller should be requested via newLoginActionController(HttpServletRequest, StateHolderController).

Parameters:

state - Read-write interface to an untyped state document model. Must not be null.

Returns:

A LoginActionAccessorController instance.

newLoginActionController

LoginActionAccessorController newLoginActionController(javax.servlet.http.HttpServletRequest request,
                                                       StateHolderController state)

Returns a LoginActionActionAccessorController in order to include a "Login" action into the state holder.

Parameters:

request - The current servlet request. Must not be null.

state - Read-write interface to an untyped state document model. Must not be null.

Returns:

A LoginActionAccessorController instance.

newLoginActionController

LoginActionAccessorController newLoginActionController(Node action,
                                                       DocumentController model)

Returns a LoginActionAccessorController in order to include a "Login" action into the state holder.
This controller should be used in case that no servlet request is available, e.g. when generating a URL from within an EJB. Otherwise a controller should be requested via newLoginActionController(HttpServletRequest, StateHolderController).

Parameters:

action - Node representing the "Login" action element (must not be null).

model - The state document model which contains root.

Returns:

A LoginActionAccessorController instance.