org.cloudfoundry.uaa.identityzones

Class SamlConfiguration.Builder

java.lang.Object

org.cloudfoundry.uaa.identityzones.SamlConfiguration.Builder

Enclosing class:

SamlConfiguration

public static final class SamlConfiguration.Builder
extends Object

Builds instances of type SamlConfiguration. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
SamlConfiguration.Builder	activeKeyId(String activeKeyId) Initializes the value for the activeKeyId attribute.
SamlConfiguration.Builder	assertionSigned(Boolean assertionSigned) Initializes the value for the assertionSigned attribute.
SamlConfiguration.Builder	assertionTimeToLive(Integer assertionTimeToLive) Initializes the value for the assertionTimeToLive attribute.
SamlConfiguration	build() Builds a new SamlConfiguration.
SamlConfiguration.Builder	certificate(String certificate) Initializes the value for the certificate attribute.
SamlConfiguration.Builder	disableInResponseToCheck(Boolean disableInResponseToCheck) Initializes the value for the disableInResponseToCheck attribute.
SamlConfiguration.Builder	entityId(String entityId) Initializes the value for the entityId attribute.
SamlConfiguration.Builder	from(SamlConfiguration instance) Fill a builder with attribute values from the provided SamlConfiguration instance.
SamlConfiguration.Builder	key(Map.Entry<String,? extends Key> entry) Put one entry to the keys map.
SamlConfiguration.Builder	key(String key, Key value) Put one entry to the keys map.
SamlConfiguration.Builder	keys(Map<String,? extends Key> entries) Sets or replaces all mappings from the specified map as entries for the keys map.
SamlConfiguration.Builder	privateKey(String privateKey) Initializes the value for the privateKey attribute.
SamlConfiguration.Builder	privateKeyPassword(String privateKeyPassword) Initializes the value for the privateKeyPassword attribute.
SamlConfiguration.Builder	putAllKeys(Map<String,? extends Key> entries) Put all mappings from the specified map as entries to keys map.
SamlConfiguration.Builder	requestSigned(Boolean requestSigned) Initializes the value for the requestSigned attribute.
SamlConfiguration.Builder	wantAssertionSigned(Boolean wantAssertionSigned) Initializes the value for the wantAssertionSigned attribute.
SamlConfiguration.Builder	wantPartnerAuthenticationRequestSigned(Boolean wantPartnerAuthenticationRequestSigned) Initializes the value for the wantPartnerAuthenticationRequestSigned attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final SamlConfiguration.Builder from(SamlConfiguration instance)

Fill a builder with attribute values from the provided SamlConfiguration instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

activeKeyId

public final SamlConfiguration.Builder activeKeyId(String activeKeyId)

Initializes the value for the activeKeyId attribute.

Parameters:

activeKeyId - The value for activeKeyId (can be null)

Returns:

this builder for use in a chained invocation

assertionSigned

public final SamlConfiguration.Builder assertionSigned(Boolean assertionSigned)

Initializes the value for the assertionSigned attribute.

Parameters:

assertionSigned - The value for assertionSigned (can be null)

Returns:

this builder for use in a chained invocation

assertionTimeToLive

public final SamlConfiguration.Builder assertionTimeToLive(Integer assertionTimeToLive)

Initializes the value for the assertionTimeToLive attribute.

Parameters:

assertionTimeToLive - The value for assertionTimeToLive (can be null)

Returns:

this builder for use in a chained invocation

certificate

public final SamlConfiguration.Builder certificate(String certificate)

Initializes the value for the certificate attribute.

Parameters:

certificate - The value for certificate (can be null)

Returns:

this builder for use in a chained invocation

disableInResponseToCheck

public final SamlConfiguration.Builder disableInResponseToCheck(Boolean disableInResponseToCheck)

Initializes the value for the disableInResponseToCheck attribute.

Parameters:

disableInResponseToCheck - The value for disableInResponseToCheck (can be null)

Returns:

this builder for use in a chained invocation

entityId

public final SamlConfiguration.Builder entityId(String entityId)

Initializes the value for the entityId attribute.

Parameters:

entityId - The value for entityId (can be null)

Returns:

this builder for use in a chained invocation

key

public final SamlConfiguration.Builder key(String key,
                                           Key value)

Put one entry to the keys map.

Parameters:

key - The key in the keys map

value - The associated value in the keys map

Returns:

this builder for use in a chained invocation

key

public final SamlConfiguration.Builder key(Map.Entry<String,? extends Key> entry)

Put one entry to the keys map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

keys

public final SamlConfiguration.Builder keys(Map<String,? extends Key> entries)

Sets or replaces all mappings from the specified map as entries for the keys map. Nulls are not permitted as keys or values, but parameter itself can be null

Parameters:

entries - The entries that will be added to the keys map

Returns:

this builder for use in a chained invocation

putAllKeys

public final SamlConfiguration.Builder putAllKeys(Map<String,? extends Key> entries)

Put all mappings from the specified map as entries to keys map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the keys map

Returns:

this builder for use in a chained invocation

privateKey

public final SamlConfiguration.Builder privateKey(String privateKey)

Initializes the value for the privateKey attribute.

Parameters:

privateKey - The value for privateKey (can be null)

Returns:

this builder for use in a chained invocation

privateKeyPassword

public final SamlConfiguration.Builder privateKeyPassword(String privateKeyPassword)

Initializes the value for the privateKeyPassword attribute.

Parameters:

privateKeyPassword - The value for privateKeyPassword (can be null)

Returns:

this builder for use in a chained invocation

requestSigned

public final SamlConfiguration.Builder requestSigned(Boolean requestSigned)

Initializes the value for the requestSigned attribute.

Parameters:

requestSigned - The value for requestSigned (can be null)

Returns:

this builder for use in a chained invocation

wantAssertionSigned

public final SamlConfiguration.Builder wantAssertionSigned(Boolean wantAssertionSigned)

Initializes the value for the wantAssertionSigned attribute.

Parameters:

wantAssertionSigned - The value for wantAssertionSigned (can be null)

Returns:

this builder for use in a chained invocation

wantPartnerAuthenticationRequestSigned

public final SamlConfiguration.Builder wantPartnerAuthenticationRequestSigned(Boolean wantPartnerAuthenticationRequestSigned)

Initializes the value for the wantPartnerAuthenticationRequestSigned attribute.

Parameters:

wantPartnerAuthenticationRequestSigned - The value for wantPartnerAuthenticationRequestSigned (can be null)

Returns:

this builder for use in a chained invocation

build

public SamlConfiguration build()

Builds a new SamlConfiguration.

Returns:

An immutable instance of SamlConfiguration

Throws:

IllegalStateException - if any required attributes are missing