Search in sources :

Example 6 with XMPPError

use of org.jivesoftware.smack.packet.XMPPError in project Smack by igniterealtime.

the class AdHocCommandManager method processAdHocCommand.

/**
     * Process the AdHoc-Command stanza(/packet) that request the execution of some
     * action of a command. If this is the first request, this method checks,
     * before executing the command, if:
     * <ul>
     *  <li>The requested command exists</li>
     *  <li>The requester has permissions to execute it</li>
     *  <li>The command has more than one stage, if so, it saves the command and
     *      session ID for further use</li>
     * </ul>
     * 
     * <br>
     * <br>
     * If this is not the first request, this method checks, before executing
     * the command, if:
     * <ul>
     *  <li>The session ID of the request was stored</li>
     *  <li>The session life do not exceed the time out</li>
     *  <li>The action to execute is one of the available actions</li>
     * </ul>
     *
     * @param requestData
     *            the stanza(/packet) to process.
     * @throws NotConnectedException
     * @throws NoResponseException
     * @throws InterruptedException 
     */
private IQ processAdHocCommand(AdHocCommandData requestData) throws NoResponseException, NotConnectedException, InterruptedException {
    // Creates the response with the corresponding data
    AdHocCommandData response = new AdHocCommandData();
    response.setTo(requestData.getFrom());
    response.setStanzaId(requestData.getStanzaId());
    response.setNode(requestData.getNode());
    response.setId(requestData.getTo());
    String sessionId = requestData.getSessionID();
    String commandNode = requestData.getNode();
    if (sessionId == null) {
        // command exists
        if (!commands.containsKey(commandNode)) {
            // item_not_found error.
            return respondError(response, XMPPError.Condition.item_not_found);
        }
        // Create new session ID
        sessionId = StringUtils.randomString(15);
        try {
            // Create a new instance of the command with the
            // corresponding sessioid
            LocalCommand command = newInstanceOfCmd(commandNode, sessionId);
            response.setType(IQ.Type.result);
            command.setData(response);
            // enough to execute the requested command
            if (!command.hasPermission(requestData.getFrom())) {
                return respondError(response, XMPPError.Condition.forbidden);
            }
            Action action = requestData.getAction();
            // If the action is unknown then respond an error.
            if (action != null && action.equals(Action.unknown)) {
                return respondError(response, XMPPError.Condition.bad_request, AdHocCommand.SpecificErrorCondition.malformedAction);
            }
            // If the action is not execute, then it is an invalid action.
            if (action != null && !action.equals(Action.execute)) {
                return respondError(response, XMPPError.Condition.bad_request, AdHocCommand.SpecificErrorCondition.badAction);
            }
            // Increase the state number, so the command knows in witch
            // stage it is
            command.incrementStage();
            // Executes the command
            command.execute();
            if (command.isLastStage()) {
                // If there is only one stage then the command is completed
                response.setStatus(Status.completed);
            } else {
                // Else it is still executing, and is registered to be
                // available for the next call
                response.setStatus(Status.executing);
                executingCommands.put(sessionId, command);
                // See if the session reaping thread is started. If not, start it.
                if (sessionsSweeper == null) {
                    sessionsSweeper = new Thread(new Runnable() {

                        @Override
                        public void run() {
                            while (true) {
                                for (String sessionId : executingCommands.keySet()) {
                                    LocalCommand command = executingCommands.get(sessionId);
                                    // map.
                                    if (command != null) {
                                        long creationStamp = command.getCreationDate();
                                        // invalid session error and not a time out error.
                                        if (System.currentTimeMillis() - creationStamp > SESSION_TIMEOUT * 1000 * 2) {
                                            // Remove the expired session
                                            executingCommands.remove(sessionId);
                                        }
                                    }
                                }
                                try {
                                    Thread.sleep(1000);
                                } catch (InterruptedException ie) {
                                // Ignore.
                                }
                            }
                        }
                    });
                    sessionsSweeper.setDaemon(true);
                    sessionsSweeper.start();
                }
            }
            // Sends the response packet
            return response;
        } catch (XMPPErrorException e) {
            // If there is an exception caused by the next, complete,
            // prev or cancel method, then that error is returned to the
            // requester.
            XMPPError error = e.getXMPPError();
            // command be removed from the executing list.
            if (XMPPError.Type.CANCEL.equals(error.getType())) {
                response.setStatus(Status.canceled);
                executingCommands.remove(sessionId);
            }
            return respondError(response, XMPPError.getBuilder(error));
        }
    } else {
        LocalCommand command = executingCommands.get(sessionId);
        // of getting the key and the value of the map.
        if (command == null) {
            return respondError(response, XMPPError.Condition.bad_request, AdHocCommand.SpecificErrorCondition.badSessionid);
        }
        // Check if the Session data has expired (default is 10 minutes)
        long creationStamp = command.getCreationDate();
        if (System.currentTimeMillis() - creationStamp > SESSION_TIMEOUT * 1000) {
            // Remove the expired session
            executingCommands.remove(sessionId);
            // Answer a not_allowed error (session-expired)
            return respondError(response, XMPPError.Condition.not_allowed, AdHocCommand.SpecificErrorCondition.sessionExpired);
        }
        /*
             * Since the requester could send two requests for the same
             * executing command i.e. the same session id, all the execution of
             * the action must be synchronized to avoid inconsistencies.
             */
        synchronized (command) {
            Action action = requestData.getAction();
            // If the action is unknown the respond an error
            if (action != null && action.equals(Action.unknown)) {
                return respondError(response, XMPPError.Condition.bad_request, AdHocCommand.SpecificErrorCondition.malformedAction);
            }
            // action then follow the actual default execute action
            if (action == null || Action.execute.equals(action)) {
                action = command.getExecuteAction();
            }
            // offered
            if (!command.isValidAction(action)) {
                return respondError(response, XMPPError.Condition.bad_request, AdHocCommand.SpecificErrorCondition.badAction);
            }
            try {
                // TODO: Check that all the required fields of the form are
                // TODO: filled, if not throw an exception. This will simplify the
                // TODO: construction of new commands
                // Since all errors were passed, the response is now a
                // result
                response.setType(IQ.Type.result);
                // Set the new data to the command.
                command.setData(response);
                if (Action.next.equals(action)) {
                    command.incrementStage();
                    command.next(new Form(requestData.getForm()));
                    if (command.isLastStage()) {
                        // If it is the last stage then the command is
                        // completed
                        response.setStatus(Status.completed);
                    } else {
                        // Otherwise it is still executing
                        response.setStatus(Status.executing);
                    }
                } else if (Action.complete.equals(action)) {
                    command.incrementStage();
                    command.complete(new Form(requestData.getForm()));
                    response.setStatus(Status.completed);
                    // Remove the completed session
                    executingCommands.remove(sessionId);
                } else if (Action.prev.equals(action)) {
                    command.decrementStage();
                    command.prev();
                } else if (Action.cancel.equals(action)) {
                    command.cancel();
                    response.setStatus(Status.canceled);
                    // Remove the canceled session
                    executingCommands.remove(sessionId);
                }
                return response;
            } catch (XMPPErrorException e) {
                // If there is an exception caused by the next, complete,
                // prev or cancel method, then that error is returned to the
                // requester.
                XMPPError error = e.getXMPPError();
                // command be removed from the executing list.
                if (XMPPError.Type.CANCEL.equals(error.getType())) {
                    response.setStatus(Status.canceled);
                    executingCommands.remove(sessionId);
                }
                return respondError(response, XMPPError.getBuilder(error));
            }
        }
    }
}
Also used : Action(org.jivesoftware.smackx.commands.AdHocCommand.Action) XMPPErrorException(org.jivesoftware.smack.XMPPException.XMPPErrorException) Form(org.jivesoftware.smackx.xdata.Form) AdHocCommandData(org.jivesoftware.smackx.commands.packet.AdHocCommandData) XMPPError(org.jivesoftware.smack.packet.XMPPError)

