edu.internet2.middleware.shibboleth.common.relyingparty
Class RelyingPartyConfiguration

java.lang.Object
  extended by edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration

public class RelyingPartyConfiguration
extends Object

A set of configuration options for a relying party.


Field Summary
private  String defaultAuthenticationMethod
          Authentication method to use if none is specified within a request.
private  String[] nameIdFormatPrecedence
          Precedence ordering of NameID formats for this relying party.
private  HashMap<String,ProfileConfiguration> profiles
          Various profile configurations.
private  String providerId
          Entity ID of the responder when communicating with the relying party.
private  String relyingPartyId
          Entity ID of the relying party.
private  Credential signingCredential
          Default signing credential.
 
Constructor Summary
RelyingPartyConfiguration(String provider)
          Constructor.
RelyingPartyConfiguration(String relyingParty, String provider)
          Constructor.
 
Method Summary
 String getDefaultAuthenticationMethod()
          Gets the authentication method to use if one is not specified within a request.
 Credential getDefaultSigningCredential()
          Gets the default signing credential for the relying party.
 String[] getNameIdFormatPrecedence()
          Gets the precedence of NameID formats for this relying party.
 ProfileConfiguration getProfileConfiguration(String profileId)
          Convenience method for retrieving a given profile configuration from the Map returned by getProfileConfigurations().
 Map<String,ProfileConfiguration> getProfileConfigurations()
          Gets whether assertions should be encrypted.
 String getProviderId()
          Gets the entity ID of the responder when communicating with the relying party.
 String getRelyingPartyId()
          Gets the entity ID of the relying party this configuration is for.
 void setDefaultAuthenticationMethod(String method)
          Sets the authentication method to use if one is not specified within a request.
 void setDefaultSigningCredential(Credential credential)
          Sets the default signing credential for the relying party.
 void setNameIdFormatPrecedence(String[] precedence)
          Sets the precedence of NameID formats for this relying party.
protected  void setProviderId(String id)
          Sets the entity ID of the responder when communicating with the relying party.
protected  void setRelyingPartyId(String id)
          Sets the entity ID of the relying party this configuration is for.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

relyingPartyId

private String relyingPartyId
Entity ID of the relying party.


providerId

private String providerId
Entity ID of the responder when communicating with the relying party.


defaultAuthenticationMethod

private String defaultAuthenticationMethod
Authentication method to use if none is specified within a request.


signingCredential

private Credential signingCredential
Default signing credential.


nameIdFormatPrecedence

private String[] nameIdFormatPrecedence
Precedence ordering of NameID formats for this relying party.


profiles

private HashMap<String,ProfileConfiguration> profiles
Various profile configurations.

Constructor Detail

RelyingPartyConfiguration

public RelyingPartyConfiguration(String provider)
Constructor.

Parameters:
provider - entity ID of the responder when communicating with the relying party

RelyingPartyConfiguration

public RelyingPartyConfiguration(String relyingParty,
                                 String provider)
Constructor.

Parameters:
relyingParty - ID of the relying party this configuration is for
provider - entity ID of the responder when communicating with the relying party
Method Detail

getNameIdFormatPrecedence

public String[] getNameIdFormatPrecedence()
Gets the precedence of NameID formats for this relying party.

Returns:
precedence of NameID formats for this relying party

setNameIdFormatPrecedence

public void setNameIdFormatPrecedence(String[] precedence)
Sets the precedence of NameID formats for this relying party.

Parameters:
precedence - precedence of NameID formats for this relying party

getRelyingPartyId

public String getRelyingPartyId()
Gets the entity ID of the relying party this configuration is for.

Returns:
the entity ID of the relying party this configuration is for

setRelyingPartyId

protected void setRelyingPartyId(String id)
Sets the entity ID of the relying party this configuration is for.

Parameters:
id - entity ID of the relying party this configuration is for

getProviderId

public String getProviderId()
Gets the entity ID of the responder when communicating with the relying party.

Returns:
entity ID of the responder when communicating with the relying party

setProviderId

protected void setProviderId(String id)
Sets the entity ID of the responder when communicating with the relying party.

Parameters:
id - entity ID of the responder when communicating with the relying party

getDefaultAuthenticationMethod

public String getDefaultAuthenticationMethod()
Gets the authentication method to use if one is not specified within a request.

Returns:
authentication method to use if one is not specified within a request

setDefaultAuthenticationMethod

public void setDefaultAuthenticationMethod(String method)
Sets the authentication method to use if one is not specified within a request.

Parameters:
method - authentication method to use if one is not specified within a request

getDefaultSigningCredential

public Credential getDefaultSigningCredential()
Gets the default signing credential for the relying party. This is provided as a convenience method so that this credential need not be defined on every signing supporting profile configuration. If a profile configuration has a defined signing credential it must be used in place of the credential retrieved here.

Returns:
default signing credential for the relying party

setDefaultSigningCredential

public void setDefaultSigningCredential(Credential credential)
Sets the default signing credential for the relying party.

Parameters:
credential - default signing credential for the relying party

getProfileConfigurations

public Map<String,ProfileConfiguration> getProfileConfigurations()
Gets whether assertions should be encrypted.

Returns:
configuration for specific communication profiles used by the system indexed by profile ID

getProfileConfiguration

public ProfileConfiguration getProfileConfiguration(String profileId)
Convenience method for retrieving a given profile configuration from the Map returned by getProfileConfigurations().

Parameters:
profileId - unique Id of the profile
Returns:
the profile configuration or null


Copyright © 1999-2012. All Rights Reserved.