vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-01-14 13:56:24 +01:00
Code Issues Releases Wiki Activity

Introduce XmlEnvironment

Browse source
This commit is contained in:
Florian Schmaus 2019-02-04 13:27:41 +01:00
parent dc780ffd6c
commit fee3ed81ca
229 changed files with 715 additions and 526 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
smack-core/src/main/java/org/jivesoftware/smack/compress/packet/Compress.java
View file

@ -45,7 +45,7 @@ public class Compress implements Nonza {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
xml.rightAngleBracket();
xml.element("method", method);
@ -77,7 +77,7 @@ public class Compress implements Nonza {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this);
xml.rightAngleBracket();
for (String method : methods) {

2
smack-core/src/main/java/org/jivesoftware/smack/compress/packet/Compressed.java
View file

@ -39,7 +39,7 @@ public final class Compressed implements Nonza {
}
@Override
public String toXML(String enclosingNamespace) {
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
return '<' + ELEMENT + " xmlns='" + NAMESPACE + "'/>";
}
}

2
smack-core/src/main/java/org/jivesoftware/smack/compress/packet/Failure.java
View file

@ -76,7 +76,7 @@ public class Failure implements Nonza {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
xml.rightAngleBracket();

2
smack-core/src/main/java/org/jivesoftware/smack/debugger/AbstractDebugger.java
View file

@ -161,7 +161,7 @@ public abstract class AbstractDebugger extends SmackDebugger {
@Override
public void onIncomingStreamElement(TopLevelStreamElement streamElement) {
if (printInterpreted) {
log("RCV PKT (" + connection.getConnectionCounter() + "): " + streamElement.toXML(null));
log("RCV PKT (" + connection.getConnectionCounter() + "): " + streamElement.toXML());
}
}

2
smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java
View file

@ -114,7 +114,7 @@ public class AbstractError {
xml.closeElement("text");
}
for (ExtensionElement packetExtension : extensions) {
xml.append(packetExtension.toXML(null));
xml.append(packetExtension.toXML());
}
}

2
smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractTextElement.java
View file

@ -37,7 +37,7 @@ public abstract class AbstractTextElement implements ExtensionElement {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this);
xml.optXmlLangAttribute(lang);
xml.rightAngleBracket();

2
smack-core/src/main/java/org/jivesoftware/smack/packet/Bind.java
View file

@ -89,7 +89,7 @@ public final class Bind extends IQ {
}
@Override
public String toXML(String enclosingNamespace) {
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
return '<' + ELEMENT + " xmlns='" + NAMESPACE + "'/>";
}

2
smack-core/src/main/java/org/jivesoftware/smack/packet/DefaultExtensionElement.java
View file

@ -86,7 +86,7 @@ public class DefaultExtensionElement implements ExtensionElement {
}
@Override
public CharSequence toXML(String enclosingNamespace) {
public CharSequence toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder buf = new XmlStringBuilder();
buf.halfOpenElement(elementName).xmlnsAttribute(namespace).rightAngleBracket();
for (String name : getNames()) {

13
smack-core/src/main/java/org/jivesoftware/smack/packet/Element.java
View file

@ -1,6 +1,6 @@
/**
*
* Copyright © 2014-2018 Florian Schmaus
* Copyright © 2014-2019 Florian Schmaus
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -23,7 +23,7 @@ package org.jivesoftware.smack.packet;
*/
public interface Element {
// TODO: Add a toXML() non-parameter default method once Smack supports Java 8.
CharSequence toXML(XmlEnvironment xmlEnvironment);
/**
* Returns the XML representation of this Element. This method takes an optional argument for the enclosing
@ -32,5 +32,12 @@ public interface Element {
* @param enclosingNamespace the enclosing namespace or {@code null}.
* @return the stanza extension as XML.
*/
CharSequence toXML(String enclosingNamespace);
default CharSequence toXML(String enclosingNamespace) {
XmlEnvironment xmlEnvironment = new XmlEnvironment(enclosingNamespace);
return toXML(xmlEnvironment);
}
default CharSequence toXML() {
return toXML(XmlEnvironment.EMPTY);
}
}

19
smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java
View file

@ -126,10 +126,10 @@ public abstract class IQ extends Stanza {
}
@Override
public final XmlStringBuilder toXML(String enclosingNamespace) {
XmlStringBuilder buf = new XmlStringBuilder(enclosingNamespace);
public final XmlStringBuilder toXML(XmlEnvironment enclosingXmlEnvironment) {
XmlStringBuilder buf = new XmlStringBuilder(enclosingXmlEnvironment);
buf.halfOpenElement(IQ_ELEMENT);
addCommonAttributes(buf, enclosingNamespace);
addCommonAttributes(buf, enclosingXmlEnvironment);
if (type == null) {
buf.attribute("type", "get");
}
@ -137,7 +137,7 @@ public abstract class IQ extends Stanza {
buf.attribute("type", type.toString());
}
buf.rightAngleBracket();
buf.append(getChildElementXML(enclosingNamespace));
buf.append(getChildElementXML(enclosingXmlEnvironment));
buf.closeElement(IQ_ELEMENT);
return buf;
}
@ -156,15 +156,15 @@ public abstract class IQ extends Stanza {
* Returns the sub-element XML section of the IQ packet, or the empty String if there
* isn't one.
*
* @param enclosingNamespace the enclosing XML namespace.
* @param enclosingXmlEnvironment the enclosing XML namespace.
* @return the child element section of the IQ XML.
* @since 4.3.0
*/
public final XmlStringBuilder getChildElementXML(String enclosingNamespace) {
public final XmlStringBuilder getChildElementXML(XmlEnvironment enclosingXmlEnvironment) {
XmlStringBuilder xml = new XmlStringBuilder();
if (type == Type.error) {
// Add the error sub-packet, if there is one.
appendErrorIfExists(xml, enclosingNamespace);
appendErrorIfExists(xml, enclosingXmlEnvironment);
}
else if (childElementName != null) {
// Add the query section if there is one.
@ -240,7 +240,7 @@ public abstract class IQ extends Stanza {
protected final void initializeAsResultFor(IQ request) {
if (!(request.getType() == Type.get || request.getType() == Type.set)) {
throw new IllegalArgumentException(
"IQ must be of type 'set' or 'get'. Original IQ: " + request.toXML(null));
"IQ must be of type 'set' or 'get'. Original IQ: " + request.toXML());
}
setStanzaId(request.getStanzaId());
setFrom(request.getTo());
@ -289,7 +289,7 @@ public abstract class IQ extends Stanza {
public static ErrorIQ createErrorResponse(final IQ request, final StanzaError.Builder error) {
if (!(request.getType() == Type.get || request.getType() == Type.set)) {
throw new IllegalArgumentException(
"IQ must be of type 'set' or 'get'. Original IQ: " + request.toXML(null));
"IQ must be of type 'set' or 'get'. Original IQ: " + request.toXML());
}
final ErrorIQ result = new ErrorIQ(error);
result.setStanzaId(request.getStanzaId());
@ -381,7 +381,6 @@ public abstract class IQ extends Stanza {
}
private IQChildElementXmlStringBuilder(String element, String namespace) {
super("");
prelude(element, namespace);
this.element = element;
}

2
smack-core/src/main/java/org/jivesoftware/smack/packet/Mechanisms.java
View file

@ -53,7 +53,7 @@ public class Mechanisms implements ExtensionElement {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this);
xml.rightAngleBracket();
for (String mechanism : mechanisms) {

18
smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java
View file

@ -479,10 +479,10 @@ public final class Message extends Stanza implements TypedCloneable<Message> {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
XmlStringBuilder buf = new XmlStringBuilder(enclosingNamespace);
public XmlStringBuilder toXML(XmlEnvironment enclosingXmlEnvironment) {
XmlStringBuilder buf = new XmlStringBuilder(enclosingXmlEnvironment);
buf.halfOpenElement(ELEMENT);
enclosingNamespace = addCommonAttributes(buf, enclosingNamespace);
enclosingXmlEnvironment = addCommonAttributes(buf, enclosingXmlEnvironment);
buf.optAttribute("type", type);
buf.rightAngleBracket();
@ -496,16 +496,16 @@ public final class Message extends Stanza implements TypedCloneable<Message> {
// Skip the default language
if (subject.equals(defaultSubject))
continue;
buf.append(subject.toXML(null));
buf.append(subject.toXML());
}
buf.optElement("thread", thread);
// Append the error subpacket if the message type is an error.
if (type == Type.error) {
appendErrorIfExists(buf, enclosingNamespace);
appendErrorIfExists(buf, enclosingXmlEnvironment);
}
// Add extension elements, if any are defined.
buf.append(getExtensions(), enclosingNamespace);
buf.append(getExtensions(), enclosingXmlEnvironment);
buf.closeElement(ELEMENT);
return buf;
@ -600,7 +600,7 @@ public final class Message extends Stanza implements TypedCloneable<Message> {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder();
xml.halfOpenElement(getElementName()).optXmlLangAttribute(getLanguage()).rightAngleBracket();
xml.escape(subject);
@ -708,8 +708,8 @@ public final class Message extends Stanza implements TypedCloneable<Message> {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
public XmlStringBuilder toXML(XmlEnvironment enclosingXmlEnvironment) {
XmlStringBuilder xml = new XmlStringBuilder(this, enclosingXmlEnvironment);
xml.optXmlLangAttribute(getLanguage()).rightAngleBracket();
xml.escape(message);
xml.closeElement(getElementName());

2
smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java
View file

@ -272,7 +272,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder buf = new XmlStringBuilder(enclosingNamespace);
buf.halfOpenElement(ELEMENT);
addCommonAttributes(buf, enclosingNamespace);

2
smack-core/src/main/java/org/jivesoftware/smack/packet/Session.java
View file

@ -67,7 +67,7 @@ public class Session extends SimpleIQ {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this);
if (optional) {
xml.rightAngleBracket();

2
smack-core/src/main/java/org/jivesoftware/smack/packet/StandardExtensionElement.java
View file

@ -132,7 +132,7 @@ public final class StandardExtensionElement implements ExtensionElement {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
if (xmlCache != null) {
return xmlCache;
}

31
smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java
View file

@ -503,25 +503,30 @@ public abstract class Stanza implements TopLevelStreamElement {
* Add to, from, id and 'xml:lang' attributes
*
* @param xml the {@link XmlStringBuilder}.
* @param enclosingNamespace the enclosing XML namespace.
* @return the set namespace for this stanza.
* @param enclosingXmlEnvironment the enclosing XML namespace.
* @return the XML environment for this stanza.
*/
protected String addCommonAttributes(XmlStringBuilder xml, String enclosingNamespace) {
String namespace;
if (enclosingNamespace == null || !enclosingNamespace.equals(StreamOpen.CLIENT_NAMESPACE)
|| !enclosingNamespace.equals(StreamOpen.SERVER_NAMESPACE)) {
namespace = StreamOpen.CLIENT_NAMESPACE;
} else {
namespace = enclosingNamespace;
protected XmlEnvironment addCommonAttributes(XmlStringBuilder xml, XmlEnvironment enclosingXmlEnvironment) {
String language = getLanguage();
String namespace = StreamOpen.CLIENT_NAMESPACE;
if (enclosingXmlEnvironment != null) {
String effectiveEnclosingNamespace = enclosingXmlEnvironment.getEffectiveNamespaceOrUse(namespace);
switch (effectiveEnclosingNamespace) {
case StreamOpen.CLIENT_NAMESPACE:
case StreamOpen.SERVER_NAMESPACE:
break;
default:
namespace = effectiveEnclosingNamespace;
}
}
xml.xmlnsAttribute(namespace);
xml.optAttribute("to", getTo());
xml.optAttribute("from", getFrom());
xml.optAttribute("id", getStanzaId());
xml.xmllangAttribute(getLanguage());
xml.xmllangAttribute(language);
return namespace;
return new XmlEnvironment(namespace, language);
}
protected void logCommonAttributes(StringBuilder sb) {
@ -541,10 +546,10 @@ public abstract class Stanza implements TopLevelStreamElement {
*
* @param xml the XmlStringBuilder to append the error to.
*/
protected void appendErrorIfExists(XmlStringBuilder xml, String enclosingNamespace) {
protected void appendErrorIfExists(XmlStringBuilder xml, XmlEnvironment enclosingXmlEnvironment) {
StanzaError error = getError();
if (error != null) {
xml.append(error.toXML(enclosingNamespace));
xml.append(error.toXML(enclosingXmlEnvironment));
}
}
}

13
smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaError.java
View file

@ -1,6 +1,6 @@
/**
*
* Copyright 2003-2007 Jive Software, 2015-2018 Florian Schmaus
* Copyright 2003-2007 Jive Software, 2015-2019 Florian Schmaus
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -214,17 +214,8 @@ public class StanzaError extends AbstractError implements ExtensionElement {
return StreamOpen.CLIENT_NAMESPACE;
}
/**
* Returns the error as XML.
*
* @return the error as XML.
*/
public XmlStringBuilder toXML() {
return toXML(null);
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
xml.attribute("type", type.toString());
xml.optAttribute("by", errorGenerator);

2
smack-core/src/main/java/org/jivesoftware/smack/packet/StartTls.java
View file

@ -50,7 +50,7 @@ public class StartTls implements Nonza {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this, enclosingNamespace);
xml.rightAngleBracket();
xml.condEmptyElement(required, "required");

2
smack-core/src/main/java/org/jivesoftware/smack/packet/StreamClose.java
View file

@ -24,7 +24,7 @@ public final class StreamClose implements Nonza {
}
@Override
public String toXML(String enclosingNamespace) {
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
return "</" + getElementName() + '>';
}

4
smack-core/src/main/java/org/jivesoftware/smack/packet/StreamError.java
View file

@ -136,11 +136,11 @@ public class StreamError extends AbstractError implements Nonza {
@Override
public String toString() {
return toXML(null).toString();
return toXML().toString();
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder();
xml.openElement(ELEMENT);
xml.halfOpenElement(condition.toString()).xmlnsAttribute(NAMESPACE).closeEmptyElement();

10
smack-core/src/main/java/org/jivesoftware/smack/packet/StreamOpen.java
View file

@ -96,14 +96,16 @@ public class StreamOpen implements Nonza {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(XmlEnvironment enclosingXmlEnvironment) {
XmlStringBuilder xml = new XmlStringBuilder();
xml.halfOpenElement(getElementName());
String namespace = CLIENT_NAMESPACE;
// We always want to state 'xmlns' for stream open tags.
if (enclosingNamespace == null) {
enclosingNamespace = CLIENT_NAMESPACE;
if (enclosingXmlEnvironment != null) {
namespace = enclosingXmlEnvironment.getEffectiveNamespaceOrUse(CLIENT_NAMESPACE);
}
xml.attribute("xmlns", enclosingNamespace);
xml.attribute("xmlns", namespace);
xml.attribute("to", to);
xml.attribute("xmlns:stream", "http://etherx.jabber.org/streams");

2
smack-core/src/main/java/org/jivesoftware/smack/packet/TlsFailure.java
View file

@ -37,7 +37,7 @@ public final class TlsFailure implements Nonza {
}
@Override
public String toXML(String enclosingNamespace) {
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
return '<' + ELEMENT + " xmlns='" + NAMESPACE + "'/>";
}
}

2
smack-core/src/main/java/org/jivesoftware/smack/packet/TlsProceed.java
View file

@ -37,7 +37,7 @@ public final class TlsProceed implements Nonza {
}
@Override
public String toXML(String enclosingNamespace) {
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
return '<' + ELEMENT + " xmlns='" + NAMESPACE + "'/>";
}
}

134
smack-core/src/main/java/org/jivesoftware/smack/packet/XmlEnvironment.java Normal file
View file

@ -0,0 +1,134 @@
/**
*
* Copyright 2019 Florian Schmaus
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.smack.packet;
import org.jivesoftware.smack.util.StringUtils;
public class XmlEnvironment {
public static final XmlEnvironment EMPTY = new XmlEnvironment((String) null);
private final String namespace;
private final String language;
private final XmlEnvironment next;
private transient boolean effectiveNamespaceDetermined;
private transient boolean effectiveLanguageDetermined;
private transient String effectiveNamespace;
private transient String effectiveLanguage;
public XmlEnvironment(String namespace) {
this(namespace, null);
}
public XmlEnvironment(String namespace, String language) {
this(namespace, language, null);
}
private XmlEnvironment(Builder builder) {
this(builder.namespace, builder.language, builder.next);
}
private XmlEnvironment(String namespace, String language, XmlEnvironment next) {
this.namespace = namespace;
this.language = language;
this.next = next;
}
public String getNamespace() {
return namespace;
}
public String getEffectiveNamespace() {
if (effectiveNamespaceDetermined) {
return effectiveNamespace;
}
if (StringUtils.isNotEmpty(namespace)) {
effectiveNamespace = namespace;
} else if (next != null) {
effectiveNamespace = next.getEffectiveNamespace();
}
effectiveNamespaceDetermined = true;
return effectiveNamespace;
}
public String getEffectiveNamespaceOrUse(String namespace) {
String effectiveNamespace = getEffectiveLanguage();
if (StringUtils.isNullOrEmpty(effectiveNamespace)) {
return namespace;
}
return effectiveNamespace;
}
public boolean effectiveNamespaceEquals(String namespace) {
String effectiveNamespace = getEffectiveNamespace();
if (effectiveNamespace == null) {
return false;
}
return effectiveNamespace.equals(namespace);
}
public String getLanguage() {
return language;
}
public String getEffectiveLanguage() {
if (effectiveLanguageDetermined) {
return effectiveLanguage;
}
if (StringUtils.isNotEmpty(language)) {
effectiveLanguage = language;
} else if (next != null) {
effectiveLanguage = next.getEffectiveLanguage();
}
effectiveLanguageDetermined = true;
return effectiveLanguage;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String namespace;
private String language;
private XmlEnvironment next;
public Builder withNamespace(String namespace) {
this.namespace = namespace;
return this;
}
public Builder withLanguage(String language) {
this.language = language;
return this;
}
public Builder withNext(XmlEnvironment next) {
this.next = next;
return this;
}
public XmlEnvironment build() {
return new XmlEnvironment(this);
}
}
}

12
smack-core/src/main/java/org/jivesoftware/smack/sasl/packet/SaslStreamElements.java
View file

@ -44,7 +44,7 @@ public class SaslStreamElements {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder();
xml.halfOpenElement(ELEMENT).xmlnsAttribute(NAMESPACE).attribute("mechanism", mechanism).rightAngleBracket();
xml.optAppend(authenticationText);
@ -84,7 +84,7 @@ public class SaslStreamElements {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder().halfOpenElement(ELEMENT).xmlnsAttribute(
NAMESPACE).rightAngleBracket();
xml.optAppend(data);
@ -120,7 +120,7 @@ public class SaslStreamElements {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder();
xml.halfOpenElement(ELEMENT).xmlnsAttribute(NAMESPACE).rightAngleBracket();
xml.optAppend(authenticationText);
@ -171,7 +171,7 @@ public class SaslStreamElements {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder();
xml.halfOpenElement(ELEMENT).xmlnsAttribute(NAMESPACE).rightAngleBracket();
xml.optAppend(data);
@ -236,7 +236,7 @@ public class SaslStreamElements {
}
@Override
public XmlStringBuilder toXML(String enclosingNamespace) {
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder();
xml.halfOpenElement(ELEMENT).xmlnsAttribute(NAMESPACE).rightAngleBracket();
xml.emptyElement(saslErrorString);
@ -247,7 +247,7 @@ public class SaslStreamElements {
@Override
public String toString() {
return toXML(null).toString();
return toXML().toString();
}
@Override

45
smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java
View file

@ -1,6 +1,6 @@
/**
*
* Copyright 2014-2018 Florian Schmaus
* Copyright 2014-2019 Florian Schmaus
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -26,6 +26,7 @@ import org.jivesoftware.smack.packet.Element;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.FullyQualifiedElement;
import org.jivesoftware.smack.packet.NamedElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jxmpp.util.XmppDateTime;
@ -34,15 +35,15 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
private final LazyStringBuilder sb;
private final String enclosingNamespace;
private final XmlEnvironment effectiveXmlEnvironment;
public XmlStringBuilder() {
this("");
this((XmlEnvironment) null);
}
public XmlStringBuilder(String enclosingNamespace) {
public XmlStringBuilder(XmlEnvironment effectiveXmlEnvironment) {
sb = new LazyStringBuilder();
this.enclosingNamespace = enclosingNamespace != null ? enclosingNamespace : "";
this.effectiveXmlEnvironment = effectiveXmlEnvironment;
}
public XmlStringBuilder(ExtensionElement pe) {
@ -55,8 +56,8 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
halfOpenElement(e.getElementName());
}
public XmlStringBuilder(FullyQualifiedElement ee, String enclosingNamespace) {
this(enclosingNamespace);
public XmlStringBuilder(FullyQualifiedElement ee, XmlEnvironment enclosingXmlEnvironment) {
this(enclosingXmlEnvironment);
prelude(ee);
}
@ -117,7 +118,7 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
public XmlStringBuilder element(Element element) {
assert element != null;
return append(element.toXML(null));
return append(element.toXML());
}
public XmlStringBuilder optElement(String name, String content) {
@ -152,7 +153,7 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
public XmlStringBuilder optElement(Element element) {
if (element != null) {
append(element.toXML(null));
append(element.toXML());
}
return this;
}
@ -399,10 +400,12 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
}
public XmlStringBuilder xmlnsAttribute(String value) {
if (value != null && !enclosingNamespace.equals(value)) {
XmlNsAttribute xmlNsAttribute = new XmlNsAttribute(value);
append(xmlNsAttribute);
if (value == null || (effectiveXmlEnvironment != null
&& effectiveXmlEnvironment.effectiveNamespaceEquals(value))) {
return this;
}
XmlNsAttribute xmlNsAttribute = new XmlNsAttribute(value);
append(xmlNsAttribute);
return this;
}
@ -460,7 +463,7 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
public XmlStringBuilder optAppend(Element element) {
if (element != null) {
append(element.toXML(enclosingNamespace));
append(element.toXML(effectiveXmlEnvironment));
}
return this;
}
@ -475,9 +478,9 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
return append(elements, null);
}
public XmlStringBuilder append(Collection<? extends Element> elements, String enclosingNamespace) {
public XmlStringBuilder append(Collection<? extends Element> elements, XmlEnvironment enclosingXmlEnvironment) {
for (Element element : elements) {
append(element.toXML(enclosingNamespace));
append(element.toXML(enclosingXmlEnvironment));
}
return this;
}
@ -592,22 +595,22 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
}
@Override
public CharSequence toXML(String enclosingNamespace) {
public CharSequence toXML(XmlEnvironment enclosingXmlEnvironment) {
StringBuilder res = new StringBuilder();
appendXmlTo(res, enclosingNamespace);
appendXmlTo(res, enclosingXmlEnvironment);
return res;
}
private void appendXmlTo(StringBuilder res, String enclosingNamespace) {
private void appendXmlTo(StringBuilder res, XmlEnvironment enclosingXmlEnvironment) {
for (CharSequence csq : sb.getAsList()) {
if (csq instanceof XmlStringBuilder) {
((XmlStringBuilder) csq).appendXmlTo(res, enclosingNamespace);
((XmlStringBuilder) csq).appendXmlTo(res, enclosingXmlEnvironment);
}
else if (csq instanceof XmlNsAttribute) {
XmlNsAttribute xmlNsAttribute = (XmlNsAttribute) csq;
if (!xmlNsAttribute.value.equals(enclosingNamespace)) {
if (!xmlNsAttribute.value.equals(enclosingXmlEnvironment.getEffectiveNamespace())) {
sb.append(xmlNsAttribute);
enclosingNamespace = xmlNsAttribute.value;
enclosingXmlEnvironment = new XmlEnvironment(xmlNsAttribute.value);
}
}
else {

4
smack-core/src/test/java/org/jivesoftware/smack/StanzaCollectorTest.java
View file

@ -182,13 +182,13 @@ public class StanzaCollectorTest {
}
@Override
public String toXML(String enclosingNamespace) {
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
return "<packetId>" + getStanzaId() + "</packetId>";
}
@Override
public String toString() {
return toXML(null);
return toXML().toString();
}
}
}

4
smack-core/src/test/java/org/jivesoftware/smack/compress/packet/FailureTest.java
View file

@ -31,7 +31,7 @@ public class FailureTest {
@Test
public void simpleFailureTest() throws SAXException, IOException {
Failure failure = new Failure(Failure.CompressFailureError.processing_failed);
CharSequence xml = failure.toXML(null);
CharSequence xml = failure.toXML();
final String expectedXml = "<failure xmlns='http://jabber.org/protocol/compress'><processing-failed/></failure>";
@ -44,7 +44,7 @@ public class FailureTest {
.setCondition(Condition.bad_request)
.build();
Failure failure = new Failure(Failure.CompressFailureError.setup_failed, stanzaError);
CharSequence xml = failure.toXML(null);
CharSequence xml = failure.toXML();
final String expectedXml = "<failure xmlns='http://jabber.org/protocol/compress'>"
+ "<setup-failed/>"

2
smack-core/src/test/java/org/jivesoftware/smack/packet/IQResponseTest.java
View file

@ -75,7 +75,7 @@ public class IQResponseTest {
assertNotNull(result.getStanzaId());
assertEquals(request.getStanzaId(), result.getStanzaId());
assertEquals(request.getFrom(), result.getTo());
assertEquals(error.build().toXML(), result.getError().toXML());
assertEquals(error.build().toXML().toString(), result.getError().toXML().toString());
// TODO this test was never valid
// assertEquals(CHILD_ELEMENT, result.getChildElementXML());
}

44
smack-core/src/test/java/org/jivesoftware/smack/packet/XmlEnvironmentTest.java Normal file
View file

@ -0,0 +1,44 @@
/**
*
* Copyright 2019 Florian Schmaus
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.smack.packet;
import static org.junit.Assert.assertEquals;
import org.junit.Test;
public class XmlEnvironmentTest {
@Test
public void testNamespaceScope() {
final String outerNamespace = "outerNamespace";
XmlEnvironment outer = XmlEnvironment.builder().withNamespace(outerNamespace).build();
XmlEnvironment inner = XmlEnvironment.builder().withNext(outer).build();
assertEquals(outerNamespace, inner.getEffectiveNamespace());
}
@Test
public void testLanguageScope() {
final String outerLanguage = "outerLanguage";
XmlEnvironment outer = XmlEnvironment.builder().withLanguage(outerLanguage).build();
XmlEnvironment inner = XmlEnvironment.builder().withNext(outer).build();
assertEquals(outerLanguage, inner.getEffectiveLanguage());
}
}

6
smack-core/src/test/java/org/jivesoftware/smack/parsing/StandardExtensionElementParserTest.java
View file

@ -31,7 +31,7 @@ public class StandardExtensionElementParserTest {
builder.addAttribute("attr1", "attr1-value");
builder.addElement(StandardExtensionElement.builder("bar", "ns2").addAttribute("attr2", "attr2-value").build());
builder.addElement("another-element", "another-element-text");
final String elementString = builder.build().toXML(null).toString();
final String elementString = builder.build().toXML().toString();
StandardExtensionElement parsedElement = StandardExtensionElementProvider.INSTANCE.parse(getParserFor(elementString));
@ -46,7 +46,7 @@ public class StandardExtensionElementParserTest {
assertEquals("another-element-text", parsedElement.getFirstElement("another-element").getText());
String parsedElementString = parsedElement.toXML(null).toString();
String parsedElementString = parsedElement.toXML().toString();
assertEquals(elementString, parsedElementString);
}
@ -55,7 +55,7 @@ public class StandardExtensionElementParserTest {
StandardExtensionElement.Builder builder = StandardExtensionElement.builder("foo", "ns1-value");
builder.addAttribute("xmlns:ns2", "ns2-value");
builder.addAttribute("ns2:bar", "bar-ns2-value");
final String elementString = builder.build().toXML(null).toString();
final String elementString = builder.build().toXML().toString();
StandardExtensionElement parsedElement = StandardExtensionElementProvider.INSTANCE.parse(getParserFor(elementString));
assertEquals("foo", parsedElement.getElementName());

26
smack-core/src/test/java/org/jivesoftware/smack/util/PacketParserUtilsTest.java
View file

@ -85,7 +85,7 @@ public class PacketParserUtilsTest {
assertTrue(message.getBodyLanguages().isEmpty());
assertEquals(defaultLanguage, message.getBody(defaultLanguage));
assertNull(message.getBody(otherLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
// message has non-default language, body has no language
control = XMLBuilder.create("message")
@ -105,7 +105,7 @@ public class PacketParserUtilsTest {
assertTrue(message.getBodyLanguages().isEmpty());
assertEquals(otherLanguage, message.getBody(otherLanguage));
assertNull(message.getBody(defaultLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
// message has no language, body has no language
control = XMLBuilder.create("message")
@ -124,7 +124,7 @@ public class PacketParserUtilsTest {
assertTrue(message.getBodyLanguages().isEmpty());
assertEquals(defaultLanguage, message.getBody(null));
assertNull(message.getBody(otherLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
// message has no language, body has default language
control = XMLBuilder.create("message")
@ -145,7 +145,7 @@ public class PacketParserUtilsTest {
assertEquals(defaultLanguage, message.getBody(defaultLanguage));
assertNull(message.getBody(otherLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
// message has no language, body has non-default language
control = XMLBuilder.create("message")
@ -166,7 +166,7 @@ public class PacketParserUtilsTest {
assertTrue(message.getBodyLanguages().contains(otherLanguage));
assertEquals(otherLanguage, message.getBody(otherLanguage));
assertNull(message.getBody(defaultLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
// message has default language, body has non-default language
control = XMLBuilder.create("message")
@ -188,7 +188,7 @@ public class PacketParserUtilsTest {
assertTrue(message.getBodyLanguages().contains(otherLanguage));
assertEquals(otherLanguage, message.getBody(otherLanguage));
assertNull(message.getBody(defaultLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
// message has non-default language, body has default language
control = XMLBuilder.create("message")
@ -210,7 +210,7 @@ public class PacketParserUtilsTest {
assertTrue(message.getBodyLanguages().contains(defaultLanguage));
assertEquals(defaultLanguage, message.getBody(defaultLanguage));
assertNull(message.getBody(otherLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
}
@ -393,7 +393,7 @@ public class PacketParserUtilsTest {
assertEquals(2, message.getBodies().size());
assertEquals(1, message.getBodyLanguages().size());
assertTrue(message.getBodyLanguages().contains(otherLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
// message has non-default language, first body no language, second body default language
control = XMLBuilder.create("message")
@ -419,7 +419,7 @@ public class PacketParserUtilsTest {
assertEquals(2, message.getBodies().size());
assertEquals(1, message.getBodyLanguages().size());
assertTrue(message.getBodyLanguages().contains(defaultLanguage));
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
}
// TODO: Re-enable once we throw an exception on duplicate body elements.
@ -452,7 +452,7 @@ public class PacketParserUtilsTest {
assertEquals(defaultLanguage, message.getBody(defaultLanguage));
assertEquals(1, message.getBodies().size());
assertEquals(0, message.getBodyLanguages().size());
assertXMLNotEqual(control, message.toXML(null).toString());
assertXMLNotEqual(control, message.toXML().toString());
}
@Ignore
@ -510,7 +510,7 @@ public class PacketParserUtilsTest {
assertEquals(otherLanguage, message.getBody(otherLanguage));
assertEquals(2, message.getBodies().size());
assertEquals(1, message.getBodyLanguages().size());
assertXMLEqual(control, message.toXML(null).toString());
assertXMLEqual(control, message.toXML().toString());
}
@Test
@ -692,7 +692,7 @@ public class PacketParserUtilsTest {
Message message = PacketParserUtils.parseMessage(TestUtils.getMessageParser(control));
fail("Should throw exception. Instead got message: " + message.toXML(null).toString());
fail("Should throw exception. Instead got message: " + message.toXML().toString());
}
@Test
@ -763,7 +763,7 @@ public class PacketParserUtilsTest {
.asString(outputProperties);
Stanza message = PacketParserUtils.parseStanza(control);