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.


Field Summary
private  XMLObjectBuilderFactory builderFactory
          For building XML.
private  ParserPool parserPool
          Pool of XML parsers.
private  RPManagerType rpManager
          Relying party configuration manager for the profile handler.
private  SessionManager<SessionType> sessionManager
          Session manager for the profile handler.
private  org.opensaml.util.storage.StorageService<?,?> storageService
          Profile storage service.
 
Constructor Summary
protected AbstractShibbolethProfileHandler()
          Constructor.
 
Method Summary
 XMLObjectBuilderFactory getBuilderFactory()
          Convenience method for getting the XML object builder factory.
 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.
 org.opensaml.util.storage.StorageService<?,?> getStorageService()
          Gets the storage service used to store profile data.
 void setParserPool(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.
 void setStorageService(org.opensaml.util.storage.StorageService<?,?> service)
          Sets the storage service used to store profile data.
 
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
 

Field Detail

parserPool

private ParserPool parserPool
Pool of XML parsers.


storageService

private org.opensaml.util.storage.StorageService<?,?> storageService
Profile storage service.


rpManager

private RPManagerType extends SAMLMDRelyingPartyConfigurationManager rpManager
Relying party configuration manager for the profile handler.


sessionManager

private SessionManager<SessionType extends Session> sessionManager
Session manager for the profile handler.


builderFactory

private XMLObjectBuilderFactory builderFactory
For building XML.

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 ParserPool getParserPool()
Gets the pool of XML parsers.

Returns:
pool of XML parsers.

setParserPool

public void setParserPool(ParserPool pool)
Sets the pool of XML parsers.

Parameters:
pool - pool of XML parsers

getStorageService

public org.opensaml.util.storage.StorageService<?,?> getStorageService()
Gets the storage service used to store profile data.

Returns:
storage service used to store profile data

setStorageService

public void setStorageService(org.opensaml.util.storage.StorageService<?,?> service)
Sets the storage service used to store profile data.

Parameters:
service - storage service used to store profile data

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 XMLObjectBuilderFactory getBuilderFactory()
Convenience method for getting the XML object builder factory.

Returns:
XML object builder factory


Copyright © 1999-2012. All Rights Reserved.