Refactor dbus client mode to improve maintainability

[signal-cli] / src / main / java / org / asamk / Signal.java

diff --git a/src/main/java/org/asamk/Signal.java b/src/main/java/org/asamk/Signal.java
index f8b353c7bcac24d4f774c2a769e19d260909132b..cc521f6d1eefbf763589ca6ac354edef18dde04b 100644 (file)
--- a/src/main/java/org/asamk/Signal.java
+++ b/src/main/java/org/asamk/Signal.java
@@ -1,53 +1,159 @@
 package org.asamk;
 
 package org.asamk;
 

-import org.asamk.signal.AttachmentInvalidException;
-import org.asamk.signal.GroupNotFoundException;
-import org.freedesktop.dbus.DBusInterface;
-import org.freedesktop.dbus.DBusSignal;

 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.exceptions.DBusException;

-import org.whispersystems.signalservice.api.push.exceptions.EncapsulatedExceptions;
-import org.whispersystems.signalservice.api.util.InvalidNumberException;
+import org.freedesktop.dbus.exceptions.DBusExecutionException;
+import org.freedesktop.dbus.interfaces.DBusInterface;
+import org.freedesktop.dbus.messages.DBusSignal;

 
 

-import java.io.IOException;

 import java.util.List;
 
 import java.util.List;
 

+/**
+ * DBus interface for the org.asamk.Signal service.
+ * Including emitted Signals and returned Errors.
+ */

 public interface Signal extends DBusInterface {
 
 public interface Signal extends DBusInterface {
 

-    void sendMessage(String message, List<String> attachments, String recipient) throws EncapsulatedExceptions, AttachmentInvalidException, IOException, InvalidNumberException;
+    String getSelfNumber();

 
 

-    void sendMessage(String message, List<String> attachments, List<String> recipients) throws EncapsulatedExceptions, AttachmentInvalidException, IOException, InvalidNumberException;
+    long sendMessage(
+            String message, List<String> attachments, String recipient
+    ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;

 
 

-    void sendEndSessionMessage(List<String> recipients) throws IOException, EncapsulatedExceptions, InvalidNumberException;
+    long sendMessage(
+            String message, List<String> attachments, List<String> recipients
+    ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;

 
 

-    void sendGroupMessage(String message, List<String> attachments, byte[] groupId) throws EncapsulatedExceptions, GroupNotFoundException, AttachmentInvalidException, IOException;
+    void sendTyping(
+            String recipient, boolean stop
+    ) throws Error.Failure, Error.GroupNotFound, Error.UntrustedIdentity;

 
 

-    String getContactName(String number) throws InvalidNumberException;
+    void sendReadReceipt(
+            String recipient, List<Long> messageIds
+    ) throws Error.Failure, Error.UntrustedIdentity;

 
 

-    void setContactName(String number, String name) throws InvalidNumberException;
+    long sendRemoteDeleteMessage(
+            long targetSentTimestamp, String recipient
+    ) throws Error.Failure, Error.InvalidNumber;

 
 

-    void setContactBlocked(String number, boolean blocked) throws InvalidNumberException;
+    long sendRemoteDeleteMessage(
+            long targetSentTimestamp, List<String> recipients
+    ) throws Error.Failure, Error.InvalidNumber;

 
 

-    void setGroupBlocked(byte[] groupId, boolean blocked) throws GroupNotFoundException;
+    long sendGroupRemoteDeleteMessage(
+            long targetSentTimestamp, byte[] groupId
+    ) throws Error.Failure, Error.GroupNotFound, Error.InvalidGroupId;
+
+    long sendMessageReaction(
+            String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, String recipient
+    ) throws Error.InvalidNumber, Error.Failure;
+
+    long sendMessageReaction(
+            String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, List<String> recipients
+    ) throws Error.InvalidNumber, Error.Failure;
+
+    void sendContacts() throws Error.Failure;
+
+    void sendSyncRequest() throws Error.Failure;
+
+    long sendNoteToSelfMessage(
+            String message, List<String> attachments
+    ) throws Error.AttachmentInvalid, Error.Failure;
+
+    void sendEndSessionMessage(List<String> recipients) throws Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;
+
+    long sendGroupMessage(
+            String message, List<String> attachments, byte[] groupId
+    ) throws Error.GroupNotFound, Error.Failure, Error.AttachmentInvalid, Error.InvalidGroupId;
+
+    long sendGroupMessageReaction(
+            String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, byte[] groupId
+    ) throws Error.GroupNotFound, Error.Failure, Error.InvalidNumber, Error.InvalidGroupId;
+
+    String getContactName(String number) throws Error.InvalidNumber;
+
+    void setContactName(String number, String name) throws Error.InvalidNumber;
+
+    void setExpirationTimer(final String number, final int expiration) throws Error.Failure;
+
+    void setContactBlocked(String number, boolean blocked) throws Error.InvalidNumber;
+
+    void setGroupBlocked(byte[] groupId, boolean blocked) throws Error.GroupNotFound, Error.InvalidGroupId;

 
     List<byte[]> getGroupIds();
 
 
     List<byte[]> getGroupIds();
 

-    String getGroupName(byte[] groupId);
+    String getGroupName(byte[] groupId) throws Error.InvalidGroupId;

 
 

-    List<String> getGroupMembers(byte[] groupId);
+    List<String> getGroupMembers(byte[] groupId) throws Error.InvalidGroupId;

 
 

-    byte[] updateGroup(byte[] groupId, String name, List<String> members, String avatar) throws IOException, EncapsulatedExceptions, GroupNotFoundException, AttachmentInvalidException, InvalidNumberException;
+    byte[] updateGroup(
+            byte[] groupId, String name, List<String> members, String avatar
+    ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.GroupNotFound, Error.InvalidGroupId;

 
 

-    boolean isRegistered();
+    boolean isRegistered() throws Error.Failure, Error.InvalidNumber;

 
 

-    class MessageReceived extends DBusSignal {
+    boolean isRegistered(String number) throws Error.Failure, Error.InvalidNumber;
+
+    List<Boolean> isRegistered(List<String> numbers) throws Error.Failure, Error.InvalidNumber;
+
+    void addDevice(String uri) throws Error.InvalidUri;
+
+    void removeDevice(int deviceId) throws Error.Failure;
+
+    List<String> listDevices() throws Error.Failure;
+
+    void updateDeviceName(String deviceName) throws Error.Failure;
+
+    void updateProfile(
+            String givenName,
+            String familyName,
+            String about,
+            String aboutEmoji,
+            String avatarPath,
+            boolean removeAvatar
+    ) throws Error.Failure;
+
+    void updateProfile(
+            String name, String about, String aboutEmoji, String avatarPath, boolean removeAvatar
+    ) throws Error.Failure;
+
+    void removePin();
+
+    void setPin(String registrationLockPin);
+
+    String version();
+
+    List<String> listNumbers();
+
+    List<String> getContactNumber(final String name) throws Error.Failure;
+
+    void quitGroup(final byte[] groupId) throws Error.GroupNotFound, Error.Failure, Error.InvalidGroupId;
+
+    boolean isContactBlocked(final String number) throws Error.InvalidNumber;
+
+    boolean isGroupBlocked(final byte[] groupId) throws Error.InvalidGroupId;

 
 

-        private long timestamp;
-        private String sender;
-        private byte[] groupId;
-        private String message;
-        private List<String> attachments;
+    boolean isMember(final byte[] groupId) throws Error.InvalidGroupId;

 
 

-        public MessageReceived(String objectpath, long timestamp, String sender, byte[] groupId, String message, List<String> attachments) throws DBusException {
+    byte[] joinGroup(final String groupLink) throws Error.Failure;
+
+    String uploadStickerPack(String stickerPackPath) throws Error.Failure;
+
+    class MessageReceived extends DBusSignal {
+
+        private final long timestamp;
+        private final String sender;
+        private final byte[] groupId;
+        private final String message;
+        private final List<String> attachments;
+
+        public MessageReceived(
+                String objectpath,
+                long timestamp,
+                String sender,
+                byte[] groupId,
+                String message,
+                List<String> attachments
+        ) throws DBusException {

             super(objectpath, timestamp, sender, groupId, message, attachments);
             this.timestamp = timestamp;
             this.sender = sender;
             super(objectpath, timestamp, sender, groupId, message, attachments);
             this.timestamp = timestamp;
             this.sender = sender;


@@ -79,8 +185,8 @@ public interface Signal extends DBusInterface {
 
     class ReceiptReceived extends DBusSignal {
 
 
     class ReceiptReceived extends DBusSignal {
 

-        private long timestamp;
-        private String sender;
+        private final long timestamp;
+        private final String sender;

 
         public ReceiptReceived(String objectpath, long timestamp, String sender) throws DBusException {
             super(objectpath, timestamp, sender);
 
         public ReceiptReceived(String objectpath, long timestamp, String sender) throws DBusException {
             super(objectpath, timestamp, sender);


@@ -98,14 +204,23 @@ public interface Signal extends DBusInterface {
     }
 
     class SyncMessageReceived extends DBusSignal {
     }
 
     class SyncMessageReceived extends DBusSignal {

-        private long timestamp;
-        private String source;
-        private String destination;
-        private byte[] groupId;
-        private String message;
-        private List<String> attachments;
-
-        public SyncMessageReceived(String objectpath, long timestamp, String source, String destination, byte[] groupId, String message, List<String> attachments) throws DBusException {
+
+        private final long timestamp;
+        private final String source;
+        private final String destination;
+        private final byte[] groupId;
+        private final String message;
+        private final List<String> attachments;
+
+        public SyncMessageReceived(
+                String objectpath,
+                long timestamp,
+                String source,
+                String destination,
+                byte[] groupId,
+                String message,
+                List<String> attachments
+        ) throws DBusException {

             super(objectpath, timestamp, source, destination, groupId, message, attachments);
             this.timestamp = timestamp;
             this.source = source;
             super(objectpath, timestamp, source, destination, groupId, message, attachments);
             this.timestamp = timestamp;
             this.source = source;


@@ -139,4 +254,56 @@ public interface Signal extends DBusInterface {
             return attachments;
         }
     }
             return attachments;
         }
     }

+
+    interface Error {
+
+        class AttachmentInvalid extends DBusExecutionException {
+
+            public AttachmentInvalid(final String message) {
+                super(message);
+            }
+        }
+
+        class InvalidUri extends DBusExecutionException {
+
+            public InvalidUri(final String message) {
+                super(message);
+            }
+        }
+
+        class Failure extends DBusExecutionException {
+
+            public Failure(final String message) {
+                super(message);
+            }
+        }
+
+        class GroupNotFound extends DBusExecutionException {
+
+            public GroupNotFound(final String message) {
+                super(message);
+            }
+        }
+
+        class InvalidGroupId extends DBusExecutionException {
+
+            public InvalidGroupId(final String message) {
+                super(message);
+            }
+        }
+
+        class InvalidNumber extends DBusExecutionException {
+
+            public InvalidNumber(final String message) {
+                super(message);
+            }
+        }
+
+        class UntrustedIdentity extends DBusExecutionException {
+
+            public UntrustedIdentity(final String message) {
+                super(message);
+            }
+        }
+    }

 }
 }