|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ImpersonationService
Portlet service for JSR compliant portlets to leverage the impersonation
functionality of WebSphere Portal.
The following sample shows how to perform the JNDI lookup to acquire a
service object:
com.ibm.portal.portlet.service.PortletServiceHome psh; javax.naming.Context ctx = new javax.naming.InitialContext(); try { psh = (PortletServiceHome) ctx.lookup(ImpersonationService.JNDI_NAME); } catch(javax.naming.NameNotFoundException ex) { // error handling } // obtain the service object and use the service ImpersonationService impersonationService = (ImpersonationService) psh.getPortletService(ImpersonationService.class); try { impersonationService.doImpersonate(request, response, request.getParameter(FORM_TEXT)); } catch (Exception e) { // error handling }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
The name can be used to lookup the ImpersonationService from JNDI |
Method Summary | |
---|---|
void |
doImpersonate(javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse,
java.lang.String impUserDN)
This method starts the impersonation. |
void |
doImpersonate(javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse,
com.ibm.portal.um.User impUser)
This method starts the impersonation. |
void |
doImpersonate(javax.portlet.PortletRequest portletRequest,
javax.portlet.PortletResponse portletResponse,
java.lang.String impUserDN)
Deprecated. since 7.0 use doImpersonate(ActionRequest, ActionResponse, String) instead |
void |
doImpersonate(javax.portlet.PortletRequest portletRequest,
javax.portlet.PortletResponse portletResponse,
com.ibm.portal.um.User impUser)
Deprecated. since 7.0 use doImpersonate(ActionRequest, ActionResponse, User) instead |
com.ibm.portal.um.User |
getOriginalUser()
This method returns the original user that has logged in. |
boolean |
isUserImpersonated()
This method indicates whether the current user has been impersonated or he is acting on its own behalf. |
void |
loginOriginalUser(javax.portlet.ActionRequest aRequest,
javax.portlet.ActionResponse aResponse)
This method ends the impersonation. |
void |
loginOriginalUser(javax.servlet.http.HttpServletRequest aRequest,
javax.servlet.http.HttpServletResponse aResponse)
Deprecated. since 7.0 use com.ibm.portal.impersonation.ImpersonationService#loginOriginalUser(HttpServletRequest, HttpServletResponse) instead |
Field Detail |
---|
static final java.lang.String JNDI_NAME
ImpersonationService
from JNDI
Method Detail |
---|
void doImpersonate(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse, java.lang.String impUserDN) throws ImpersonationException
doImpersonate(ActionRequest, ActionResponse, String)
instead
isUserImpersonated()
returns true), an
ImpersonationExcetion
will be thrown.
portletRequest
- The current PortletRequest
.portletResponse
- The current PortletResponse
.impUserDN
- The user DN to be impersonated
ImpersonationException
- If impersonation fails, e.g. if the current user is already
impersonated or does not have sufficient privileges to perform the
impersonation.void doImpersonate(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse, java.lang.String impUserDN) throws ImpersonationException
isUserImpersonated()
returns true), an
ImpersonationExcetion
will be thrown.
actionRequest
- The current ActionRequest
.actionResponse
- The current ActionResponse
.impUserDN
- The user DN to be impersonated
ImpersonationException
- If impersonation fails, e.g. if the current user is already
impersonated or does not have sufficient privileges to perform the
impersonation.void doImpersonate(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse, com.ibm.portal.um.User impUser) throws ImpersonationException
doImpersonate(ActionRequest, ActionResponse, User)
instead
isUserImpersonated()
returns true), an
ImpersonationExcetion
will be thrown.
portletRequest
- The current PortletRequest
.portletResponse
- The current PortletResponse
.impUser
- The user to be impersonated
ImpersonationException
- If impersonation fails, e.g. if the current user is already
impersonated or does not have sufficient privileges to perform the
impersonation.void doImpersonate(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse, com.ibm.portal.um.User impUser) throws ImpersonationException
isUserImpersonated()
returns true), an
ImpersonationExcetion
will be thrown.
actionRequest
- The current ActionRequest
.actionResponse
- The current ActionResponse
.impUser
- The user to be impersonated
ImpersonationException
- If impersonation fails, e.g. if the current user is already
impersonated or does not have sufficient privileges to perform the
impersonation.void loginOriginalUser(javax.servlet.http.HttpServletRequest aRequest, javax.servlet.http.HttpServletResponse aResponse) throws ImpersonationException
servletRequest
- The current HttpServletRequest
.servletResponse
- The current HttpServletResponse
.
ImpersonationException
- If impersonation fails.void loginOriginalUser(javax.portlet.ActionRequest aRequest, javax.portlet.ActionResponse aResponse) throws ImpersonationException
portletRequest
- The current PortletRequest
.portletResponse
- The current PortletResponse
.
ImpersonationException
- If impersonation fails.boolean isUserImpersonated() throws ImpersonationException
ImpersonationException
- if impersonation status could not be determined.com.ibm.portal.um.User getOriginalUser() throws ImpersonationException
#loginOriginalUser(PortletRequest, PortletResponse)
is be called.
ImpersonationException
- if the original user could not be determined.isUserImpersonated() to evaluate if
impersonation has been executed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |