mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-09-27 18:19:33 +02:00
186 lines
5.6 KiB
Java
186 lines
5.6 KiB
Java
/**
|
|
*
|
|
* Copyright the original author or authors
|
|
*
|
|
* 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.smackx.pubsub;
|
|
|
|
import org.jivesoftware.smack.XMPPConnection;
|
|
import org.jivesoftware.smack.packet.ExtensionElement;
|
|
import org.jivesoftware.smack.util.Objects;
|
|
import org.jivesoftware.smack.util.StringUtils;
|
|
import org.jivesoftware.smack.util.XmlStringBuilder;
|
|
|
|
import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace;
|
|
|
|
import org.jxmpp.jid.BareJid;
|
|
|
|
/**
|
|
* Represents a affiliation between a user and a node, where the {@link Type} defines
|
|
* the type of affiliation.
|
|
*
|
|
* Affiliations are retrieved from the {@link PubSubManager#getAffiliations()} method, which
|
|
* gets affiliations for the calling user, based on the identity that is associated with
|
|
* the {@link XMPPConnection}.
|
|
*
|
|
* @author Robin Collier
|
|
*/
|
|
public class Affiliation implements ExtensionElement {
|
|
public static final String ELEMENT = "affiliation";
|
|
|
|
public enum AffiliationNamespace {
|
|
basic(PubSubElementType.AFFILIATIONS),
|
|
owner(PubSubElementType.AFFILIATIONS_OWNER),
|
|
;
|
|
public final PubSubElementType type;
|
|
|
|
AffiliationNamespace(PubSubElementType type) {
|
|
this.type = type;
|
|
}
|
|
|
|
public static AffiliationNamespace fromXmlns(String xmlns) {
|
|
for (AffiliationNamespace affiliationsNamespace : AffiliationNamespace.values()) {
|
|
if (affiliationsNamespace.type.getNamespace().getXmlns().equals(xmlns)) {
|
|
return affiliationsNamespace;
|
|
}
|
|
}
|
|
throw new IllegalArgumentException("Invalid affiliations namespace: " + xmlns);
|
|
}
|
|
}
|
|
|
|
private final BareJid jid;
|
|
private final String node;
|
|
private final Type affiliation;
|
|
private final AffiliationNamespace namespace;
|
|
|
|
public enum Type {
|
|
member, none, outcast, owner, publisher
|
|
}
|
|
|
|
/**
|
|
* Constructs an affiliation.
|
|
*
|
|
* @param node The node the user is affiliated with.
|
|
* @param affiliation the optional affiliation.
|
|
*/
|
|
public Affiliation(String node, Type affiliation) {
|
|
this(node, affiliation, affiliation == null ? AffiliationNamespace.basic : AffiliationNamespace.owner);
|
|
}
|
|
|
|
/**
|
|
* Constructs an affiliation.
|
|
*
|
|
* @param node The node the user is affiliated with.
|
|
* @param affiliation the optional affiliation.
|
|
* @param namespace the affiliation's namespace.
|
|
*/
|
|
public Affiliation(String node, Type affiliation, AffiliationNamespace namespace) {
|
|
this.node = StringUtils.requireNotNullNorEmpty(node, "node must not be null nor empty");
|
|
this.affiliation = affiliation;
|
|
this.jid = null;
|
|
this.namespace = Objects.requireNonNull(namespace);
|
|
}
|
|
|
|
/**
|
|
* Construct a affiliation modification request.
|
|
*
|
|
* @param jid TODO javadoc me please
|
|
* @param affiliation TODO javadoc me please
|
|
*/
|
|
public Affiliation(BareJid jid, Type affiliation) {
|
|
this(jid, affiliation, AffiliationNamespace.owner);
|
|
}
|
|
|
|
public Affiliation(BareJid jid, Type affiliation, AffiliationNamespace namespace) {
|
|
this.jid = jid;
|
|
this.affiliation = affiliation;
|
|
this.node = null;
|
|
// This is usually the pubsub#owner namespace, but see xep60 example 208 where just 'pubsub' is used
|
|
// ("notification of affiliation change")
|
|
this.namespace = namespace;
|
|
}
|
|
|
|
/**
|
|
* Get the node.
|
|
*
|
|
* @return the node.
|
|
* @deprecated use {@link #getNode} instead.
|
|
*/
|
|
@Deprecated
|
|
public String getNodeId() {
|
|
return getNode();
|
|
}
|
|
|
|
public String getNode() {
|
|
return node;
|
|
}
|
|
|
|
/**
|
|
* Get the type.
|
|
*
|
|
* @return the type.
|
|
* @deprecated use {@link #getAffiliation()} instead.
|
|
*/
|
|
@Deprecated
|
|
public Type getType() {
|
|
return getAffiliation();
|
|
}
|
|
|
|
public Type getAffiliation() {
|
|
return affiliation;
|
|
}
|
|
|
|
public BareJid getJid() {
|
|
return jid;
|
|
}
|
|
|
|
@Override
|
|
public String getElementName() {
|
|
return ELEMENT;
|
|
}
|
|
|
|
@Override
|
|
public String getNamespace() {
|
|
return getPubSubNamespace().getXmlns();
|
|
}
|
|
|
|
public PubSubNamespace getPubSubNamespace() {
|
|
return namespace.type.getNamespace();
|
|
}
|
|
|
|
/**
|
|
* Check if this is an affiliation element to modify affiliations on a node.
|
|
*
|
|
* @return <code>true</code> if this is an affiliation element to modify affiliations on a node, <code>false</code> otherwise.
|
|
* @since 4.2
|
|
*/
|
|
public boolean isAffiliationModification() {
|
|
if (jid != null && affiliation != null) {
|
|
assert node == null && namespace == AffiliationNamespace.owner;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
@Override
|
|
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
|
|
XmlStringBuilder xml = new XmlStringBuilder(this);
|
|
xml.optAttribute("node", node);
|
|
xml.optAttribute("jid", jid);
|
|
xml.optAttribute("affiliation", affiliation);
|
|
xml.closeEmptyElement();
|
|
return xml;
|
|
}
|
|
}
|