vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-09-09 00:59:39 +02: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

5
smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java
View file

@ -75,7 +75,8 @@ import org.jivesoftware.smackx.workgroup.packet.Transcript;
import org.jivesoftware.smackx.workgroup.packet.Transcripts;
import org.jivesoftware.smackx.workgroup.settings.GenericSettings;
import org.jivesoftware.smackx.workgroup.settings.SearchSettings;
import org.jivesoftware.smackx.xdata.Form;
import org.jivesoftware.smackx.xdata.form.FillableForm;
import org.jivesoftware.smackx.xdata.form.Form;
import org.jxmpp.jid.EntityBareJid;
import org.jxmpp.jid.EntityJid;
@ -573,7 +574,7 @@ public class AgentSession {
* @throws XMPPException if an XMPP protocol error was received.
* @throws InterruptedException if the calling thread was interrupted.
*/
public ReportedData searchTranscripts(Form completedForm) throws XMPPException, SmackException, InterruptedException {
public ReportedData searchTranscripts(FillableForm completedForm) throws XMPPException, SmackException, InterruptedException {
return transcriptSearchManager.submitSearch(workgroupJID.asDomainBareJid(),
completedForm);
}

11
smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/TranscriptSearchManager.java
View file

@ -25,14 +25,15 @@ import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smackx.search.ReportedData;
import org.jivesoftware.smackx.workgroup.packet.TranscriptSearch;
import org.jivesoftware.smackx.xdata.Form;
import org.jivesoftware.smackx.xdata.form.FillableForm;
import org.jivesoftware.smackx.xdata.form.Form;
import org.jxmpp.jid.DomainBareJid;
/**
* A TranscriptSearchManager helps to retrieve the form to use for searching transcripts
* {@link #getSearchForm(DomainBareJid)} or to submit a search form and return the results of
* the search {@link #submitSearch(DomainBareJid, Form)}.
* the search {@link #submitSearch(DomainBareJid, FillableForm)}.
*
* @author Gaston Dombiak
*/
@ -62,7 +63,7 @@ public class TranscriptSearchManager {
TranscriptSearch response = connection.createStanzaCollectorAndSend(
search).nextResultOrThrow();
return Form.getFormFrom(response);
return Form.from(response);
}
/**
@ -78,11 +79,11 @@ public class TranscriptSearchManager {
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public ReportedData submitSearch(DomainBareJid serviceJID, Form completedForm) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
public ReportedData submitSearch(DomainBareJid serviceJID, FillableForm completedForm) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
TranscriptSearch search = new TranscriptSearch();
search.setType(IQ.Type.get);
search.setTo(serviceJID);
search.addExtension(completedForm.getDataFormToSend());
search.addExtension(completedForm.getDataFormToSubmit());
TranscriptSearch response = connection.createStanzaCollectorAndSend(
search).nextResultOrThrow();

31
smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java
View file

@ -56,8 +56,10 @@ import org.jivesoftware.smackx.workgroup.settings.ChatSettings;
import org.jivesoftware.smackx.workgroup.settings.OfflineSettings;
import org.jivesoftware.smackx.workgroup.settings.SoundSettings;
import org.jivesoftware.smackx.workgroup.settings.WorkgroupProperties;
import org.jivesoftware.smackx.xdata.Form;
import org.jivesoftware.smackx.xdata.FormField;
import org.jivesoftware.smackx.xdata.TextSingleFormField;
import org.jivesoftware.smackx.xdata.form.FillableForm;
import org.jivesoftware.smackx.xdata.form.Form;
import org.jivesoftware.smackx.xdata.packet.DataForm;
import org.jxmpp.jid.DomainBareJid;
@ -247,7 +249,7 @@ public class Workgroup {
* this method will throw an IllegalStateException if the user is already in the queue.<p>
*
* Some servers may be configured to require certain meta-data in order to
* join the queue. In that case, the {@link #joinQueue(Form)} method should be
* join the queue. In that case, the {@link #joinQueue(FillableForm)} method should be
* used instead of this method so that meta-data may be passed in.<p>
*
* The server tracks the conversations that a user has with agents over time. By
@ -255,7 +257,7 @@ public class Workgroup {
* possible. For example, when the user is logged in anonymously using a web client.
* In that case the user ID might be a randomly generated value put into a persistent
* cookie or a username obtained via the session. A userID can be explicitly
* passed in by using the {@link #joinQueue(Form, Jid)} method. When specified,
* passed in by using the {@link #joinQueue(DataForm, Jid)} method. When specified,
* that userID will be used instead of the user's JID to track conversations. The
* server will ignore a manually specified userID if the user's connection to the server
* is not anonymous.
@ -293,7 +295,7 @@ public class Workgroup {
* possible. For example, when the user is logged in anonymously using a web client.
* In that case the user ID might be a randomly generated value put into a persistent
* cookie or a username obtained via the session. A userID can be explicitly
* passed in by using the {@link #joinQueue(Form, Jid)} method. When specified,
* passed in by using the {@link #joinQueue(DataForm, Jid)} method. When specified,
* that userID will be used instead of the user's JID to track conversations. The
* server will ignore a manually specified userID if the user's connection to the server
* is not anonymous.
@ -305,8 +307,8 @@ public class Workgroup {
* @throws SmackException if Smack detected an exceptional situation.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void joinQueue(Form answerForm) throws XMPPException, SmackException, InterruptedException {
joinQueue(answerForm, null);
public void joinQueue(FillableForm answerForm) throws XMPPException, SmackException, InterruptedException {
joinQueue(answerForm.getDataFormToSubmit(), null);
}
/**
@ -345,7 +347,7 @@ public class Workgroup {
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void joinQueue(Form answerForm, Jid userID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
public void joinQueue(DataForm answerForm, Jid userID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// If already in the queue ignore the join request.
if (inQueue) {
throw new IllegalStateException("Already in queue " + workgroupJID);
@ -400,18 +402,17 @@ public class Workgroup {
}
// Build dataform from metadata
Form form = new Form(DataForm.Type.submit);
DataForm.Builder form = DataForm.builder();
Iterator<String> iter = metadata.keySet().iterator();
while (iter.hasNext()) {
String name = iter.next();
String value = metadata.get(name).toString();
FormField.Builder field = FormField.builder(name);
field.setType(FormField.Type.text_single);
TextSingleFormField.Builder field = FormField.builder(name);
field.setValue(value);
form.addField(field.build());
form.setAnswer(name, value);
}
joinQueue(form, userID);
joinQueue(form.build(), userID);
}
/**
@ -569,14 +570,14 @@ public class Workgroup {
private final Jid userID;
private final DataForm form;
private JoinQueuePacket(EntityBareJid workgroup, Form answerForm, Jid userID) {
private JoinQueuePacket(EntityBareJid workgroup, DataForm answerForm, Jid userID) {
super("join-queue", "http://jabber.org/protocol/workgroup");
this.userID = userID;
setTo(workgroup);
setType(IQ.Type.set);
form = answerForm.getDataFormToSend();
form = answerForm;
addExtension(form);
}
@ -772,6 +773,6 @@ public class Workgroup {
WorkgroupForm response = connection.createStanzaCollectorAndSend(
workgroupForm).nextResultOrThrow();
return Form.getFormFrom(response);
return Form.from(response);
}
}