+

Search Tips   |   Advanced Search

 PREV CLASS   NEXT CLASS
Tree 
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.portal.state.accessors
Interface StateAccessorController

All Superinterfaces:
Accessor, Disposable, StateAccessor
public interface StateAccessorController
extends StateAccessor

Provides read-write access to the state holder based on a given request. 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
 javax.xml.transform.Result createResult(javax.servlet.http.HttpServletRequest req)
          Return a serializer from XML to StateHolderController.
 javax.xml.transform.Result createResult(StateHolderController state)
          Return a serializer from XML to StateHolderController.
 StateHolderController getStateHolderController(javax.servlet.http.HttpServletRequest req)
          Retrieves the read-write state holder from the request
 
Methods inherited from interface com.ibm.portal.state.accessors.StateAccessor
createSource, createSource, getStateHolder
 
Methods inherited from interface com.ibm.portal.Disposable
dispose
 

Method Detail

getStateHolderController

StateHolderController getStateHolderController(javax.servlet.http.HttpServletRequest req)
                                               throws StateNotWriteableException,
                                                      StateNotInRequestException
Retrieves the read-write state holder from the request

Parameters:
req - servlet request (must not be null)
Returns:
state holder that is associated with the request. The state holder does not need to be disposed if retrieved via this method.
Throws:
StateNotWriteableException - - if a state holder could be associated with a request but the state is read-only
StateNotInRequestException - - if no state could be associated with the request

createResult

javax.xml.transform.Result createResult(javax.servlet.http.HttpServletRequest req)
                                        throws StateNotWriteableException,
                                               StateNotInRequestException
Returns a serializer from XML to StateHolderController. The serialization format is that generated by StateAccessor#getSource(HttpServletRequest).

Parameters:
req - servlet request (must not be null)
Returns:
state holder that is associated with the request. The state holder does not need to be disposed if retrieved via this method.
Throws:
StateNotWriteableException - - if a state holder could be associated with a request but the state is read-only
StateNotInRequestException - - if no state could be associated with the request
Since:
8.0.0.1

createResult

javax.xml.transform.Result createResult(StateHolderController state)
Returns a serializer from XML to StateHolderController. The serialization format is that returned by StateAccessor#getSource(StateHolder).

Parameters:
state - the state holder controller, not null
Returns:
the XML representation
Since:
8.0.0.1
 PREV CLASS   NEXT CLASS
Tree 
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD