edu.internet2.middleware.shibboleth.common.relyingparty

クラス RelyingPartyConfiguration

java.lang.Object

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

public class RelyingPartyConfiguration
extends Object

A set of configuration options for a relying party.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
RelyingPartyConfiguration(String provider) Constructor.
RelyingPartyConfiguration(String relyingParty, String provider) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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.

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

RelyingPartyConfiguration

public RelyingPartyConfiguration(String provider)

Constructor.

パラメータ:

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

RelyingPartyConfiguration

public RelyingPartyConfiguration(String relyingParty,
                         String provider)

Constructor.

パラメータ:

relyingParty - ID of the relying party this configuration is for

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

メソッドの詳細

getNameIdFormatPrecedence

public String[] getNameIdFormatPrecedence()

Gets the precedence of NameID formats for this relying party.

戻り値:

precedence of NameID formats for this relying party

setNameIdFormatPrecedence

public void setNameIdFormatPrecedence(String[] precedence)

Sets the precedence of NameID formats for this relying party.

パラメータ:

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.

戻り値:

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.

パラメータ:

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.

戻り値:

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.

パラメータ:

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.

戻り値:

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.

パラメータ:

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.

戻り値:

default signing credential for the relying party

setDefaultSigningCredential

public void setDefaultSigningCredential(Credential credential)

Sets the default signing credential for the relying party.

パラメータ:

credential - default signing credential for the relying party

getProfileConfigurations

public Map<String,ProfileConfiguration> getProfileConfigurations()

Gets whether assertions should be encrypted.

戻り値:

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().

パラメータ:

profileId - unique Id of the profile

戻り値:

the profile configuration or null