com.netscape.pm.model
Interface IPMRequest

public interface IPMRequest

Defines an object to provide client request information. An IPMRequest object provides parameter name and values received from an input stream. This interface serves as a thin-layer wrapper around a ServletRequest object, but allows the engine to remain loosely coupled to whatever request transport mechanism is currently being employed.

The UI layer bundled with the engine currently uses an object that implements this interface when passing the request through to a field's update method. Users may find it helpful to use the PMRequestFactory class to create a request object from an HttpServletRequest.

See Also:

com.netscape.pm.model.PMRequest, PMRequestFactory

Method Summary

java.lang.String	getAuthenticatedUserId() Returns the authentication user id for this session.
java.lang.String	getParameter(java.lang.String name) Returns the value for the specified parameter.
boolean	isParameterDefined(java.lang.String name) Returns true if the parameter is defined.

Method Detail

getParameter

public java.lang.String getParameter(java.lang.String name)
                              throws PMException

Returns the value for the specified parameter.

Parameters:

name - the name of the parameter

Returns:

the value for the specified parameter.

Throws:

PMException - if no such parameter exists.

Since:

PAE 4.0

isParameterDefined

public boolean isParameterDefined(java.lang.String name)

Returns true if the parameter is defined.

Parameters:

name - the name of the parameter

Returns:

true if the parameter is defined; false otherwise.

Since:

PM 6.0

getAuthenticatedUserId

public java.lang.String getAuthenticatedUserId()
                                        throws PMException

Returns the authentication user id for this session. The authenticated user represents the corporate directory user that has successfully authenticated with the EJB container.

Returns:

the authenticated user id for this session.

Throws:

PMException - if no such parameter exists.

Since:

PAE 4.0