Class FasteningElement
- java.lang.Object
-
- org.jivesoftware.smackx.message_fastening.element.FasteningElement
-
- All Implemented Interfaces:
org.jivesoftware.smack.packet.Element
,org.jivesoftware.smack.packet.ExtensionElement
,org.jivesoftware.smack.packet.FullyQualifiedElement
,org.jivesoftware.smack.packet.NamedElement
,org.jivesoftware.smack.packet.XmlLangElement
public final class FasteningElement extends java.lang.Object implements org.jivesoftware.smack.packet.ExtensionElement
Message Fastening container element.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FasteningElement.Builder
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTR_CLEAR
static java.lang.String
ATTR_ID
static java.lang.String
ATTR_SHELL
static java.lang.String
ELEMENT
static java.lang.String
NAMESPACE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
applyTo(org.jivesoftware.smack.packet.MessageBuilder messageBuilder)
Add this element to the provided message builder.static FasteningElement.Builder
builder()
static FasteningElement
createShellElementForSensitiveElement(java.lang.String originIdOfSensitiveElement)
static FasteningElement
createShellElementForSensitiveElement(FasteningElement sensitiveElement)
static FasteningElement
createShellElementForSensitiveElement(OriginIdElement originIdOfSensitiveElement)
java.lang.String
getElementName()
java.util.List<ExternalElement>
getExternalPayloads()
Return all external payloads of this element.java.lang.String
getNamespace()
OriginIdElement
getReferencedStanzasOriginId()
Return theorigin-id
of theStanza
that the message fastenings are to be applied to.java.util.List<org.jivesoftware.smack.packet.ExtensionElement>
getWrappedPayloads()
Return all wrapped payloads of this element.static boolean
hasFasteningElement(org.jivesoftware.smack.packet.Message message)
Return true if the providedMessage
contains aFasteningElement
.static boolean
hasFasteningElement(org.jivesoftware.smack.packet.MessageBuilder builder)
Return true if the providedMessageBuilder
contains aFasteningElement
.boolean
isRemovingElement()
Does this element remove a previously sentFasteningElement
?boolean
isShellElement()
Is this a shell element? Shell elements are otherwise empty elements that indicate that an encrypted payload of a message encrypted using XEP-420: Stanza Content Encryption contains a sensitiveFasteningElement
.org.jivesoftware.smack.util.XmlStringBuilder
toXML(org.jivesoftware.smack.packet.XmlEnvironment xmlEnvironment)
-
-
-
Field Detail
-
ELEMENT
public static final java.lang.String ELEMENT
- See Also:
- Constant Field Values
-
NAMESPACE
public static final java.lang.String NAMESPACE
- See Also:
- Constant Field Values
-
ATTR_ID
public static final java.lang.String ATTR_ID
- See Also:
- Constant Field Values
-
ATTR_CLEAR
public static final java.lang.String ATTR_CLEAR
- See Also:
- Constant Field Values
-
ATTR_SHELL
public static final java.lang.String ATTR_SHELL
- See Also:
- Constant Field Values
-
-
Method Detail
-
getReferencedStanzasOriginId
public OriginIdElement getReferencedStanzasOriginId()
Return theorigin-id
of theStanza
that the message fastenings are to be applied to.- Returns:
- origin id of the referenced stanza
-
getWrappedPayloads
public java.util.List<org.jivesoftware.smack.packet.ExtensionElement> getWrappedPayloads()
Return all wrapped payloads of this element.- Returns:
- wrapped payloads.
- See Also:
- XEP-0422: §3.1. Wrapped Payloads
-
getExternalPayloads
public java.util.List<ExternalElement> getExternalPayloads()
Return all external payloads of this element.- Returns:
- external payloads.
- See Also:
- XEP-0422: §3.2. External Payloads
-
isRemovingElement
public boolean isRemovingElement()
Does this element remove a previously sentFasteningElement
?- Returns:
- true if the clear attribute is set.
- See Also:
- XEP-0422: Message Fastening §3.4 Removing fastenings
-
isShellElement
public boolean isShellElement()
Is this a shell element? Shell elements are otherwise empty elements that indicate that an encrypted payload of a message encrypted using XEP-420: Stanza Content Encryption contains a sensitiveFasteningElement
.- Returns:
- true if this is a shell element.
- See Also:
- XEP-0422: Message Fastening §3.5 Interaction with stanza encryption
-
hasFasteningElement
public static boolean hasFasteningElement(org.jivesoftware.smack.packet.Message message)
Return true if the providedMessage
contains aFasteningElement
.- Parameters:
message
- message- Returns:
- true if the stanza has an
FasteningElement
.
-
hasFasteningElement
public static boolean hasFasteningElement(org.jivesoftware.smack.packet.MessageBuilder builder)
Return true if the providedMessageBuilder
contains aFasteningElement
.- Parameters:
builder
- message builder- Returns:
- true if the stanza has an
FasteningElement
.
-
getNamespace
public java.lang.String getNamespace()
- Specified by:
getNamespace
in interfaceorg.jivesoftware.smack.packet.FullyQualifiedElement
-
getElementName
public java.lang.String getElementName()
- Specified by:
getElementName
in interfaceorg.jivesoftware.smack.packet.NamedElement
-
toXML
public org.jivesoftware.smack.util.XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment xmlEnvironment)
- Specified by:
toXML
in interfaceorg.jivesoftware.smack.packet.Element
-
createShellElementForSensitiveElement
public static FasteningElement createShellElementForSensitiveElement(FasteningElement sensitiveElement)
-
createShellElementForSensitiveElement
public static FasteningElement createShellElementForSensitiveElement(java.lang.String originIdOfSensitiveElement)
-
createShellElementForSensitiveElement
public static FasteningElement createShellElementForSensitiveElement(OriginIdElement originIdOfSensitiveElement)
-
applyTo
public void applyTo(org.jivesoftware.smack.packet.MessageBuilder messageBuilder)
Add this element to the provided message builder. Note: The stanza MUST NOT contain more than one apply-to elements at the same time.- Parameters:
messageBuilder
- message builder- See Also:
- XEP-0422 §4: Business Rules
-
builder
public static FasteningElement.Builder builder()
-
-