vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-09-10 17:49:38 +02:00
Code Issues Releases Wiki Activity

SMACK-425 Introduced smack.parsing.ParsingExceptionCallback, a callback invoked when a exception is thrown while parsing a stanza. Smack is now able to either rethrow the exception ulitmatly causing a disconnect *or* log/ignore the exception and resume parsing after the faulty stanza.

Browse source 
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/branches/smack_3_3_1@13688 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
Florian Schmaus 2013-06-22 17:01:40 +00:00 • committed by flow
parent 18a603d932
commit 30bc5afa2b
12 changed files with 524 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

51
source/org/jivesoftware/smack/parsing/LogException.java Normal file
View file

@ -0,0 +1,51 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright 2013 Florian Schmaus.
*
* All rights reserved. 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.parsing;
/**
* Simple parsing exception callback that only logs the encountered parsing exception to stderr.
*
* @author Florian Schmaus
*
*/
public class LogException extends ParsingExceptionCallback {
@Override
public void messageParsingException(Exception e, UnparsedMessage message) throws Exception {
System.err.print("Smack message parsing exception: " + e.getMessage());
e.printStackTrace();
System.err.println("Unparsed content: " + message.getContent());
}
@Override
public void iqParsingException(Exception e, UnparsedIQ iq) throws Exception {
System.err.print("Smack iq parsing exception: " + e.getMessage());
e.printStackTrace();
System.err.println("Unparsed content: " + iq.getContent());
}
@Override
public void presenceParsingException(Exception e, UnparsedPresence presence) throws Exception {
System.err.print("Smack presence parsing exception: " + e.getMessage());
e.printStackTrace();
System.err.println("Unparsed content: " + presence.getContent());
}
}

76
source/org/jivesoftware/smack/parsing/ParsingExceptionCallback.java Normal file
View file

@ -0,0 +1,76 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright 2013 Florian Schmaus.
*
* All rights reserved. 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.parsing;
/**
* Base class to receive parsing exceptions.
*
* If this class is used as callback, then Smack will silently ignore the stanza that caused the parsing exception and
* place the parser after the faulty stanza.
*
* Subclasses may or may not override certain methods of this class. Each of these methods will receive the exception
* that caused the parsing error and an instance of an Unparsed Packet type. The latter can be used to inspect the
* stanza that caused the parsing error by using the getContent() (for example {@link UnparsedIQ#getContent()})
* method.
*
* Smack provides 2 predefined ParsingExceptionCallback's: {@link LogException} and {@link ThrowException}.
*
* @author Florian Schmaus
*
*/
public abstract class ParsingExceptionCallback {
/**
* Called when parsing an message stanza caused an exception.
*
* @param e
* the exception thrown while parsing the message stanza
* @param message
* the raw message stanza data that caused the exception
* @throws Exception
*/
public void messageParsingException(Exception e, UnparsedMessage message) throws Exception {
}
/**
* Called when parsing an IQ stanza caused an exception.
*
* @param e
* the exception thrown while parsing the iq stanza
* @param iq
* the raw iq stanza data that caused the exception
* @throws Exception
*/
public void iqParsingException(Exception e, UnparsedIQ iq) throws Exception {
}
/**
* Called when parsing a presence stanza caused an exception.
*
* @param e
* the exception thrown while parsing the presence stanza
* @param presence
* the raw presence stanza data that caused the exception
* @throws Exception
*/
public void presenceParsingException(Exception e, UnparsedPresence presence) throws Exception {
}
}

48
source/org/jivesoftware/smack/parsing/ThrowException.java Normal file
View file

@ -0,0 +1,48 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright 2013 Florian Schmaus.
*
* All rights reserved. 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.parsing;
import org.jivesoftware.smack.ConnectionListener;
/**
* Parsing exception callback class that simply throws the encountered parsing exception. This usually leads to an
* {@link ConnectionListener#connectionClosedOnError(Exception)} disconnect of the connection.
*
* @author Florian Schmaus
*
*/
public class ThrowException extends ParsingExceptionCallback {
@Override
public void messageParsingException(Exception e, UnparsedMessage message) throws Exception {
throw e;
}
@Override
public void iqParsingException(Exception e, UnparsedIQ iq) throws Exception {
throw e;
}
@Override
public void presenceParsingException(Exception e, UnparsedPresence presence) throws Exception {
throw e;
}
}

62
source/org/jivesoftware/smack/parsing/UnparsedIQ.java Normal file
View file

@ -0,0 +1,62 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright 2013 Florian Schmaus.
*
* All rights reserved. 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.parsing;
import org.jivesoftware.smack.packet.IQ;
/**
* Representation of an unparsed IQ stanza.
*
* @author Florian Schmaus
*
*/
public class UnparsedIQ extends IQ {
private final String content;
private final Exception e;
public UnparsedIQ(final String content, final Exception e) {
this.content = content;
this.e = e;
}
/**
*
* @return the exception that caused the parser to fail
*/
public Exception getException() {
return e;
}
/**
* Retrieve the raw stanza data
*
* @return the raw stanza data
*/
public String getContent() {
return content;
}
@Override
public String getChildElementXML() {
return null;
}
}

57
source/org/jivesoftware/smack/parsing/UnparsedMessage.java Normal file
View file

@ -0,0 +1,57 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright 2013 Florian Schmaus.
*
* All rights reserved. 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.parsing;
import org.jivesoftware.smack.packet.Message;
/**
* Representation of an unparsed IQ stanza.
*
* @author Florian Schmaus
*
*/
public class UnparsedMessage extends Message {
private final String content;
private final Exception e;
public UnparsedMessage(final String content, final Exception e) {
this.content = content;
this.e = e;
}
/**
*
* @return the exception that caused the parser to fail
*/
public Exception getException() {
return e;
}
/**
* Retrieve the raw stanza data
*
* @return the raw stanza data
*/
public String getContent() {
return content;
}
}

61
source/org/jivesoftware/smack/parsing/UnparsedPresence.java Normal file
View file

@ -0,0 +1,61 @@
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright 2013 Florian Schmaus.
*
* All rights reserved. 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.parsing;
import org.jivesoftware.smack.packet.Presence;
/**
* Representation of an unparsed IQ stanza.
*
* @author Florian Schmaus
*
*/
public class UnparsedPresence extends Presence {
private String content;
private Exception e;
public UnparsedPresence(Type type) {
super(type);
}
public UnparsedPresence(final String content, final Exception e) {
super(Presence.Type.error);
this.content = content;
this.e = e;
}
/**
*
* @return the exception that caused the parser to fail
*/
public Exception getException() {
return e;
}
/**
* Retrieve the raw stanza data
*
* @return the raw stanza data
*/
public String getContent() {
return content;
}
}