org.jasig.portal.portlet.container.services
Class CasTicketUserInfoService

java.lang.Object
  extended by org.jasig.portal.portlet.container.services.CasTicketUserInfoService
All Implemented Interfaces:
org.apache.pluto.spi.ContainerService, org.apache.pluto.spi.optional.UserInfoService

public class CasTicketUserInfoService
extends Object
implements org.apache.pluto.spi.optional.UserInfoService

Requests a CAS Proxy ticket for the current portlet and adds it to the Pluto UserInfoService.

Version:
$Revision: 19776 $
Author:
Jen Bourey

Field Summary
protected  org.apache.commons.logging.Log log
           
 
Constructor Summary
CasTicketUserInfoService()
           
 
Method Summary
 IPortalRequestUtils getPortalRequestUtils()
           
 IPortletDefinitionRegistry getPortletDefinitionRegistry()
           
 IPortletEntityRegistry getPortletEntityRegistry()
           
 IPortletWindowRegistry getPortletWindowRegistry()
           
 String getProxyTicketKey()
           
 Map getUserInfo(PortletRequest request)
          Deprecated. 
 Map getUserInfo(PortletRequest request, org.apache.pluto.PortletWindow portletWindow)
           
 IUserInstanceManager getUserInstanceManager()
           
 boolean isCasProxyTicketRequested(PortletRequest request, org.apache.pluto.PortletWindow plutoPortletWindow)
          Determine whether the portlet has expects a CAS proxy ticket as one of the user attributes.
 void setPortalRequestUtils(IPortalRequestUtils portalRequestUtils)
           
 void setPortletDefinitionRegistry(IPortletDefinitionRegistry portletDefinitionRegistry)
           
 void setPortletEntityRegistry(IPortletEntityRegistry portletEntityRegistry)
           
 void setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry)
           
 void setProxyTicketKey(String proxyTicketKey)
           
 void setUserInstanceManager(IUserInstanceManager userInstanceManager)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected final org.apache.commons.logging.Log log
Constructor Detail

CasTicketUserInfoService

public CasTicketUserInfoService()
Method Detail

getPortalRequestUtils

public IPortalRequestUtils getPortalRequestUtils()
Returns:
the portalRequestUtils

setPortalRequestUtils

public void setPortalRequestUtils(IPortalRequestUtils portalRequestUtils)
Parameters:
portalRequestUtils - the portalRequestUtils to set

getUserInstanceManager

public IUserInstanceManager getUserInstanceManager()
Returns:
the UserInstanceManager

setUserInstanceManager

public void setUserInstanceManager(IUserInstanceManager userInstanceManager)
Parameters:
userInstanceManager - the UserInstanceManager

getPortletEntityRegistry

public IPortletEntityRegistry getPortletEntityRegistry()
Returns:
the portletEntityRegistry

setPortletEntityRegistry

public void setPortletEntityRegistry(IPortletEntityRegistry portletEntityRegistry)
Parameters:
portletEntityRegistry - the portletEntityRegistry to set

getPortletWindowRegistry

public IPortletWindowRegistry getPortletWindowRegistry()
Returns:
the portletWindowRegistry

setPortletWindowRegistry

public void setPortletWindowRegistry(IPortletWindowRegistry portletWindowRegistry)
Parameters:
portletWindowRegistry - the portletWindowRegistry to set

getPortletDefinitionRegistry

public IPortletDefinitionRegistry getPortletDefinitionRegistry()
Returns:
the portletDefinitionRegistry

setPortletDefinitionRegistry

public void setPortletDefinitionRegistry(IPortletDefinitionRegistry portletDefinitionRegistry)
Parameters:
portletDefinitionRegistry - the portletDefinitionRegistry to set

getProxyTicketKey

public String getProxyTicketKey()
Returns:
name of the key to save the proxy ticket under

setProxyTicketKey

public void setProxyTicketKey(String proxyTicketKey)
Parameters:
proxyTicketKey - name of the key to save the proxy ticket under

getUserInfo

@Deprecated
public Map getUserInfo(PortletRequest request)
                throws org.apache.pluto.PortletContainerException
Deprecated. 

Specified by:
getUserInfo in interface org.apache.pluto.spi.optional.UserInfoService
Throws:
org.apache.pluto.PortletContainerException

getUserInfo

public Map getUserInfo(PortletRequest request,
                       org.apache.pluto.PortletWindow portletWindow)
                throws org.apache.pluto.PortletContainerException
Specified by:
getUserInfo in interface org.apache.pluto.spi.optional.UserInfoService
Throws:
org.apache.pluto.PortletContainerException

isCasProxyTicketRequested

public boolean isCasProxyTicketRequested(PortletRequest request,
                                         org.apache.pluto.PortletWindow plutoPortletWindow)
                                  throws org.apache.pluto.PortletContainerException
Determine whether the portlet has expects a CAS proxy ticket as one of the user attributes.

Parameters:
request - portlet request
plutoPortletWindow - portlet window
Returns:
true if a CAS proxy ticket is expected, false otherwise
Throws:
org.apache.pluto.PortletContainerException - if expeced attributes cannot be determined


Copyright © 2010 Jasig. All Rights Reserved.