Package org.opensaml.saml.saml2.metadata

Interface AttributeConsumingService

  • All Superinterfaces:
    SAMLObject, org.opensaml.core.xml.XMLObject
    public interface AttributeConsumingService
extends SAMLObject
    SAML 2.0 Metadata AttributeAuthorityDescriptor.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      List<ServiceDescription> getDescriptions()
      Gets the descriptions for this service.
      int getIndex()
      Gets the index for this service.
      List<ServiceName> getNames()
      Gets the list of names this service has.
      List<RequestedAttribute> getRequestedAttributes()
      Gets the attributes this service requests.
      Boolean isDefault()
      Checks if this is the default service for the service provider.
      org.opensaml.core.xml.schema.XSBooleanValue isDefaultXSBoolean()
      Checks if this is the default service for the service provider.
      void setIndex​(int index)
      Sets the index for this service.
      void setIsDefault​(Boolean newIsDefault)
      Sets if this is the default service for the service provider.
      void setIsDefault​(org.opensaml.core.xml.schema.XSBooleanValue newIsDefault)
      Sets if this is the default service for the service provider.

      • Methods inherited from interface org.opensaml.core.xml.XMLObject

        detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

    • Field Detail

      • DEFAULT_ELEMENT_LOCAL_NAME

        static final String DEFAULT_ELEMENT_LOCAL_NAME
        Element name, no namespace.
        See Also:
        Constant Field Values

      • DEFAULT_ELEMENT_NAME

        static final QName DEFAULT_ELEMENT_NAME
        Default element name.

      • TYPE_NAME

        static final QName TYPE_NAME
        QName of the XSI type.

      • IS_DEFAULT_ATTRIB_NAME

        static final String IS_DEFAULT_ATTRIB_NAME
        "isDefault" attribute's local name.
        See Also:
        Constant Field Values

    • Method Detail

      • getIndex

        int getIndex()
        Gets the index for this service.
        Returns:
        the index for this service

      • setIndex

        void setIndex​(int index)
        Sets the index for this service.
        Parameters:
        index - the index for this service

      • isDefault

        Boolean isDefault()
        Checks if this is the default service for the service provider.
        Returns:
        true if this is the default service, false if not

      • isDefaultXSBoolean

        org.opensaml.core.xml.schema.XSBooleanValue isDefaultXSBoolean()
        Checks if this is the default service for the service provider.
        Returns:
        true if this is the default service, false if not

      • setIsDefault

        void setIsDefault​(Boolean newIsDefault)
        Sets if this is the default service for the service provider. Boolean values will be marshalled to either "true" or "false".
        Parameters:
        newIsDefault - true if this is the default service, false if not

      • setIsDefault

        void setIsDefault​(org.opensaml.core.xml.schema.XSBooleanValue newIsDefault)
        Sets if this is the default service for the service provider.
        Parameters:
        newIsDefault - true if this is the default service, false if not

      • getNames

        List<ServiceName> getNames()
        Gets the list of names this service has.
        Returns:
        list of names this service has

      • getDescriptions

        List<ServiceDescription> getDescriptions()
        Gets the descriptions for this service.
        Returns:
        descriptions for this service

      • getRequestedAttributes

        List<RequestedAttribute> getRequestedAttributes()
        Gets the attributes this service requests.
        Returns:
        attributes this service requests