Package se.swedenconnect.opensaml.sweid.saml2.authn.umsg

Interface UserMessage

All Superinterfaces:
org.opensaml.core.xml.AttributeExtensibleXMLObject, org.opensaml.saml.common.SAMLObject, org.opensaml.core.xml.XMLObject
All Known Implementing Classes:
UserMessageImpl
public interface UserMessage extends org.opensaml.saml.common.SAMLObject, org.opensaml.core.xml.AttributeExtensibleXMLObject
Definition of the UserMessage type. 
 
   <xs:element name="UserMessage" type="umsg:UserMessageType"/>

   <xs:complexType name="UserMessageType">
     <xs:annotation>
       <xs:documentation>List of user messages (in different languages)</xs:documentation>
     </xs:annotation>
     <xs:sequence>
       <xs:element name="Message" type="umsg:MessageType" minOccurs="1" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="mimeType" type="xs:string" default="text/plain">
       <xs:annotation>
         <xs:documentation>The MIME type of the user message(s)</xs:documentation>
       </xs:annotation>
     </xs:attribute>
     <xs:anyAttribute namespace="##any"/>
   </xs:complexType>
Author:
Martin Lindström

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_ELEMENT_LOCAL_NAME
    Name of the element.
    static final QName
    DEFAULT_ELEMENT_NAME
    Default element name.
    static final String
    DEFAULT_MIME_TYPE
    The default MIME type.
    static final String
    MIME_TYPE_ATTR_NAME
    Attribute label for the mimeType attribute.
    static final String
    TYPE_LOCAL_NAME
    Local name of the type
    static final QName
    TYPE_NAME
    QName of the XSI type.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<Message>
    getMessages()
    Gets a reference to the list of Message elements.
    String
    getMimeType()
    Gets the value of the mimeType attribute.
    void
    setMimeType(String mimeType)
    Assigns the value for the mimeType attribute.

    Methods inherited from interface org.opensaml.core.xml.AttributeExtensibleXMLObject

    getUnknownAttributes

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

    detach, ensureDOM, 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 Details

    • DEFAULT_ELEMENT_LOCAL_NAME

      static final String DEFAULT_ELEMENT_LOCAL_NAME
      Name of the element.
      See Also:

    • DEFAULT_ELEMENT_NAME

      static final QName DEFAULT_ELEMENT_NAME
      Default element name.

    • TYPE_LOCAL_NAME

      static final String TYPE_LOCAL_NAME
      Local name of the type
      See Also:

    • TYPE_NAME

      static final QName TYPE_NAME
      QName of the XSI type.

    • MIME_TYPE_ATTR_NAME

      static final String MIME_TYPE_ATTR_NAME
      Attribute label for the mimeType attribute.
      See Also:

    • DEFAULT_MIME_TYPE

      static final String DEFAULT_MIME_TYPE
      The default MIME type.
      See Also:

  • Method Details

    • getMessages

      @Nonnull List<Message> getMessages()
      Gets a reference to the list of Message elements.
      Returns:
      a list of Message elements

    • getMimeType

      @Nullable String getMimeType()
      Gets the value of the mimeType attribute.
      Returns:
      the MIME type

    • setMimeType

      void setMimeType(@Nullable String mimeType)
      Assigns the value for the mimeType attribute.
      Parameters:
      mimeType - the MIME type