vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-18 17:01:08 +01:00
Code Issues Releases Wiki Activity

Re-work data form API

Browse source 
Apply builder pattern to form fields and replace getVariable() with
getFieldName(). Refer to the field name as "field name" instead of
"variable" everyone, just as XEP-0004 does.

Improve the high-level form API: introduce FilledForm and FillableForm
which perform stronger validation and consistency checks.

Also add FormFieldRegistry to enable processing of 'submit' forms
where the form field types are omitted.

Smack also now does omit the form field type declaration on 'submit'
type forms, as it is allowed by XEP-0004.
This commit is contained in:
Florian Schmaus 2020-05-13 20:14:41 +02:00
parent 3270c113c5
commit 77e26fc575
97 changed files with 3809 additions and 2427 deletions
Download patch file Download diff file Expand all files Collapse all files

18
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java
View file

@ -42,6 +42,7 @@ import org.jivesoftware.smackx.filetransfer.FileTransferException.NoAcceptableTr
import org.jivesoftware.smackx.filetransfer.FileTransferException.NoStreamMethodsOfferedException;
import org.jivesoftware.smackx.si.packet.StreamInitiation;
import org.jivesoftware.smackx.xdata.FormField;
import org.jivesoftware.smackx.xdata.ListSingleFormField;
import org.jivesoftware.smackx.xdata.packet.DataForm;
import org.jxmpp.jid.Jid;
@ -189,7 +190,7 @@ public final class FileTransferNegotiator extends Manager {
public StreamNegotiator selectStreamNegotiator(
FileTransferRequest request) throws NotConnectedException, NoStreamMethodsOfferedException, NoAcceptableTransferMechanisms, InterruptedException {
StreamInitiation si = request.getStreamInitiation();
FormField streamMethodField = getStreamMethodField(si
ListSingleFormField streamMethodField = getStreamMethodField(si
.getFeatureNegotiationForm());
if (streamMethodField == null) {
@ -216,11 +217,11 @@ public final class FileTransferNegotiator extends Manager {
return selectedStreamNegotiator;
}
private static FormField getStreamMethodField(DataForm form) {
return form.getField(STREAM_DATA_FIELD_NAME);
private static ListSingleFormField getStreamMethodField(DataForm form) {
return (ListSingleFormField) form.getField(STREAM_DATA_FIELD_NAME);
}
private StreamNegotiator getNegotiator(final FormField field)
private StreamNegotiator getNegotiator(final ListSingleFormField field)
throws NoAcceptableTransferMechanisms {
String variable;
boolean isByteStream = false;
@ -359,16 +360,15 @@ public final class FileTransferNegotiator extends Manager {
}
private static DataForm createDefaultInitiationForm() {
DataForm form = new DataForm(DataForm.Type.form);
FormField.Builder fieldBuilder = FormField.builder();
fieldBuilder.setFieldName(STREAM_DATA_FIELD_NAME)
.setType(FormField.Type.list_single);
DataForm.Builder form = DataForm.builder()
.setType(DataForm.Type.form);
ListSingleFormField.Builder fieldBuilder = FormField.listSingleBuilder(STREAM_DATA_FIELD_NAME);
if (!IBB_ONLY) {
fieldBuilder.addOption(Bytestream.NAMESPACE);
}
fieldBuilder.addOption(DataPacketExtension.NAMESPACE);
form.addField(fieldBuilder.build());
return form;
return form.build();
}
}

9
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java
View file

@ -33,6 +33,7 @@ import org.jivesoftware.smack.util.EventManger.Callback;
import org.jivesoftware.smackx.si.packet.StreamInitiation;
import org.jivesoftware.smackx.xdata.FormField;
import org.jivesoftware.smackx.xdata.ListSingleFormField;
import org.jivesoftware.smackx.xdata.packet.DataForm;
import org.jxmpp.jid.Jid;
@ -80,13 +81,13 @@ public abstract class StreamNegotiator extends Manager {
response.setType(IQ.Type.result);
response.setStanzaId(streamInitiationOffer.getStanzaId());
DataForm form = new DataForm(DataForm.Type.submit);
FormField.Builder field = FormField.builder(
DataForm.Builder form = DataForm.builder();
ListSingleFormField.Builder field = FormField.listSingleBuilder(
FileTransferNegotiator.STREAM_DATA_FIELD_NAME);
field.addValue(namespace);
field.setValue(namespace);
form.addField(field.build());
response.setFeatureNegotiationForm(form);
response.setFeatureNegotiationForm(form.build());
return response;
}