com.ibm.portal.state.service.parameters
Interface CorStateParameterServiceHome

public interface CorStateParameterServiceHome

Home interface that can be looked up via JNDI and that provides access to the state parameter service.

Accessing the service:

     CorStateParameterServiceHome home;
     javax.naming.Context ctx = new javax.naming.InitialContext();
     try {
          home = (CorStateParameterServiceHome) 
             ctx.lookup(CorStateParameterServiceHome);
     } catch(javax.naming.NameNotFoundException ex) {
          ... error handling ...
     }
     ...
     // request the service via the home interface
     final StateParameterService service = home.getStateParameterService(corCtx);
     try{
          // manipulate parameters
          ...
       } finally {
          // Dispose the service
          service.dispose();
       }
 

Since:

7.0.0.1

Field Summary

static java.lang.String

JNDI_NAME JNDI name under which the home instance is bound

Method Summary

StateParameterService	getStateParameterService(Context ctx) Returns the state parameter service.
StateParameterService	getStateParameterService(StateHolder state, Context ctx) Returns the state parameter service.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

JNDI name under which the home instance is bound

See Also:

Constant Field Values

Method Detail

getStateParameterService

StateParameterService getStateParameterService(Context ctx)
                                               throws StateParameterException,
                                                      StateNotInRequestException

Returns the state parameter service.

Parameters:

ctx - The COR context

Returns:

the state parameter service, never null

Throws:

StateNotInRequestException - if no state could be associated with the request

StateParameterException - thrown if the initialization of the StateParameterService fails.

getStateParameterService

StateParameterService getStateParameterService(StateHolder state,
                                               Context ctx)
                                               throws StateParameterException

Returns the state parameter service.

Parameters:

state - state that the service operates on, not null

ctx - The COR context

Returns:

the state parameter service, never null

Throws:

StateParameterException - thrown if the initialization of the StateParameterService fails.

Since:

8.5