se.litsec.opensaml.saml2.metadata.build

Class KeyDescriptorBuilder

java.lang.Object

se.litsec.opensaml.core.AbstractSAMLObjectBuilder<KeyDescriptor>

se.litsec.opensaml.saml2.metadata.build.KeyDescriptorBuilder

All Implemented Interfaces:

SAMLObjectBuilder<KeyDescriptor>

public class KeyDescriptorBuilder
extends AbstractSAMLObjectBuilder<KeyDescriptor>

A builder for KeyDescriptor elements.

This builder only supports a subset of the possible elements of a key descriptor, but should be sufficient for most cases.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Constructor Summary

Constructors

Constructor and Description
KeyDescriptorBuilder()

Method Summary

Modifier and Type	Method and Description
static KeyDescriptorBuilder	builder() Utility method that creates a builder.
KeyDescriptorBuilder	certificate(InputStream certificate) Assigns an input stream to a certificate resource that is to be used as a X.509 data element of the KeyInfo element within the key descriptor.
KeyDescriptorBuilder	certificate(String base64Encoding) Assigns a certificate (in Base64-encoded format) to be used as a X.509 data element of the KeyInfo element within the key descriptor.
KeyDescriptorBuilder	certificate(X509Certificate certificate) Assigns a certificate to be used as a X.509 data element of the KeyInfo element within the key descriptor.
KeyDescriptorBuilder	certificate(X509Credential credential) Assigns a certificate in OpenSAML credential format to be used as a X.509 data element of the KeyInfo element within the key descriptor.
KeyDescriptorBuilder	encryptionMethods(List<String> algorithms) Assigns a list of encryption methods.
KeyDescriptorBuilder	encryptionMethods(String... algorithms) See encryptionMethods(List).
protected Class<KeyDescriptor>	getObjectType() Returns the object type.
KeyDescriptorBuilder	keyName(String name) Assigns the key name of the KeyInfo element within the key descriptor.
KeyDescriptorBuilder	use(UsageType usageType) Assigns the usage type for the key descriptor.

Methods inherited from class se.litsec.opensaml.core.AbstractSAMLObjectBuilder

build, object

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyDescriptorBuilder

public KeyDescriptorBuilder()

Method Detail

builder

public static KeyDescriptorBuilder builder()

Utility method that creates a builder.

Returns:

a builder

getObjectType

protected Class<KeyDescriptor> getObjectType()

Returns the object type.

Specified by:

getObjectType in class AbstractSAMLObjectBuilder<KeyDescriptor>

Returns:

the object type

use

public KeyDescriptorBuilder use(UsageType usageType)

Assigns the usage type for the key descriptor.

Parameters:

usageType - the usage type

Returns:

the builder

keyName

public KeyDescriptorBuilder keyName(String name)

Assigns the key name of the KeyInfo element within the key descriptor.

Parameters:

name - the key name

Returns:

the builder

certificate

public KeyDescriptorBuilder certificate(X509Certificate certificate)

Assigns a certificate to be used as a X.509 data element of the KeyInfo element within the key descriptor.

Parameters:

certificate - the certificate

Returns:

the builder

certificate

public KeyDescriptorBuilder certificate(InputStream certificate)

Assigns an input stream to a certificate resource that is to be used as a X.509 data element of the KeyInfo element within the key descriptor.

Parameters:

certificate - the certificate resource

Returns:

the builder

certificate

public KeyDescriptorBuilder certificate(String base64Encoding)

Assigns a certificate (in Base64-encoded format) to be used as a X.509 data element of the KeyInfo element within the key descriptor.

Parameters:

base64Encoding - the base64 encoding (note: not PEM-format)

Returns:

the builder

certificate

public KeyDescriptorBuilder certificate(X509Credential credential)

Assigns a certificate in OpenSAML credential format to be used as a X.509 data element of the KeyInfo element within the key descriptor.

Parameters:

credential - the credential

Returns:

the builder

encryptionMethods

public KeyDescriptorBuilder encryptionMethods(List<String> algorithms)

Assigns a list of encryption methods.

Note: the method only accepts algorithm URI:s. If you need to assign other parts of an EncryptionMethod object you must install the method manually and not via the builder.

Parameters:

algorithms - list of algorithms

Returns:

the builder

encryptionMethods

public KeyDescriptorBuilder encryptionMethods(String... algorithms)

See encryptionMethods(List).

Parameters:

algorithms - list of algorithms

Returns:

the builder