Example 7 with XMPPError

use of org.jivesoftware.smack.packet.XMPPError in project Smack by igniterealtime.

the class IBBPacketUtils method createErrorIQ.

/**
     * Returns an error IQ.
     * 
     * @param from the senders JID
     * @param to the recipients JID
     * @param condition the XMPP error condition
     * @return an error IQ
     */
public static IQ createErrorIQ(Jid from, Jid to, XMPPError.Condition condition) {
    XMPPError.Builder xmppError = XMPPError.getBuilder(condition);
    IQ errorIQ = new ErrorIQ(xmppError);
    errorIQ.setType(IQ.Type.error);
    errorIQ.setFrom(from);
    errorIQ.setTo(to);
    return errorIQ;
}
Also used : ErrorIQ(org.jivesoftware.smack.packet.ErrorIQ) ErrorIQ(org.jivesoftware.smack.packet.ErrorIQ) EmptyResultIQ(org.jivesoftware.smack.packet.EmptyResultIQ) IQ(org.jivesoftware.smack.packet.IQ) XMPPError(org.jivesoftware.smack.packet.XMPPError)

Example 8 with XMPPError

use of org.jivesoftware.smack.packet.XMPPError in project Smack by igniterealtime.

the class XMPPErrorTest method testUserDefinedErrorWithCommentCreation.

/**
     * Check the creation of a new xmppError locally where there is not a default defined.
    */
public void testUserDefinedErrorWithCommentCreation() {
    String message = "Error Message";
    XMPPError error = new XMPPError(new XMPPError.Condition("my_own_error"), message);
    error.toXML();
    assertEquals(error.getCondition(), "my_own_error");
    assertEquals(error.getCode(), 0);
    assertNull(error.getType());
    assertEquals(error.getMessage(), message);
}
Also used : XMPPError(org.jivesoftware.smack.packet.XMPPError)

Example 9 with XMPPError

use of org.jivesoftware.smack.packet.XMPPError in project Smack by igniterealtime.

the class XMPPErrorTest method test404.

/**
     * Check the parser with an xml with the 404 error.
    */
public void test404() {
    // Make the XML to test
    String xml = "<error code='404' type='cancel'>" + "<item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>" + "</error></iq>";
    try {
        // Create the xml parser
        XmlPullParser parser = getParserFromXML(xml);
        // Create a packet from the xml
        XMPPError packet = parseError(parser);
        assertNotNull(packet);
    } catch (Exception e) {
        e.printStackTrace();
        fail(e.getMessage());
    }
}
Also used : XmlPullParser(org.xmlpull.v1.XmlPullParser) XMPPError(org.jivesoftware.smack.packet.XMPPError) XmlPullParserException(org.xmlpull.v1.XmlPullParserException)

Example 10 with XMPPError

use of org.jivesoftware.smack.packet.XMPPError in project Smack by igniterealtime.

the class XMPPErrorTest method testMessageAndApplicationDefinedError.

public void testMessageAndApplicationDefinedError() {
    String xml = "<error type='modify' code='404'>" + "<undefined-condition xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>" + "<text xml:lang='en' xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'>" + "Some special application diagnostic information..." + "</text>" + "<special-application-condition xmlns='application-ns'/>" + "</error>";
    try {
        // Create the xml parser
        XmlPullParser parser = getParserFromXML(xml);
        // Create a packet from the xml
        XMPPError error = parseError(parser);
        String sendingXML = error.toXML();
        assertNotNull(error);
        assertNotNull(sendingXML);
    } catch (Exception e) {
        e.printStackTrace();
        fail(e.getMessage());
    }
}
Also used : XmlPullParser(org.xmlpull.v1.XmlPullParser) XMPPError(org.jivesoftware.smack.packet.XMPPError) XmlPullParserException(org.xmlpull.v1.XmlPullParserException)

Aggregations

XMPPError (org.jivesoftware.smack.packet.XMPPError)15 XmlPullParser (org.xmlpull.v1.XmlPullParser)5 XmlPullParserException (org.xmlpull.v1.XmlPullParserException)5 XMPPException (org.jivesoftware.smack.XMPPException)2 XMPPErrorException (org.jivesoftware.smack.XMPPException.XMPPErrorException)2 IQ (org.jivesoftware.smack.packet.IQ)2 NetworkException (com.xabber.android.data.NetworkException)1 ConnectionThread (com.xabber.android.data.connection.ConnectionThread)1 SmackException (org.jivesoftware.smack.SmackException)1 XMPPConnection (org.jivesoftware.smack.XMPPConnection)1 EmptyResultIQ (org.jivesoftware.smack.packet.EmptyResultIQ)1 ErrorIQ (org.jivesoftware.smack.packet.ErrorIQ)1 Form (org.jivesoftware.smackx.Form)1 Action (org.jivesoftware.smackx.commands.AdHocCommand.Action)1 AdHocCommandData (org.jivesoftware.smackx.commands.packet.AdHocCommandData)1 MultiUserChat (org.jivesoftware.smackx.muc.MultiUserChat)1 Form (org.jivesoftware.smackx.xdata.Form)1