Добавление пользовательских атрибутов в тег сообщения в пакете XMPP с использованием asmack для Android?

Пакет сообщений, который я хочу получить.

  <message to="[email protected]/smack" chat_id="73392" 
           custom_packet="true" user_id="44" manager_id="39" time_stamp="0" website_id="0" 
           visitor_name="John" end_time="False" xml:lang="en-us" type="groupchat" 
           from="[email protected]/39">
           <body>Hello</body> 
           <x xmlns="http://jabber.org/protocol/muc#user"> 
           <status xmlns="" code="0"/>   
           </x></message>

Пакет сообщений, который я получаю.

<message to="[email protected]/Smack" 
    from="[email protected]/Visitor1171" type="groupchat">
    <body>Hello</body>
    <delay xmlns="urn:xmpp:delay"></delay>
    <x xmlns="jabber:x:delay" stamp="20120917T05:57:19" 
    from="[email protected]/4732abb5">
    </x></message>

У меня есть исходный код привкуса, а вот класс пакета. Может ли кто-нибудь помочь мне сделать мой собственный пакет. Приветствуется любая помощь в изменении исходного кода.

Код:

public abstract class Packet {

protected static final String DEFAULT_LANGUAGE =
        java.util.Locale.getDefault().getLanguage().toLowerCase();

private static String DEFAULT_XML_NS = null;

/**
 * Constant used as packetID to indicate that a packet has no id. To indicate that a packet
 * has no id set this constant as the packet's id. When the packet is asked for its id the
 * answer will be <tt>null</tt>.
 */
public static final String ID_NOT_AVAILABLE = "ID_NOT_AVAILABLE";

/**
 * Date format as defined in XEP-0082 - XMPP Date and Time Profiles.
 * The time zone is set to UTC.
 * <p>
 * Date formats are not synchronized. Since multiple threads access the format concurrently,
 * it must be synchronized externally. 
 */
public static final DateFormat XEP_0082_UTC_FORMAT = new SimpleDateFormat(
                "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
static {
    XEP_0082_UTC_FORMAT.setTimeZone(TimeZone.getTimeZone("UTC"));
}


/**
 * A prefix helps to make sure that ID's are unique across mutliple instances.
 */
private static String prefix = StringUtils.randomString(5) + "-";

/**
 * Keeps track of the current increment, which is appended to the prefix to
 * forum a unique ID.
 */
private static long id = 0;

private String xmlns = DEFAULT_XML_NS;

/**
 * Returns the next unique id. Each id made up of a short alphanumeric
 * prefix along with a unique numeric value.
 *
 * @return the next id.
 */
public static synchronized String nextID() {
    return prefix + Long.toString(id++);
}

public static void setDefaultXmlns(String defaultXmlns) {
    DEFAULT_XML_NS = defaultXmlns;
}

private String packetID = null;
private String to = null;
private String from = null;
private final List<PacketExtension> packetExtensions
        = new CopyOnWriteArrayList<PacketExtension>();

private final Map<String,Object> properties = new HashMap<String, Object>();
private XMPPError error = null;

/**
 * Returns the unique ID of the packet. The returned value could be <tt>null</tt> when
 * ID_NOT_AVAILABLE was set as the packet's id.
 *
 * @return the packet's unique ID or <tt>null</tt> if the packet's id is not available.
 */
public String getPacketID() {
    if (ID_NOT_AVAILABLE.equals(packetID)) {
        return null;
    }

    if (packetID == null) {
        packetID = nextID();
    }
    return packetID;
}

/**
 * Sets the unique ID of the packet. To indicate that a packet has no id
 * pass the constant ID_NOT_AVAILABLE as the packet's id value.
 *
 * @param packetID the unique ID for the packet.
 */
public void setPacketID(String packetID) {
    this.packetID = packetID;
}

/**
 * Returns who the packet is being sent "to", or <tt>null</tt> if
 * the value is not set. The XMPP protocol often makes the "to"
 * attribute optional, so it does not always need to be set.<p>
 *
 * The StringUtils class provides several useful methods for dealing with
 * XMPP addresses such as parsing the
 * {@link StringUtils#parseBareAddress(String) bare address},
 * {@link StringUtils#parseName(String) user name},
 * {@link StringUtils#parseServer(String) server}, and
 * {@link StringUtils#parseResource(String) resource}.  
 *
 * @return who the packet is being sent to, or <tt>null</tt> if the
 *      value has not been set.
 */
public String getTo() {
    return to;
}

/**
 * Sets who the packet is being sent "to". The XMPP protocol often makes
 * the "to" attribute optional, so it does not always need to be set.
 *
 * @param to who the packet is being sent to.
 */
public void setTo(String to) {
    this.to = to;
}

/**
 * Returns who the packet is being sent "from" or <tt>null</tt> if
 * the value is not set. The XMPP protocol often makes the "from"
 * attribute optional, so it does not always need to be set.<p>
 *
 * The StringUtils class provides several useful methods for dealing with
 * XMPP addresses such as parsing the
 * {@link StringUtils#parseBareAddress(String) bare address},
 * {@link StringUtils#parseName(String) user name},
 * {@link StringUtils#parseServer(String) server}, and
 * {@link StringUtils#parseResource(String) resource}.  
 *
 * @return who the packet is being sent from, or <tt>null</tt> if the
 *      value has not been set.
 */
public String getFrom() {
    return from;
}

/**
 * Sets who the packet is being sent "from". The XMPP protocol often
 * makes the "from" attribute optional, so it does not always need to
 * be set.
 *
 * @param from who the packet is being sent to.
 */
public void setFrom(String from) {
    this.from = from;
}

/**
 * Returns the error associated with this packet, or <tt>null</tt> if there are
 * no errors.
 *
 * @return the error sub-packet or <tt>null</tt> if there isn't an error.
 */
public XMPPError getError() {
    return error;
}

/**
 * Sets the error for this packet.
 *
 * @param error the error to associate with this packet.
 */
public void setError(XMPPError error) {
    this.error = error;
}

/**
 * Returns an unmodifiable collection of the packet extensions attached to the packet.
 *
 * @return the packet extensions.
 */
public synchronized Collection<PacketExtension> getExtensions() {
    if (packetExtensions == null) {
        return Collections.emptyList();
    }
    return Collections.unmodifiableList(new ArrayList<PacketExtension>(packetExtensions));
}

/**
 * Returns the first extension of this packet that has the given namespace.
 *
 * @param namespace the namespace of the extension that is desired.
 * @return the packet extension with the given namespace.
 */
public PacketExtension getExtension(String namespace) {
    return getExtension(null, namespace);
}

/**
 * Returns the first packet extension that matches the specified element name and
 * namespace, or <tt>null</tt> if it doesn't exist. If the provided elementName is null
 * than only the provided namespace is attempted to be matched. Packet extensions are
 * are arbitrary XML sub-documents in standard XMPP packets. By default, a 
 * DefaultPacketExtension instance will be returned for each extension. However, 
 * PacketExtensionProvider instances can be registered with the 
 * {@link org.jivesoftware.smack.provider.ProviderManager ProviderManager}
 * class to handle custom parsing. In that case, the type of the Object
 * will be determined by the provider.
 *
 * @param elementName the XML element name of the packet extension. (May be null)
 * @param namespace the XML element namespace of the packet extension.
 * @return the extension, or <tt>null</tt> if it doesn't exist.
 */
public PacketExtension getExtension(String elementName, String namespace) {
    if (namespace == null) {
        return null;
    }
    for (PacketExtension ext : packetExtensions) {
        if ((elementName == null || elementName.equals(ext.getElementName()))
                && namespace.equals(ext.getNamespace()))
        {
            return ext;
        }
    }
    return null;
}

/**
 * Adds a packet extension to the packet.
 *
 * @param extension a packet extension.
 */
public void addExtension(PacketExtension extension) {
    packetExtensions.add(extension);
}

/**
 * Removes a packet extension from the packet.
 *
 * @param extension the packet extension to remove.
 */
public void removeExtension(PacketExtension extension)  {
    packetExtensions.remove(extension);
}

/**
 * Returns the packet property with the specified name or <tt>null</tt> if the
 * property doesn't exist. Property values that were orginally primitives will
 * be returned as their object equivalent. For example, an int property will be
 * returned as an Integer, a double as a Double, etc.
 *
 * @param name the name of the property.
 * @return the property, or <tt>null</tt> if the property doesn't exist.
 */
public synchronized Object getProperty(String name) {
    if (properties == null) {
        return null;
    }
    return properties.get(name);
}

/**
 * Sets a property with an Object as the value. The value must be Serializable
 * or an IllegalArgumentException will be thrown.
 *
 * @param name the name of the property.
 * @param value the value of the property.
 */
public synchronized void setProperty(String name, Object value) {
    if (!(value instanceof Serializable)) {
        throw new IllegalArgumentException("Value must be serialiazble");
    }
    properties.put(name, value);
}

/**
 * Deletes a property.
 *
 * @param name the name of the property to delete.
 */
public synchronized void deleteProperty(String name) {
    if (properties == null) {
        return;
    }
    properties.remove(name);
}

/**
 * Returns an unmodifiable collection of all the property names that are set.
 *
 * @return all property names.
 */
public synchronized Collection<String> getPropertyNames() {
    if (properties == null) {
        return Collections.emptySet();
    }
    return Collections.unmodifiableSet(new HashSet<String>(properties.keySet()));
}

/**
 * Returns the packet as XML. Every concrete extension of Packet must implement
 * this method. In addition to writing out packet-specific data, every sub-class
 * should also write out the error and the extensions data if they are defined.
 *
 * @return the XML format of the packet as a String.
 */
public abstract String toXML();

/**
 * Returns the extension sub-packets (including properties data) as an XML
 * String, or the Empty String if there are no packet extensions.
 *
 * @return the extension sub-packets as XML or the Empty String if there
 * are no packet extensions.
 */
protected synchronized String getExtensionsXML() {
    StringBuilder buf = new StringBuilder();
    // Add in all standard extension sub-packets.
    for (PacketExtension extension : getExtensions()) {
        buf.append(extension.toXML());
    }
    // Add in packet properties.
    if (properties != null && !properties.isEmpty()) {
        buf.append("<properties xmlns=\"http://www.jivesoftware.com/xmlns/xmpp/properties\">");
        // Loop through all properties and write them out.
        for (String name : getPropertyNames()) {
            Object value = getProperty(name);
            buf.append("<property>");
            buf.append("<name>").append(StringUtils.escapeForXML(name)).append("</name>");
            buf.append("<value type=\"");
            if (value instanceof Integer) {
                buf.append("integer\">").append(value).append("</value>");
            }
            else if (value instanceof Long) {
                buf.append("long\">").append(value).append("</value>");
            }
            else if (value instanceof Float) {
                buf.append("float\">").append(value).append("</value>");
            }
            else if (value instanceof Double) {
                buf.append("double\">").append(value).append("</value>");
            }
            else if (value instanceof Boolean) {
                buf.append("boolean\">").append(value).append("</value>");
            }
            else if (value instanceof String) {
                buf.append("string\">");
                buf.append(StringUtils.escapeForXML((String)value));
                buf.append("</value>");
            }
            // Otherwise, it's a generic Serializable object. Serialized objects are in
            // a binary format, which won't work well inside of XML. Therefore, we base-64
            // encode the binary data before adding it.
            else {
                ByteArrayOutputStream byteStream = null;
                ObjectOutputStream out = null;
                try {
                    byteStream = new ByteArrayOutputStream();
                    out = new ObjectOutputStream(byteStream);
                    out.writeObject(value);
                    buf.append("java-object\">");
                    String encodedVal = StringUtils.encodeBase64(byteStream.toByteArray());
                    buf.append(encodedVal).append("</value>");
                }
                catch (Exception e) {
                    e.printStackTrace();
                }
                finally {
                    if (out != null) {
                        try {
                            out.close();
                        }
                        catch (Exception e) {
                            // Ignore.
                        }
                    }
                    if (byteStream != null) {
                        try {
                            byteStream.close();
                        }
                        catch (Exception e) {
                            // Ignore.
                        }
                    }
                }
            }
            buf.append("</property>");
        }
        buf.append("</properties>");
    }
    return buf.toString();
}

public String getXmlns() {
    return this.xmlns;
}

public static String getDefaultLanguage() {
    return DEFAULT_LANGUAGE;
}


@Override
public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;

    Packet packet = (Packet) o;

    if (error != null ? !error.equals(packet.error) : packet.error != null) { return false; }
    if (from != null ? !from.equals(packet.from) : packet.from != null) { return false; }
    if (!packetExtensions.equals(packet.packetExtensions)) { return false; }
    if (packetID != null ? !packetID.equals(packet.packetID) : packet.packetID != null) {
        return false;
    }
    if (properties != null ? !properties.equals(packet.properties)
            : packet.properties != null) {
        return false;
    }
    if (to != null ? !to.equals(packet.to) : packet.to != null)  { return false; }
    return !(xmlns != null ? !xmlns.equals(packet.xmlns) : packet.xmlns != null);
}

@Override
public int hashCode() {
    int result;
    result = (xmlns != null ? xmlns.hashCode() : 0);
    result = 31 * result + (packetID != null ? packetID.hashCode() : 0);
    result = 31 * result + (to != null ? to.hashCode() : 0);
    result = 31 * result + (from != null ? from.hashCode() : 0);
    result = 31 * result + packetExtensions.hashCode();
    result = 31 * result + properties.hashCode();
    result = 31 * result + (error != null ? error.hashCode() : 0);
    return result;
}
}

person Sheraz Ahmad Khilji    schedule 18.09.2012    source источник
comment
Никогда не добавляйте пользовательские данные в качестве дополнительных атрибутов (visitor_name, end_time) к уже определенным элементам XMPP (message). Всегда создавайте дополнительное расширение пакета, чтобы добавить свои пользовательские данные, потому что в противном случае вам придется возиться с источником задействованных библиотек XMPP.   -  person Flow    schedule 26.04.2014
comment
См. также XEP-134 2.1.   -  person Flow    schedule 12.01.2015
comment
@Flow да, ты прав, но в то время никто не подал мне такую ​​идею. Я все равно был бы очень признателен, если бы вы предоставили мне код для создания расширения пакета и добавления к нему пользовательских данных.   -  person Sheraz Ahmad Khilji    schedule 14.01.2015
comment
Я предлагаю взглянуть на документацию Smack.   -  person Flow    schedule 14.01.2015
comment
Это не рекомендуемый подход, вместо этого используйте поставщиков расширений.   -  person    schedule 22.04.2016


Ответы (5)


Хотя я думаю, что это неправильный подход, как я сказал в вашем другом вопросе. Вот несколько рекомендаций относительно того, что вы пытаетесь сделать.

Вам не нужно изменять Packet, просто расширьте Message, чтобы добавить свои собственные атрибуты. Это позволит выполнить то, что требуется для отправки. Для получения необходимо изменить PacketParserUtil.parseMessage(), чтобы иметь возможность определить, отправляется ли ваше пользовательское или стандартное сообщение, а также создать и заполнить его соответствующим образом. Я не знаю, могут ли сервер, который вы используете, иметь проблемы с этим или нет, из-за того, что он нестандартен, но, вероятно, он будет работать.

Другой более простой вариант — просто добавить свои атрибуты в качестве свойств к стандартному сообщению через Packet.setProperty() и, конечно же, читать через getProperty(). Это создаст и расширит пакет, но никаких специальных действий не требуется, так как Smack уже будет читать/записывать расширение.

person Robin    schedule 18.09.2012
comment
Спасибо большое. Это было именно то, что я сделал, и это решило проблему. Я изменил класс Packet, а также изменил метод parseMessage() класса PacketParserUtils. - person Sheraz Ahmad Khilji; 19.09.2012
comment
Могу ли я получить указанный выше пакет без изменения исходного кода? - person Sheraz Ahmad Khilji; 21.11.2013
comment
Если я расширяю PacketParserUtils или класс Message, есть ли способ зарегистрировать эти классы или мне придется включать весь исходный код вместо jar? - person sbaar; 04.10.2014

Я добавил новые поля в Packet Class и написал там Getter и Setter.

private String chat_id = null;
private String custom_packet = null;
private String user_id=null;
private String manager_id=null;
private String time_stamp=null;
private String website_id=null;
private String visitor_name=null;
private String end_time=null;




public String getChat_id() {
    return chat_id;
}

public void setChat_id(String chat_id) {
    this.chat_id = chat_id;
}

public String getCustom_packet() {
    return custom_packet;
}

public void setCustom_packet(String custom_packet) {
    this.custom_packet = custom_packet;
}

public String getUser_id() {
    return user_id;
}

public void setUser_id(String user_id) {
    this.user_id = user_id;
}

public String getManager_id() {
    return manager_id;
}

public void setManager_id(String manager_id) {
    this.manager_id = manager_id;
}

public String getTime_stamp() {
    return time_stamp;
}

public void setTime_stamp(String time_stamp) {
    this.time_stamp = time_stamp;
}

public String getWebsite_id() {
    return website_id;
}

public void setWebsite_id(String website_id) {
    this.website_id = website_id;
}

public String getVisitor_name() {
    return visitor_name;
}

public void setVisitor_name(String visitor_name) {
    this.visitor_name = visitor_name;
}

public String getEnd_time() {
    return end_time;
}

public void setEnd_time(String end_time) {
    this.end_time = end_time;
}

Затем я добавил это в метод parseMessage() класса PacketParserUtils.

    // ------------------------------CUSTOM ATTRIBUTES-----------------------------
    message.setChat_id(parser.getAttributeValue("", "chat_id"));
    message.setCustom_packet(parser.getAttributeValue("", "custom_packet"));
    message.setUser_id(parser.getAttributeValue("", "user_id"));
    message.setManager_id(parser.getAttributeValue("", "manager_id"));
    message.setTime_stamp(parser.getAttributeValue("", "time_stamp"));
    message.setWebsite_id(parser.getAttributeValue("", "website_id"));
    message.setVisitor_name(parser.getAttributeValue("", "visitor_name"));
    message.setEnd_time(parser.getAttributeValue("", "end_time"));

    // -----------------------------------------------------------------------------

Затем я обновил метод toXML() класса сообщений.

// ------------------------------CUSTOM TAGS-----------------------------

    if(getChat_id()!=null)
    {
        buf.append(" chat_id=\"").append(StringUtils.escapeForXML(getChat_id())).append("\"");

    }
    if(getCustom_packet()!=null)
    {
        buf.append(" custom_packet=\"").append(StringUtils.escapeForXML(getCustom_packet())).append("\"");

    }
    if(getUser_id()!=null)
    {
        buf.append(" user_id=\"").append(StringUtils.escapeForXML(getUser_id())).append("\"");

    }

    if(getManager_id()!=null)
    {
        buf.append(" manager_id=\"").append(StringUtils.escapeForXML(getManager_id())).append("\"");

    }
    if(getTime_stamp()!=null)
    {
        buf.append(" time_stamp=\"").append(StringUtils.escapeForXML(getTime_stamp())).append("\"");

    }
    if(getWebsite_id()!=null)
    {
        buf.append(" website_id=\"").append(StringUtils.escapeForXML(getWebsite_id())).append("\"");

    }
    if(getVisitor_name()!=null)
    {
        buf.append(" visitor_name=\"").append(StringUtils.escapeForXML(getVisitor_name())).append("\"");

    }
    if(getEnd_time()!=null)
    {
        buf.append(" end_time=\"").append(StringUtils.escapeForXML(getEnd_time())).append("\"");

    }

    //------------------------------------------------------------------------------------

Вот как я смог получить пользовательские атрибуты в теге сообщения.

person Sheraz Ahmad Khilji    schedule 19.09.2012
comment
tnx за этот ответ, но я получаю нулевые значения пользовательских атрибутов. Можете ли вы помочь мне в этом? - person Chirag Shah; 02.04.2014
comment
@ChiragShah Вы правильно изменили исходный код? - person Sheraz Ahmad Khilji; 03.04.2014
comment
да, я получил решение, это была немного моя ошибка. - person Chirag Shah; 03.04.2014
comment
@ChiragShah Эм, рад, что тебе помогло :) - person Sheraz Ahmad Khilji; 03.04.2014
comment
Я думаю, что это хороший ответ, но я согласен с @Robin, что этого делать не следует. - person Moxor; 03.07.2015
comment
Не делайте этого, это не рекомендуемый подход, вместо этого используйте провайдеры расширений. - person ; 22.04.2016
comment
@penguin, не могли бы вы мне помочь stackoverflow.com/questions/41734043/ в этом случае выдает пользователю незарегистрированную ошибку - person Vishal Patoliya ツ; 20.01.2017

Если вы можете добавить использование пользовательского расширения пакета, как описано в smack, сделайте это. Если вы хотите быть совместимым с сервером или не-smack-клиентом, который не поддерживает такие расширения, например, если сервер не будет их хранить, используйте

message.addBody("varName","varValue);

<message id='8dbda9a2-1f98-478f-9a65-635f181a6ddc' 
to='[email protected]/oGghwFpcrR' type='chat'><body>abcd</body>
<body xml:lang='varName'>varValue</body><thread>8b5342dcc</thread>        
</message>

message.getBody("varName");

Не идеальное решение, но кто вообще использует несколько языков для идентичного сообщения? Что Smack должен позволить вам сделать, так это зарегистрироваться для собственного анализа сообщений, чтобы заменить стандартное или, по крайней мере, в дополнение к стандартному.

person sbaar    schedule 05.10.2014

У нас была такая же проблема. Вот общее решение для значения тега:

В пакетном классе добавлено:

public static ArrayList<String> parseTags = new ArrayList<String>();
public HashMap<String, String> mTags ;

Конструктор: mTags = new HashMap(); Конструктор копирования: mTags = p.mTags;

В PacketParserUtils.ParseMessage() добавлено

    if (message.mTags != null) {
        for (int i=0; i<Packet.parseTags.size(); i++) {
            String tag = Packet.parseTags.get(i);
            String value = parser.getAttributeValue("", tag);
            message.mTags.put(tag, value);
        }               
    }        

В Message.toXML перед добавлением ">" добавьте:

    if (mTags != null) {
        Iterator<Entry<String, String>> it = mTags.entrySet().iterator();
        while (it.hasNext()) {
            Entry pairs = (Map.Entry)it.next();
            String tag = (String) pairs.getKey();
            String value = (String) pairs.getValue(); 
            buf.append(" ").append(tag).append("=\"").append(value).append("\"");
        }               
    }        

Затем в приложении перед настройкой обработчика пакетов добавьте все свои пользовательские теги, например:

     Packet.parseTags.add(ROOMTYPE);
     Packet.parseTags.add(ROOMNAME);
     Packet.parseTags.add(CHATTYPE);

также перед отправкой сообщений добавьте такие вещи, как:

     message.mTags.put(ROOMTYPE, "Private");
     message.mTags.put(ROOMNAME, UHInterface.liveSessionID);
     message.mTags.put(MSGTYPE, "Photo");
person Srini Srinivasan    schedule 08.10.2014

Используйте Message.setProperty(), потому что класс сообщений расширяет Packet.

В классе Message используйте in method String toXML(), sb.append("<tag_x>").append(String.valueOf(super.getProperty("tag"))).append("</tag_x>");

И в вызове проекта

Message.getProperty
person carlosramirezmx    schedule 16.03.2016