edu.internet2.middleware.shibboleth.common.profile.provider
Class AbstractShibbolethProfileHandler<RPManagerType extends SAMLMDRelyingPartyConfigurationManager,SessionType extends Session>

java.lang.Object
  extended by edu.internet2.middleware.shibboleth.common.profile.provider.AbstractRequestURIMappedProfileHandler<org.opensaml.ws.transport.http.HTTPInTransport,org.opensaml.ws.transport.http.HTTPOutTransport>
      extended by edu.internet2.middleware.shibboleth.common.profile.provider.AbstractShibbolethProfileHandler<RPManagerType,SessionType>
Type Parameters:
RPManagerType - type of relying party configuration manager used by this profile handler
SessionType - type of sessions managed by the session manager used by this profile handler
All Implemented Interfaces:
ProfileHandler<org.opensaml.ws.transport.http.HTTPInTransport,org.opensaml.ws.transport.http.HTTPOutTransport>

public abstract class AbstractShibbolethProfileHandler<RPManagerType extends SAMLMDRelyingPartyConfigurationManager,SessionType extends Session>
extends AbstractRequestURIMappedProfileHandler<org.opensaml.ws.transport.http.HTTPInTransport,org.opensaml.ws.transport.http.HTTPOutTransport>

A processor for a communication profile supported by Shibboleth. Profile handlers must be stateless and thread-safe as a single instance may be used to service every incoming request.


Constructor Summary
protected AbstractShibbolethProfileHandler()
          Constructor.
 
Method Summary
 org.opensaml.xml.XMLObjectBuilderFactory getBuilderFactory()
          Convenience method for getting the XML object builder factory.
 org.opensaml.xml.parse.ParserPool getParserPool()
          Gets the pool of XML parsers.
 ProfileConfiguration getProfileConfiguration(String relyingPartyId, String profileId)
          Gets the profile configuration for the given entity and profile Id.
abstract  String getProfileId()
          Gets the ID of the profile supported by this handler.
 RelyingPartyConfiguration getRelyingPartyConfiguration(String relyingPartyId)
          Gets the relying party configuration for the given entity.
 RPManagerType getRelyingPartyConfigurationManager()
          Gets the relying party manager for this profile handler.
 SessionManager<SessionType> getSessionManager()
          Gets the session manager for this profile handler.
 void setParserPool(org.opensaml.xml.parse.ParserPool pool)
          Sets the pool of XML parsers.
 void setRelyingPartyConfigurationManager(RPManagerType manager)
          Sets the relying party manager for this profile handler.
 void setSessionManager(SessionManager<SessionType> manager)
          Sets the session manager for this profile handler.
 
Methods inherited from class edu.internet2.middleware.shibboleth.common.profile.provider.AbstractRequestURIMappedProfileHandler
getRequestPaths, setRequestPaths
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface edu.internet2.middleware.shibboleth.common.profile.ProfileHandler
processRequest
 

Constructor Detail

AbstractShibbolethProfileHandler

protected AbstractShibbolethProfileHandler()
Constructor.

Method Detail

getProfileId

public abstract String getProfileId()
Gets the ID of the profile supported by this handler.

Returns:
ID of the profile supported by this handler

getParserPool

public org.opensaml.xml.parse.ParserPool getParserPool()
Gets the pool of XML parsers.

Returns:
pool of XML parsers.

setParserPool

public void setParserPool(org.opensaml.xml.parse.ParserPool pool)
Sets the pool of XML parsers.

Parameters:
pool - pool of XML parsers

getRelyingPartyConfigurationManager

public RPManagerType getRelyingPartyConfigurationManager()
Gets the relying party manager for this profile handler.

Returns:
relying party manager for this profile handler

setRelyingPartyConfigurationManager

public void setRelyingPartyConfigurationManager(RPManagerType manager)
Sets the relying party manager for this profile handler.

Parameters:
manager - relying party manager for this profile handler

getRelyingPartyConfiguration

public RelyingPartyConfiguration getRelyingPartyConfiguration(String relyingPartyId)
Gets the relying party configuration for the given entity. This is only a convenience method and is equivalent to retrieving the relying party configuration by invoking getRelyingPartyConfigurationManager() and then invoking RelyingPartyConfigurationManager.getRelyingPartyConfiguration(String).

Parameters:
relyingPartyId - ID of the relying party
Returns:
the relying party configuration or null

getProfileConfiguration

public ProfileConfiguration getProfileConfiguration(String relyingPartyId,
                                                    String profileId)
Gets the profile configuration for the given entity and profile Id. This is only a convenience method and is equivalent to retrieving the relying party configuration by invoking getRelyingPartyConfiguration(String) following by RelyingPartyConfiguration.getProfileConfiguration(String)

Parameters:
relyingPartyId - ID of the relying party
profileId - unique ID of the profile
Returns:
the profile configuration or null

getSessionManager

public SessionManager<SessionType> getSessionManager()
Gets the session manager for this profile handler.

Returns:
session manager for this profile handler

setSessionManager

public void setSessionManager(SessionManager<SessionType> manager)
Sets the session manager for this profile handler.

Parameters:
manager - session manager for this profile handler

getBuilderFactory

public org.opensaml.xml.XMLObjectBuilderFactory getBuilderFactory()
Convenience method for getting the XML object builder factory.

Returns:
XML object builder factory


Copyright © 2006-2008 Internet2. All Rights Reserved.