|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortalStateParameterServiceHome
Home interface that can be looked up via JNDI and that provides access to the state parameter service.
Accessing the service:
PortalStateParameterServiceHome home; javax.naming.Context ctx = new javax.naming.InitialContext(); try { home = (PortalStateParameterServiceHome) ctx.lookup(PortalStateParameterServiceHome.JNDI_NAME); } catch(javax.naming.NameNotFoundException ex) { ... error handling ... } ... // request the service via the home interface final StateParameterService service = home.getStateParameterService(request, response); try{ // manipulate parameters ... } finally { // Dispose the service service.dispose(); }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.
Field Summary | |
---|---|
static java.lang.String |
JNDI_NAME
JNDI name under which the home instance is bound |
Method Summary | |
---|---|
StateParameterService |
getStateParameterService(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp)
Returns the state parameter service. |
StateParameterService |
getStateParameterService(StateHolder state,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp)
Returns the state parameter service. |
Field Detail |
---|
static final java.lang.String JNDI_NAME
Method Detail |
---|
StateParameterService getStateParameterService(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws StateParameterException, StateNotInRequestException
req
- The current servlet requestresp
- The current serlvet response
null
StateNotInRequestException
- if no state could be associated with the request
StateParameterException
- thrown if the initialization of the
StateParameterService
fails.StateParameterService getStateParameterService(StateHolder state, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws StateParameterException
state
- state to work onreq
- The current servlet requestresp
- The current serlvet response
null
StateParameterException
- thrown if the initialization of the
StateParameterService
fails.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |