com.echomine.jabber.msg
Class OOBXMessage
java.lang.Object
com.echomine.jabber.JabberMessage
com.echomine.jabber.JabberJDOMMessage
com.echomine.jabber.msg.OOBXMessage
- All Implemented Interfaces:
- JabberCode, JabberMessageParsable
public class OOBXMessage
- extends JabberJDOMMessage
- implements JabberCode
Submits and parses a Out-Of-Band (OOB) IQ message. The message will return the URL to download a file from.
The OOB URL does not necessarily have to be http based. However, if it is not, then you may or may not be
able to handle the protocol. That is up to you to either accept or reject the OOB request.
Current Implementation: JEP-0066 Version 1.0
- Since:
- 0.8a4
Fields inherited from interface com.echomine.jabber.JabberCode |
MSG_CHAT, MSG_INIT, MSG_IQ, MSG_IQ_AGENTS, MSG_IQ_AUTH, MSG_IQ_BROWSE, MSG_IQ_DISCO_INFO, MSG_IQ_DISCO_ITEMS, MSG_IQ_GATEWAY, MSG_IQ_LAST, MSG_IQ_OOB, MSG_IQ_PRIVATE, MSG_IQ_REGISTER, MSG_IQ_ROSTER, MSG_IQ_SEARCH, MSG_IQ_TIME, MSG_IQ_VACATION, MSG_IQ_VCARD, MSG_IQ_VERSION, MSG_IQ_XMLRPC, MSG_PRESENCE, MSG_UNKNOWN, MSG_X_DATA, MSG_X_DELAY, MSG_X_EVENT, MSG_X_EXPIRE, MSG_X_OOB, MSG_X_PGP_ENCRYPTED, MSG_X_PGP_SIGNED, MSG_X_ROSTER, PARSER_CHAT, PARSER_IQ, PARSER_IQ_AGENTS, PARSER_IQ_AUTH, PARSER_IQ_BROWSE, PARSER_IQ_DISCO_INFO, PARSER_IQ_DISCO_ITEMS, PARSER_IQ_GATEWAY, PARSER_IQ_LAST, PARSER_IQ_OOB, PARSER_IQ_PRIVATE, PARSER_IQ_REGISTER, PARSER_IQ_ROSTER, PARSER_IQ_SEARCH, PARSER_IQ_TIME, PARSER_IQ_VACATION, PARSER_IQ_VCARD, PARSER_IQ_VERSION, PARSER_IQ_XMLRPC, PARSER_PRESENCE, PARSER_X_DATA, PARSER_X_DELAY, PARSER_X_EVENT, PARSER_X_EXPIRE, PARSER_X_OOB, PARSER_X_PGP_ENCRYPTED, PARSER_X_PGP_SIGNED, PARSER_X_ROSTER, XMLNS_CHAT, XMLNS_ERROR_STANZA, XMLNS_ERROR_STREAM, XMLNS_IQ, XMLNS_IQ_AGENTS, XMLNS_IQ_AUTH, XMLNS_IQ_BROWSE, XMLNS_IQ_DISCO_INFO, XMLNS_IQ_DISCO_ITEMS, XMLNS_IQ_GATEWAY, XMLNS_IQ_LAST, XMLNS_IQ_OOB, XMLNS_IQ_PRIVATE, XMLNS_IQ_REGISTER, XMLNS_IQ_ROSTER, XMLNS_IQ_SEARCH, XMLNS_IQ_TIME, XMLNS_IQ_VACATION, XMLNS_IQ_VCARD, XMLNS_IQ_VERSION, XMLNS_IQ_XMLRPC, XMLNS_PRESENCE, XMLNS_STREAM, XMLNS_X_DATA, XMLNS_X_DELAY, XMLNS_X_EVENT, XMLNS_X_EXPIRE, XMLNS_X_OOB, XMLNS_X_PGP_ENCRYPTED, XMLNS_X_PGP_SIGNED, XMLNS_X_ROSTER |
Methods inherited from class com.echomine.jabber.JabberMessage |
getMessageID, getReplyMessage, getTimeout, getXMessage, getXMessages, interrupt, isReplyRequired, isSendXMessages, isSynchronized, replyReceived, setReplyRequired, setSendXMessages, setSynchronized, setTimeout, setXMessage, setXMessages |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
OOBXMessage
public OOBXMessage()
parse
public JabberMessage parse(JabberMessageParser parser,
Element msgTree)
throws ParseException
- Description copied from interface:
JabberMessageParsable
- parse element/incoming message into a message object. Note that the parsing is unique in that
during normal behavior, you will return "this" at the end of the method. However, for those
message that require "morphing" into another message type (ie. IQ Messages), the method can
return a new instance of another JabberMessage to replace the current one.
- Specified by:
parse
in interface JabberMessageParsable
- Overrides:
parse
in class JabberJDOMMessage
- Throws:
ParseException
getUrl
public java.lang.String getUrl()
- Returns:
- the URL associated with the OOB
getDescription
public java.lang.String getDescription()
- Returns:
- description associated with the OOB
setUrl
public void setUrl(java.lang.String url)
setDescription
public void setDescription(java.lang.String description)
getMessageType
public int getMessageType()
- Description copied from class:
JabberJDOMMessage
- the default message type is unknown. It doesn't mean that there is no type.
It just means that there is no known message parser for this particular object.
- Overrides:
getMessageType
in class JabberJDOMMessage
- Returns:
- a message code that is unique to the message
- See Also:
JabberCode
Copyright © 2001-2005 Echomine. All Rights Reserved.