AttributeBuilder (OpenSAML 3.x utility extensions

java.lang.Object
- se.litsec.opensaml.core.AbstractSAMLObjectBuilder<Attribute>
- - se.litsec.opensaml.saml2.attribute.AttributeBuilder

All Implemented Interfaces:

SAMLObjectBuilder<Attribute>
```
public class AttributeBuilder
extends AbstractSAMLObjectBuilder<Attribute>
```
Implements the build pattern to create Attribute objects.

Author:

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

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_NAME_FORMAT
The default name format for the attribute being built.

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_NAME_FORMAT` The default name format for the attribute being built.

Constructor Summary

Constructors
Constructor and Description
`AttributeBuilder(Attribute template)` Constructor setting up the builder given an attribute template.
`AttributeBuilder(InputStream resource)` Constructor setting up the builder with a template attribute that is read from an input stream.
`AttributeBuilder(String name)` Constructor setting the attribute name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Attribute`	`build()` Returns the `Attribute` object that has been built.
`static AttributeBuilder`	`builder(Attribute attribute)` Static utility method that creates a `AttributeBuilder` given a template attribute.
`static AttributeBuilder`	`builder(InputStream resource)` Static utility method that creates a `AttributeBuilder` given a template attribute read from an input stream.
`static AttributeBuilder`	`builder(String name)` Static utility method that creates a default `AttributeBuilder`.
`static <T extends XMLObject> T`	`createValueObject(Class<T> clazz)` Creates an `AttributeValue` object of the given class.
`static <T extends XMLObject> T`	`createValueObject(QName schemaType, Class<T> clazz)` Creates an `AttributeValue` object of the given class and schema type.
`AttributeBuilder`	`friendlyName(String friendlyName)` Assigns the attribute friendly name.
`protected Class<Attribute>`	`getObjectType()` Returns the object type.
`AttributeBuilder`	`name(String name)` Assigns the attribute name.
`AttributeBuilder`	`nameFormat(String nameFormat)` Assigns the attribute name format.
`AttributeBuilder`	`value(List<String> values)`
`AttributeBuilder`	`value(String... values)` Assigns one (or more) attribute string values.
`<T extends XMLObject> AttributeBuilder`	`value(T value)` Assigns an attribute value.

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

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

- Field Detail
  - DEFAULT_NAME_FORMAT
```
public static final String DEFAULT_NAME_FORMAT
```
    The default name format for the attribute being built.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AttributeBuilder
```
public AttributeBuilder(String name)
```
    Constructor setting the attribute name.
    
    Parameters:
    
    name - the attribute name
  - AttributeBuilder
```
public AttributeBuilder(Attribute template)
                 throws MarshallingException,
                        UnmarshallingException
```
    Constructor setting up the builder given an attribute template.
    
    Parameters:
    
    template - the attribute template
    
    Throws:
    
    UnmarshallingException - for unmarshalling errors
    
    MarshallingException - for marshalling errors
    
    See Also:
    
    AbstractSAMLObjectBuilder.AbstractSAMLObjectBuilder(org.opensaml.saml.common.SAMLObject)
  - AttributeBuilder
```
public AttributeBuilder(InputStream resource)
                 throws XMLParserException,
                        UnmarshallingException
```
    Constructor setting up the builder with a template attribute that is read from an input stream.
    
    Parameters:
    
    resource - the attribute template
    
    Throws:
    
    UnmarshallingException - for unmarshalling errors
    
    XMLParserException - for XML parsing errors
    
    See Also:
    
    AbstractSAMLObjectBuilder.AbstractSAMLObjectBuilder(InputStream)
- Method Detail
  - builder
```
public static AttributeBuilder builder(String name)
```
    Static utility method that creates a default AttributeBuilder.
    
    Parameters:
    
    name - the attribute name
    
    Returns:
    
    an AttributeBuilder instance.
    
    See Also:
    
    AttributeBuilder(String)
  - builder
```
public static AttributeBuilder builder(Attribute attribute)
                                throws MarshallingException,
                                       UnmarshallingException
```
    Static utility method that creates a AttributeBuilder given a template attribute.
    
    Parameters:
    
    attribute - the attribute template
    
    Returns:
    
    an attribute builder
    
    Throws:
    
    UnmarshallingException - for unmarshalling errors
    
    MarshallingException - for marshalling errors
  - builder
```
public static AttributeBuilder builder(InputStream resource)
                                throws XMLParserException,
                                       UnmarshallingException
```
    Static utility method that creates a AttributeBuilder given a template attribute read from an input stream.
    
    Parameters:
    
    resource - the attribute template
    
    Returns:
    
    an attribute builder
    
    Throws:
    
    UnmarshallingException - for unmarshalling errors
    
    XMLParserException - for XML parsing errors
  - build
```
public Attribute build()
```
    Returns the Attribute object that has been built. If the NameFormat attribute has not been assigned, the method will inject the default value ("urn:oasis:names:tc:SAML:2.0:attrname-format:uri").
    
    Specified by:
    
    build in interface SAMLObjectBuilder<Attribute>
    
    Overrides:
    
    build in class AbstractSAMLObjectBuilder<Attribute>
    
    Returns:
    
    the built object
  - name
```
public AttributeBuilder name(String name)
```
    Assigns the attribute name.
    
    Parameters:
    
    name - the attribute name
    
    Returns:
    
    the builder
  - friendlyName
```
public AttributeBuilder friendlyName(String friendlyName)
```
    Assigns the attribute friendly name.
    
    Parameters:
    
    friendlyName - the friendly name
    
    Returns:
    
    the builder
  - nameFormat
```
public AttributeBuilder nameFormat(String nameFormat)
```
    Assigns the attribute name format.
    
    Parameters:
    
    nameFormat - the name format URI
    
    Returns:
    
    the builder
  - value
```
public AttributeBuilder value(String... values)
```
    Assigns one (or more) attribute string values.
    Note: if null is passed as a parameter, any previous attribute values are cleared.
    
    Parameters:
    
    values - the string value(s) to add
    
    Returns:
    
    the builder
  - value
```
public AttributeBuilder value(List<String> values)
```
    Parameters:
    
    values - the string value(s) to add
    
    Returns:
    
    the builder
    
    See Also:
    
    value(String...)
  - value
```
public <T extends XMLObject> AttributeBuilder value(T value)
```
    Assigns an attribute value.
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    value - the value to add
    
    Returns:
    
    the builder
  - createValueObject
```
public static <T extends XMLObject> T createValueObject(Class<T> clazz)
```
    Creates an AttributeValue object of the given class. The type of the attribute value will be the field that is declared as TYPE_NAME of the given class.
    After the object has been constructed, its setter methods should be called to setup the value object before adding it to the attribute itself.
    
    Note: For attribute having string values, there is no need to explictly create an attribute value. Instead the value(String...) method may be used directly.
    
    Type Parameters:
    
    T - the type
    
    Parameters:
    
    clazz - the type of attribute value
    
    Returns:
    
    the attribute value
    
    See Also:
    
    createValueObject(QName, Class)
  - createValueObject
```
public static <T extends XMLObject> T createValueObject(QName schemaType,
                                                        Class<T> clazz)
```
    Creates an AttributeValue object of the given class and schema type.
    After the object has been constructed, its setter methods should be called to setup the value object before adding it to the attribute itself.
    
    Note: For attribute having string values, there is no need to explictly create an attribute value. Instead the value(String...) method may be used directly.
    
    Type Parameters:
    
    T - the type
    
    Parameters:
    
    schemaType - the schema type that should be assigned to the attribute value, i.e., xsi:type="ns:ValueType"
    
    clazz - the type of the attribute value
    
    Returns:
    
    the attribute value
    
    See Also:
    
    createValueObject(Class)
  - getObjectType
```
protected Class<Attribute> getObjectType()
```
    Returns the object type.
    
    Specified by:
    
    getObjectType in class AbstractSAMLObjectBuilder<Attribute>
    
    Returns:
    
    the object type

Class AttributeBuilder

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_NAME_FORMAT

Constructor Detail

AttributeBuilder

AttributeBuilder

AttributeBuilder

Method Detail

builder

builder

builder

build

name

friendlyName

nameFormat

value

value

value

createValueObject

createValueObject

getObjectType