Package se.litsec.opensaml.saml2.metadata.build

Class AbstractEntityDescriptorBuilder<T extends AbstractSAMLObjectBuilder<EntityDescriptor>>

    • Field Detail

      • ENTITY_CATEGORY_ATTRIBUTE_NAME

        public static final String ENTITY_CATEGORY_ATTRIBUTE_NAME
        The attribute name for the entity category attribute stored as an attribute in the entity attributes extension.
        See Also:
        Constant Field Values

      • ENTITY_CATEGORY_TEMPLATE

        public static final AttributeTemplate ENTITY_CATEGORY_TEMPLATE
        The attribute template for the entity category attribute stored as an attribute in the entity attributes extension.

    • Constructor Detail

      • AbstractEntityDescriptorBuilder

        public AbstractEntityDescriptorBuilder()
        Constructor setting up the builder with no template. This means that the entire EntityDescriptor object is created from data assigned using the builder.

      • AbstractEntityDescriptorBuilder

        public AbstractEntityDescriptorBuilder​(InputStream resource)
                                throws XMLParserException,
                                       UnmarshallingException,
                                       IOException
        Constructor setting up the builder with a template EntityDescriptor that is read from a resource. Users of the bean may now change, add or delete, the elements and attributes of the template object using the assignment methods of the builder.
        Parameters:
        resource - the template resource
        Throws:
        IOException - if the resource can not be read
        UnmarshallingException - for unmarshalling errors
        XMLParserException - for XML parsing errors

      • AbstractEntityDescriptorBuilder

        public AbstractEntityDescriptorBuilder​(EntityDescriptor template)
                                throws UnmarshallingException,
                                       MarshallingException
        Constructor setting up the builder with a template EntityDescriptor. Users of the bean may now change, add or delete, the elements and attributes of the template object using the assignment methods of the builder.
        Parameters:
        template - the template
        Throws:
        UnmarshallingException - for unmarshalling errors
        MarshallingException - for marshalling errors

    • Method Detail

      • getThis

        protected abstract T getThis()
        In order for us to be able to make chaining calls we need to return the concrete type of the builder.
        Returns:
        the concrete type of the builder

      • ssoDescriptor

        protected abstract SSODescriptor ssoDescriptor()
        Returns the SSO role descriptor of the template entity descriptor. If no role descriptor is present, the method creates such an object.
        Returns:
        the role descriptor

      • matchingSSODescriptorType

        protected abstract boolean matchingSSODescriptorType​(EntityDescriptor descriptor)
        Checks that the SSO descriptor of the supplied EntityDescriptor is of the correct type given the factory bean type.

        An entity descriptor that does not yet have an SSODescriptor element will also be regarded as a matching type.

        Parameters:
        descriptor - the descriptor to check
        Returns:
        true if the type is OK, and false otherwise

      • entityID

        public T entityID​(String entityID)
        Assigns the entityID for the EntityDescriptor.
        Parameters:
        entityID - the entityID
        Returns:
        the builder

      • id

        public T id​(String id)
        Assigns the ID attribute for the EntityDescriptor.
        Parameters:
        id - the ID
        Returns:
        the builder

      • cacheDuration

        public T cacheDuration​(Long cacheDuration)
        Assigns the cacheDuration attribute for the EntityDescriptor.
        Parameters:
        cacheDuration - the cache duration (in milliseconds)
        Returns:
        the builder

      • validUntil

        public T validUntil​(Instant time)
        Assigns the valid until time.
        Parameters:
        time - valid until
        Returns:
        the builder

      • entityAttributesExtension

        public T entityAttributesExtension​(List<Attribute> attributes)
        Adds attributes to the mdattr:EntityAttributes element that is part of the metadata extension element.
        Parameters:
        attributes - a list of attributes
        Returns:
        the builder
        See Also:
        entityCategories(String...)

      • entityCategories

        public T entityCategories​(List<String> entityCategories)
        Adds a set of entity categories to the entity category attribute (http://macedir.org/entity-category) that is part of the mdattr:EntityAttributes element that is part of the metadata extension element.

        The method does not update any of the other attributes that may exist in the entity attributes extension.

        Parameters:
        entityCategories - the entity category values that should be added
        Returns:
        the builder
        See Also:
        entityAttributesExtension(List)

      • entityCategories

        public T entityCategories​(String... entityCategories)
        Parameters:
        entityCategories - the entity category values that should be added
        Returns:
        the builder
        See Also:
        entityCategories(List)

      • uiInfoExtension

        public T uiInfoExtension​(UIInfo uiInfo)
        Assigns the mdui:UIInfo element as an extension to the role descriptor.

        If null is supplied, the extension will be removed from the template entity descriptor (if present).

        Parameters:
        uiInfo - the UIInfo element (will be cloned before assignment)
        Returns:
        the builder

      • keyDescriptors

        public T keyDescriptors​(List<KeyDescriptor> keyDescriptors)
        Adds the key descriptor elements.
        Parameters:
        keyDescriptors - the key descriptors
        Returns:
        the builder

      • keyDescriptors

        public T keyDescriptors​(KeyDescriptor... keyDescriptors)
        Parameters:
        keyDescriptors - the key descriptors
        Returns:
        the builder
        See Also:
        keyDescriptors(List)

      • signingMethods

        public T signingMethods​(boolean addToRole,
                        List<SigningMethod> signingMethods)
        Adds a ordered list of alg:SigningMethod elements according to "SAML v2.0 Metadata Profile for Algorithm Support Version 1.0".
        Parameters:
        addToRole - whether the alg:SigningMethod elements should be added to an extension under the EntityDescriptor or under the role descriptor
        signingMethods - the signing methods to add
        Returns:
        the builder

      • signingMethods

        public T signingMethods​(boolean addToRole,
                        SigningMethod... signingMethods)
        Parameters:
        addToRole - whether the alg:SigningMethod elements should be added to an extension under the EntityDescriptor or under the role descriptor
        signingMethods - the signing methods to add
        Returns:
        the builder
        See Also:
        signingMethods(boolean, List)

      • digestMethods

        public T digestMethods​(boolean addToRole,
                       List<DigestMethod> digestMethods)
        Adds a ordered list of alg:DigestMethod elements according to "SAML v2.0 Metadata Profile for Algorithm Support Version 1.0".
        Parameters:
        addToRole - whether the alg:DigestMethod elements should be added to an extension under the EntityDescriptor or under the role descriptor
        digestMethods - the digest methods to add
        Returns:
        the builder

      • digestMethods

        public T digestMethods​(boolean addToRole,
                       DigestMethod... digestMethods)
        Parameters:
        addToRole - whether the alg:DigestMethod elements should be added to an extension under the EntityDescriptor or under the role descriptor
        digestMethods - the digest methods to add
        Returns:
        the builder
        See Also:
        digestMethods(boolean, List)

      • nameIDFormats

        public T nameIDFormats​(List<String> nameIDFormats)
        Assigns the md:NameIDFormat elements.
        Parameters:
        nameIDFormats - the nameID format strings
        Returns:
        the builder

      • nameIDFormats

        public T nameIDFormats​(String... nameIDFormats)
        Parameters:
        nameIDFormats - the nameID format strings
        Returns:
        the builder
        See Also:
        nameIDFormats(List)

      • singleLogoutServices

        public T singleLogoutServices​(List<SingleLogoutService> singleLogoutServices)
        Adds md:SingleLogoutService elements to the SSODescriptor.
        Parameters:
        singleLogoutServices - single logout service objects (cloned before assignment)
        Returns:
        the builder

      • singleLogoutServices

        public T singleLogoutServices​(SingleLogoutService... singleLogoutServices)
        Parameters:
        singleLogoutServices - single logout service objects (cloned before assignment)
        Returns:
        the builder
        See Also:
        singleLogoutServices(List)

      • organization

        public T organization​(Organization organization)
        Assigns the Organization element to the entity descriptor.
        Parameters:
        organization - the organization (will be cloned before assignment)
        Returns:
        the builder

      • contactPersons

        public T contactPersons​(List<ContactPerson> contactPersons)
        Assigns the ContactPerson elements to the entity descriptor.
        Parameters:
        contactPersons - the contact person elements (will be cloned before assignment)
        Returns:
        the builder

      • contactPersons

        public T contactPersons​(ContactPerson... contactPersons)
        Parameters:
        contactPersons - the contact person elements (will be cloned before assignment)
        Returns:
        the builder
        See Also:
        contactPersons(List)

      • updateExtensions

        protected <E extends XMLObject> void updateExtensions​(Extensions extensions,
                                                      List<E> elements,
                                                      QName elementName)
        Support method that updates an Extensions element with the supplied elements. It first removes any other matching types before adding the new ones.
        Type Parameters:
        E - the extension type
        Parameters:
        extensions - the element to update.
        elements - the elements to add (may be null or empty for the remove-case)
        elementName - the QName of the types to add