SettingsBuilder (OneLogin java-saml Toolkit Core 2.8.0 API)

java.lang.Object
- com.onelogin.saml2.settings.SettingsBuilder

```
public class SettingsBuilder
extends Object
```
SettingsBuilder class of OneLogin's Java Toolkit. A class that implements the settings builder

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CERTFINGERPRINT_ALGORITHM_PROPERTY_KEY`
`static String`	`CERTFINGERPRINT_PROPERTY_KEY`
`static String`	`COMPRESS_REQUEST`
`static String`	`COMPRESS_RESPONSE`
`static String`	`CONTACT_SUPPORT_EMAIL_ADDRESS`
`static String`	`CONTACT_SUPPORT_GIVEN_NAME`
`static String`	`CONTACT_TECHNICAL_EMAIL_ADDRESS`
`static String`	`CONTACT_TECHNICAL_GIVEN_NAME`
`static String`	`DEBUG_PROPERTY_KEY`
`static String`	`IDP_ENTITYID_PROPERTY_KEY`
`static String`	`IDP_SINGLE_LOGOUT_SERVICE_BINDING_PROPERTY_KEY`
`static String`	`IDP_SINGLE_LOGOUT_SERVICE_RESPONSE_URL_PROPERTY_KEY`
`static String`	`IDP_SINGLE_LOGOUT_SERVICE_URL_PROPERTY_KEY`
`static String`	`IDP_SINGLE_SIGN_ON_SERVICE_BINDING_PROPERTY_KEY`
`static String`	`IDP_SINGLE_SIGN_ON_SERVICE_URL_PROPERTY_KEY`
`static String`	`IDP_X509CERT_PROPERTY_KEY`
`static String`	`IDP_X509CERTMULTI_PROPERTY_KEY`
`static String`	`KEYSTORE_ALIAS`
`static String`	`KEYSTORE_KEY`
`static String`	`KEYSTORE_KEY_PASSWORD`
`static String`	`ORGANIZATION_DISPLAYNAME`
`static String`	`ORGANIZATION_LANG`
`static String`	`ORGANIZATION_NAME`
`static String`	`ORGANIZATION_URL`
`static String`	`PARSING_TRIM_ATTRIBUTE_VALUES`
`static String`	`PARSING_TRIM_NAME_IDS`
`static String`	`SECURITY_ALLOW_REPEAT_ATTRIBUTE_NAME_PROPERTY_KEY`
`static String`	`SECURITY_AUTHREQUEST_SIGNED`
`static String`	`SECURITY_DIGEST_ALGORITHM`
`static String`	`SECURITY_LOGOUTREQUEST_SIGNED`
`static String`	`SECURITY_LOGOUTRESPONSE_SIGNED`
`static String`	`SECURITY_NAMEID_ENCRYPTED`
`static String`	`SECURITY_REJECT_DEPRECATED_ALGORITHM`
`static String`	`SECURITY_REJECT_UNSOLICITED_RESPONSES_WITH_INRESPONSETO`
`static String`	`SECURITY_REQUESTED_AUTHNCONTEXT`
`static String`	`SECURITY_REQUESTED_AUTHNCONTEXTCOMPARISON`
`static String`	`SECURITY_SIGN_METADATA`
`static String`	`SECURITY_SIGNATURE_ALGORITHM`
`static String`	`SECURITY_WANT_ASSERTIONS_ENCRYPTED`
`static String`	`SECURITY_WANT_ASSERTIONS_SIGNED`
`static String`	`SECURITY_WANT_MESSAGES_SIGNED`
`static String`	`SECURITY_WANT_NAMEID`
`static String`	`SECURITY_WANT_NAMEID_ENCRYPTED`
`static String`	`SECURITY_WANT_XML_VALIDATION`
`static String`	`SP_ASSERTION_CONSUMER_SERVICE_BINDING_PROPERTY_KEY`
`static String`	`SP_ASSERTION_CONSUMER_SERVICE_URL_PROPERTY_KEY`
`static String`	`SP_ENTITYID_PROPERTY_KEY`
`static String`	`SP_NAMEIDFORMAT_PROPERTY_KEY`
`static String`	`SP_PRIVATEKEY_PROPERTY_KEY`
`static String`	`SP_SINGLE_LOGOUT_SERVICE_BINDING_PROPERTY_KEY`
`static String`	`SP_SINGLE_LOGOUT_SERVICE_URL_PROPERTY_KEY`
`static String`	`SP_X509CERT_PROPERTY_KEY`
`static String`	`SP_X509CERTNEW_PROPERTY_KEY`
`static String`	`STRICT_PROPERTY_KEY`
`static String`	`UNIQUE_ID_PREFIX_PROPERTY_KEY`

Constructor Summary

Constructors
Constructor and Description

SettingsBuilder()

Constructors
Constructor and Description
`SettingsBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Saml2Settings`	`build()` Builds the Saml2Settings object.
`Saml2Settings`	`build(Saml2Settings saml2Setting)` Builds the Saml2Settings object.
`SettingsBuilder`	`fromFile(String propFileName)` Load settings from the file
`SettingsBuilder`	`fromFile(String propFileName, KeyStoreSettings keyStoreSetting)` Load settings from the file
`SettingsBuilder`	`fromProperties(Properties prop)` Loads the settings from a properties object
`SettingsBuilder`	`fromValues(Map<String,Object> samlData)` Loads the settings from mapped values.
`SettingsBuilder`	`fromValues(Map<String,Object> samlData, KeyStoreSettings keyStoreSetting)` Loads the settings from mapped values and KeyStore settings.
`protected X509Certificate`	`getCertificateFromKeyStore(KeyStore keyStore, String alias, String password)`
`protected PrivateKey`	`getPrivateKeyFromKeyStore(KeyStore keyStore, String alias, String password)`
`protected X509Certificate`	`loadCertificateFromProp(Object propValue)` Loads a property of the type X509Certificate from the property value
`protected X509Certificate`	`loadCertificateFromProp(String propertyKey)` Loads a property of the type X509Certificate from the Properties object
`protected PrivateKey`	`loadPrivateKeyFromProp(String propertyKey)` Loads a property of the type PrivateKey from the Properties object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STRICT_PROPERTY_KEY
```
public static final String STRICT_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - DEBUG_PROPERTY_KEY
```
public static final String DEBUG_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_ENTITYID_PROPERTY_KEY
```
public static final String SP_ENTITYID_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_ASSERTION_CONSUMER_SERVICE_URL_PROPERTY_KEY
```
public static final String SP_ASSERTION_CONSUMER_SERVICE_URL_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_ASSERTION_CONSUMER_SERVICE_BINDING_PROPERTY_KEY
```
public static final String SP_ASSERTION_CONSUMER_SERVICE_BINDING_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_SINGLE_LOGOUT_SERVICE_URL_PROPERTY_KEY
```
public static final String SP_SINGLE_LOGOUT_SERVICE_URL_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_SINGLE_LOGOUT_SERVICE_BINDING_PROPERTY_KEY
```
public static final String SP_SINGLE_LOGOUT_SERVICE_BINDING_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_NAMEIDFORMAT_PROPERTY_KEY
```
public static final String SP_NAMEIDFORMAT_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_X509CERT_PROPERTY_KEY
```
public static final String SP_X509CERT_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_PRIVATEKEY_PROPERTY_KEY
```
public static final String SP_PRIVATEKEY_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SP_X509CERTNEW_PROPERTY_KEY
```
public static final String SP_X509CERTNEW_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - KEYSTORE_KEY
```
public static final String KEYSTORE_KEY
```
    See Also:
    
    Constant Field Values
  - KEYSTORE_ALIAS
```
public static final String KEYSTORE_ALIAS
```
    See Also:
    
    Constant Field Values
  - KEYSTORE_KEY_PASSWORD
```
public static final String KEYSTORE_KEY_PASSWORD
```
    See Also:
    
    Constant Field Values
  - IDP_ENTITYID_PROPERTY_KEY
```
public static final String IDP_ENTITYID_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - IDP_SINGLE_SIGN_ON_SERVICE_URL_PROPERTY_KEY
```
public static final String IDP_SINGLE_SIGN_ON_SERVICE_URL_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - IDP_SINGLE_SIGN_ON_SERVICE_BINDING_PROPERTY_KEY
```
public static final String IDP_SINGLE_SIGN_ON_SERVICE_BINDING_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - IDP_SINGLE_LOGOUT_SERVICE_URL_PROPERTY_KEY
```
public static final String IDP_SINGLE_LOGOUT_SERVICE_URL_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - IDP_SINGLE_LOGOUT_SERVICE_RESPONSE_URL_PROPERTY_KEY
```
public static final String IDP_SINGLE_LOGOUT_SERVICE_RESPONSE_URL_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - IDP_SINGLE_LOGOUT_SERVICE_BINDING_PROPERTY_KEY
```
public static final String IDP_SINGLE_LOGOUT_SERVICE_BINDING_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - IDP_X509CERT_PROPERTY_KEY
```
public static final String IDP_X509CERT_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - IDP_X509CERTMULTI_PROPERTY_KEY
```
public static final String IDP_X509CERTMULTI_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - CERTFINGERPRINT_PROPERTY_KEY
```
public static final String CERTFINGERPRINT_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - CERTFINGERPRINT_ALGORITHM_PROPERTY_KEY
```
public static final String CERTFINGERPRINT_ALGORITHM_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SECURITY_NAMEID_ENCRYPTED
```
public static final String SECURITY_NAMEID_ENCRYPTED
```
    See Also:
    
    Constant Field Values
  - SECURITY_AUTHREQUEST_SIGNED
```
public static final String SECURITY_AUTHREQUEST_SIGNED
```
    See Also:
    
    Constant Field Values
  - SECURITY_LOGOUTREQUEST_SIGNED
```
public static final String SECURITY_LOGOUTREQUEST_SIGNED
```
    See Also:
    
    Constant Field Values
  - SECURITY_LOGOUTRESPONSE_SIGNED
```
public static final String SECURITY_LOGOUTRESPONSE_SIGNED
```
    See Also:
    
    Constant Field Values
  - SECURITY_WANT_MESSAGES_SIGNED
```
public static final String SECURITY_WANT_MESSAGES_SIGNED
```
    See Also:
    
    Constant Field Values
  - SECURITY_WANT_ASSERTIONS_SIGNED
```
public static final String SECURITY_WANT_ASSERTIONS_SIGNED
```
    See Also:
    
    Constant Field Values
  - SECURITY_WANT_ASSERTIONS_ENCRYPTED
```
public static final String SECURITY_WANT_ASSERTIONS_ENCRYPTED
```
    See Also:
    
    Constant Field Values
  - SECURITY_WANT_NAMEID
```
public static final String SECURITY_WANT_NAMEID
```
    See Also:
    
    Constant Field Values
  - SECURITY_WANT_NAMEID_ENCRYPTED
```
public static final String SECURITY_WANT_NAMEID_ENCRYPTED
```
    See Also:
    
    Constant Field Values
  - SECURITY_SIGN_METADATA
```
public static final String SECURITY_SIGN_METADATA
```
    See Also:
    
    Constant Field Values
  - SECURITY_REQUESTED_AUTHNCONTEXT
```
public static final String SECURITY_REQUESTED_AUTHNCONTEXT
```
    See Also:
    
    Constant Field Values
  - SECURITY_REQUESTED_AUTHNCONTEXTCOMPARISON
```
public static final String SECURITY_REQUESTED_AUTHNCONTEXTCOMPARISON
```
    See Also:
    
    Constant Field Values
  - SECURITY_WANT_XML_VALIDATION
```
public static final String SECURITY_WANT_XML_VALIDATION
```
    See Also:
    
    Constant Field Values
  - SECURITY_SIGNATURE_ALGORITHM
```
public static final String SECURITY_SIGNATURE_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - SECURITY_DIGEST_ALGORITHM
```
public static final String SECURITY_DIGEST_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - SECURITY_REJECT_UNSOLICITED_RESPONSES_WITH_INRESPONSETO
```
public static final String SECURITY_REJECT_UNSOLICITED_RESPONSES_WITH_INRESPONSETO
```
    See Also:
    
    Constant Field Values
  - SECURITY_ALLOW_REPEAT_ATTRIBUTE_NAME_PROPERTY_KEY
```
public static final String SECURITY_ALLOW_REPEAT_ATTRIBUTE_NAME_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - SECURITY_REJECT_DEPRECATED_ALGORITHM
```
public static final String SECURITY_REJECT_DEPRECATED_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - COMPRESS_REQUEST
```
public static final String COMPRESS_REQUEST
```
    See Also:
    
    Constant Field Values
  - COMPRESS_RESPONSE
```
public static final String COMPRESS_RESPONSE
```
    See Also:
    
    Constant Field Values
  - PARSING_TRIM_NAME_IDS
```
public static final String PARSING_TRIM_NAME_IDS
```
    See Also:
    
    Constant Field Values
  - PARSING_TRIM_ATTRIBUTE_VALUES
```
public static final String PARSING_TRIM_ATTRIBUTE_VALUES
```
    See Also:
    
    Constant Field Values
  - CONTACT_TECHNICAL_GIVEN_NAME
```
public static final String CONTACT_TECHNICAL_GIVEN_NAME
```
    See Also:
    
    Constant Field Values
  - CONTACT_TECHNICAL_EMAIL_ADDRESS
```
public static final String CONTACT_TECHNICAL_EMAIL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - CONTACT_SUPPORT_GIVEN_NAME
```
public static final String CONTACT_SUPPORT_GIVEN_NAME
```
    See Also:
    
    Constant Field Values
  - CONTACT_SUPPORT_EMAIL_ADDRESS
```
public static final String CONTACT_SUPPORT_EMAIL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - ORGANIZATION_NAME
```
public static final String ORGANIZATION_NAME
```
    See Also:
    
    Constant Field Values
  - ORGANIZATION_DISPLAYNAME
```
public static final String ORGANIZATION_DISPLAYNAME
```
    See Also:
    
    Constant Field Values
  - ORGANIZATION_URL
```
public static final String ORGANIZATION_URL
```
    See Also:
    
    Constant Field Values
  - ORGANIZATION_LANG
```
public static final String ORGANIZATION_LANG
```
    See Also:
    
    Constant Field Values
  - UNIQUE_ID_PREFIX_PROPERTY_KEY
```
public static final String UNIQUE_ID_PREFIX_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SettingsBuilder
```
public SettingsBuilder()
```
- Method Detail
  - fromFile
```
public SettingsBuilder fromFile(String propFileName)
                         throws Error,
                                IOException
```
    Load settings from the file
    
    Parameters:
    
    propFileName - OneLogin_Saml2_Settings
    
    Returns:
    
    the SettingsBuilder object with the settings loaded from the file
    
    Throws:
    
    IOException
    
    Error
  - fromFile
```
public SettingsBuilder fromFile(String propFileName,
                                KeyStoreSettings keyStoreSetting)
                         throws Error,
                                IOException
```
    Load settings from the file
    
    Parameters:
    
    propFileName - OneLogin_Saml2_Settings
    
    keyStoreSetting - KeyStore which have the Private/Public keys
    
    Returns:
    
    the SettingsBuilder object with the settings loaded from the file
    
    Throws:
    
    IOException
    
    Error
  - fromProperties
```
public SettingsBuilder fromProperties(Properties prop)
```
    Loads the settings from a properties object
    
    Parameters:
    
    prop - contains the properties
    
    Returns:
    
    the SettingsBuilder object with the settings loaded from the prop object
  - fromValues
```
public SettingsBuilder fromValues(Map<String,Object> samlData)
```
    Loads the settings from mapped values.
    
    Parameters:
    
    samlData - Mapped values.
    
    Returns:
    
    the SettingsBuilder object with the settings loaded from the prop object
  - fromValues
```
public SettingsBuilder fromValues(Map<String,Object> samlData,
                                  KeyStoreSettings keyStoreSetting)
```
    Loads the settings from mapped values and KeyStore settings.
    
    Parameters:
    
    samlData - Mapped values.
    
    keyStoreSetting - KeyStore model
    
    Returns:
    
    the SettingsBuilder object with the settings loaded from the prop object
  - build
```
public Saml2Settings build()
```
    Builds the Saml2Settings object. Read the Properties object and set all the SAML settings
    
    Returns:
    
    the Saml2Settings object with all the SAML settings loaded
  - build
```
public Saml2Settings build(Saml2Settings saml2Setting)
```
    Builds the Saml2Settings object. Read the Properties object and set all the SAML settings
    
    Parameters:
    
    saml2Setting - an existing Saml2Settings
    
    Returns:
    
    the Saml2Settings object with all the SAML settings loaded
  - getPrivateKeyFromKeyStore
```
protected PrivateKey getPrivateKeyFromKeyStore(KeyStore keyStore,
                                               String alias,
                                               String password)
```
  - getCertificateFromKeyStore
```
protected X509Certificate getCertificateFromKeyStore(KeyStore keyStore,
                                                     String alias,
                                                     String password)
```
  - loadCertificateFromProp
```
protected X509Certificate loadCertificateFromProp(Object propValue)
```
    Loads a property of the type X509Certificate from the property value
    
    Parameters:
    
    propValue - the property value
    
    Returns:
    
    the X509Certificate object
  - loadCertificateFromProp
```
protected X509Certificate loadCertificateFromProp(String propertyKey)
```
    Loads a property of the type X509Certificate from the Properties object
    
    Parameters:
    
    propertyKey - the property name
    
    Returns:
    
    the X509Certificate object
  - loadPrivateKeyFromProp
```
protected PrivateKey loadPrivateKeyFromProp(String propertyKey)
```
    Loads a property of the type PrivateKey from the Properties object
    
    Parameters:
    
    propertyKey - the property name
    
    Returns:
    
    the PrivateKey object

Class SettingsBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STRICT_PROPERTY_KEY

DEBUG_PROPERTY_KEY

SP_ENTITYID_PROPERTY_KEY

SP_ASSERTION_CONSUMER_SERVICE_URL_PROPERTY_KEY

SP_ASSERTION_CONSUMER_SERVICE_BINDING_PROPERTY_KEY

SP_SINGLE_LOGOUT_SERVICE_URL_PROPERTY_KEY

SP_SINGLE_LOGOUT_SERVICE_BINDING_PROPERTY_KEY

SP_NAMEIDFORMAT_PROPERTY_KEY

SP_X509CERT_PROPERTY_KEY

SP_PRIVATEKEY_PROPERTY_KEY

SP_X509CERTNEW_PROPERTY_KEY

KEYSTORE_KEY

KEYSTORE_ALIAS

KEYSTORE_KEY_PASSWORD

IDP_ENTITYID_PROPERTY_KEY

IDP_SINGLE_SIGN_ON_SERVICE_URL_PROPERTY_KEY

IDP_SINGLE_SIGN_ON_SERVICE_BINDING_PROPERTY_KEY

IDP_SINGLE_LOGOUT_SERVICE_URL_PROPERTY_KEY

IDP_SINGLE_LOGOUT_SERVICE_RESPONSE_URL_PROPERTY_KEY

IDP_SINGLE_LOGOUT_SERVICE_BINDING_PROPERTY_KEY

IDP_X509CERT_PROPERTY_KEY

IDP_X509CERTMULTI_PROPERTY_KEY

CERTFINGERPRINT_PROPERTY_KEY

CERTFINGERPRINT_ALGORITHM_PROPERTY_KEY

SECURITY_NAMEID_ENCRYPTED

SECURITY_AUTHREQUEST_SIGNED

SECURITY_LOGOUTREQUEST_SIGNED

SECURITY_LOGOUTRESPONSE_SIGNED

SECURITY_WANT_MESSAGES_SIGNED

SECURITY_WANT_ASSERTIONS_SIGNED

SECURITY_WANT_ASSERTIONS_ENCRYPTED

SECURITY_WANT_NAMEID

SECURITY_WANT_NAMEID_ENCRYPTED

SECURITY_SIGN_METADATA

SECURITY_REQUESTED_AUTHNCONTEXT

SECURITY_REQUESTED_AUTHNCONTEXTCOMPARISON

SECURITY_WANT_XML_VALIDATION

SECURITY_SIGNATURE_ALGORITHM

SECURITY_DIGEST_ALGORITHM

SECURITY_REJECT_UNSOLICITED_RESPONSES_WITH_INRESPONSETO

SECURITY_ALLOW_REPEAT_ATTRIBUTE_NAME_PROPERTY_KEY

SECURITY_REJECT_DEPRECATED_ALGORITHM

COMPRESS_REQUEST

COMPRESS_RESPONSE

PARSING_TRIM_NAME_IDS

PARSING_TRIM_ATTRIBUTE_VALUES

CONTACT_TECHNICAL_GIVEN_NAME

CONTACT_TECHNICAL_EMAIL_ADDRESS

CONTACT_SUPPORT_GIVEN_NAME

CONTACT_SUPPORT_EMAIL_ADDRESS

ORGANIZATION_NAME

ORGANIZATION_DISPLAYNAME

ORGANIZATION_URL

ORGANIZATION_LANG

UNIQUE_ID_PREFIX_PROPERTY_KEY

Constructor Detail

SettingsBuilder

Method Detail

fromFile

fromFile

fromProperties

fromValues

fromValues

build

build

getPrivateKeyFromKeyStore

getCertificateFromKeyStore

loadCertificateFromProp

loadCertificateFromProp

loadPrivateKeyFromProp