Interface Message

All Superinterfaces:

AttributeExtensibleXMLObject, LangBearing, SAMLObject, XMLObject, XSBase64Binary

All Known Implementing Classes:

MessageImpl

public interface Message
extends XSBase64Binary, LangBearing, SAMLObject, AttributeExtensibleXMLObject

Definition for the MessageType type:

  <xs:complexType name="MessageType">
    <xs:annotation>
      <xs:documentation>
        The Base64-encoding of UTF-8 string holding the user message.
      </xs:documentation>
    </xs:annotation>
    <xs:simpleContent>
      <xs:extension base="xs:base64Binary">
        <xs:attribute ref="xml:lang" use="required"/>
        <xs:anyAttribute namespace="##any"/>
      </xs:extension>
    </xs:simpleContent>
  </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	TYPE_LOCAL_NAME	Local name of the type
static final QName	TYPE_NAME	QName of the XSI type.

Fields inherited from interface LangBearing

XML_LANG_ATTR_LOCAL_NAME, XML_LANG_ATTR_NAME

Method Summary

Modifier and Type	Method	Description
String	getContent()	Gets the content of the Message element, i.e., its Base64 decoded form.
void	setContent(String messageContent)	Assigns the Message element by assigning the text that it should hold.

Methods inherited from interface AttributeExtensibleXMLObject

getUnknownAttributes

Methods inherited from interface LangBearing

getXMLLang, setXMLLang

Methods inherited from interface 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

Methods inherited from interface XSBase64Binary

getValue, setValue

Field Details

DEFAULT_ELEMENT_LOCAL_NAME

@Nonnull
static final String DEFAULT_ELEMENT_LOCAL_NAME

Name of the element.

See Also:

• Constant Field Values

DEFAULT_ELEMENT_NAME

@Nonnull
static final QName DEFAULT_ELEMENT_NAME

Default element name.

TYPE_LOCAL_NAME

@Nonnull
static final String TYPE_LOCAL_NAME

Local name of the type

See Also:

• Constant Field Values

TYPE_NAME

@Nonnull
static final QName TYPE_NAME

QName of the XSI type.

Method Details

getContent

@Nullable
String getContent()

Gets the content of the Message element, i.e., its Base64 decoded form.

The XSBase64Binary.getValue() method will return the Base64 encoded value.

Returns:

the message content

See Also:

• XSBase64Binary.getValue()

setContent

void setContent(@Nullable
 String messageContent)

Assigns the Message element by assigning the text that it should hold. The method will Base64 encode the text.

The XSBase64Binary.setValue(String) is used to assign the Base64 encoded value.

Parameters:

messageContent - content of the Message element

See Also:

• XSBase64Binary.setValue(String)