Moved classic version to an own branch
This commit is contained in:
114
README.MD
114
README.MD
@@ -1,48 +1,35 @@
|
||||
# Open Autonomous Connection Protocol
|
||||
|
||||
> [!IMPORTANT]
|
||||
> This is the classic version!
|
||||
> Classic version is not longer maintained or supported please switch the Branch to master
|
||||
> The new Protocol has a Backwards compatibility and is supporting the classic Version
|
||||
|
||||
This is the Protocol for our Open Autonomous Connection project.<br />
|
||||
You can easily implement this Protocol via Maven.<br />
|
||||
Feel free to join our Discord.
|
||||
<br />
|
||||
<br />
|
||||
|
||||
## License Notice
|
||||
|
||||
This project (OAC) is licensed under
|
||||
the [Open Autonomous Public License (OAPL)](https://open-autonomous-connection.org/license.html).
|
||||
|
||||
**Third-party components:**
|
||||
|
||||
- *UnlegitLibrary* is authored by the same copyright holder and is used here under a special agreement:
|
||||
While [UnlegitLibrary](https://repo.unlegitdqrk.dev/UnlegitDqrk/unlegitlibrary/) is generally distributed under
|
||||
the [GNU GPLv3](https://repo.unlegitdqrk.dev/UnlegitDqrk/unlegitlibrary/src/branch/master/LICENSE),
|
||||
it is additionally licensed under OAPL **exclusively for the OAC project**.
|
||||
Therefore, within OAC, the OAPL terms apply to UnlegitLibrary as well.<br/>
|
||||
<br/>
|
||||
### Take a look into [Certificate Generation](https://repo.unlegitdqrk.dev/UnlegitDqrk/unlegitlibrary/src/branch/master#certificate-generation-for-networksystem).
|
||||
# Bugs/Problems
|
||||
- Project not tested yet
|
||||
# In progress
|
||||
- WebServer
|
||||
- Cleanup Code
|
||||
# TODO
|
||||
- Finishing WebServer
|
||||
- Writing INS Backend and Frontend
|
||||
- Writing WebClient
|
||||
- Writing WebServer
|
||||
- Documentation / Wiki
|
||||
- Subdomains
|
||||
- Fragments
|
||||
|
||||
# Maven
|
||||
|
||||
### pom.xml
|
||||
|
||||
```
|
||||
<dependency>
|
||||
<groupId>org.openautonomousconnection</groupId>
|
||||
<groupId>me.openautonomousconnection</groupId>
|
||||
<artifactId>protocol</artifactId>
|
||||
<version>VERSION</version>
|
||||
<version>1.0.0-Classic</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
### Repository:
|
||||
|
||||
```
|
||||
<repository>
|
||||
<id>oac</id>
|
||||
@@ -51,4 +38,79 @@ the [Open Autonomous Public License (OAPL)](https://open-autonomous-connection.o
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
```
|
||||
|
||||
# Examples
|
||||
#### Note: These examples are very basic
|
||||
### Server
|
||||
|
||||
```java
|
||||
import me.finn.unlegitlibrary.network.system.server.ConnectionHandler;
|
||||
import org.openautonomousconnection.protocol.ProtocolBridge;
|
||||
import org.openautonomousconnection.protocol.ProtocolSettings;
|
||||
import org.openautonomousconnection.protocol.ProtocolVersion;
|
||||
import side.org.openautonomousconnection.protocol.ProtocolServer;
|
||||
|
||||
public class Server extends ProtocolServer {
|
||||
|
||||
public Server() throws IOException, InterruptedException {
|
||||
super(10);
|
||||
}
|
||||
|
||||
public static void main(String[] args) {
|
||||
try {
|
||||
ProtocolBridge protocolBridge = new ProtocolBridge(ProtocolVersion.PV_1_0_0, new ProtocolSettings(), new Server());
|
||||
protocolBridge.getProtocolServer().setProtocolBridge(protocolBridge);
|
||||
protocolBridge.getProtocolServer().startServer();
|
||||
} catch (IOException | InterruptedException | InvocationTargetException | InstantiationException |
|
||||
IllegalAccessException | NoSuchMethodException exception) {
|
||||
exception.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<Domain> getDomains() throws SQLException {
|
||||
return List.of(); // Your method here to get all registered domains
|
||||
}
|
||||
|
||||
@Override
|
||||
public void handleMessage(ConnectionHandler connectionHandler, String message) {
|
||||
System.out.println("Received message: " + message + " from client: " + connectionHandler.getClientID());
|
||||
}
|
||||
}
|
||||
```
|
||||
### Client
|
||||
|
||||
```java
|
||||
import org.openautonomousconnection.protocol.ProtocolBridge;
|
||||
import org.openautonomousconnection.protocol.ProtocolSettings;
|
||||
import org.openautonomousconnection.protocol.ProtocolVersion;
|
||||
import domain.org.openautonomousconnection.protocol.Domain;
|
||||
import side.org.openautonomousconnection.protocol.ProtocolClient;
|
||||
import utils.org.openautonomousconnection.protocol.SiteType;
|
||||
|
||||
public class Client extends ProtocolClient {
|
||||
|
||||
public static void main(String[] args) {
|
||||
try {
|
||||
ProtocolBridge protocolBridge = new ProtocolBridge(ProtocolVersion.PV_1_0_0, new ProtocolSettings(), new Client());
|
||||
protocolBridge.getProtocolClient().setProtocolBridge(protocolBridge);
|
||||
protocolBridge.getProtocolServer().startClient();
|
||||
} catch (IOException | InterruptedException | InvocationTargetException | InstantiationException |
|
||||
IllegalAccessException | NoSuchMethodException exception) {
|
||||
exception.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void handleHTMLContent(SiteType siteType, Domain domain, String htmlContent) {
|
||||
System.out.println("Website html content received. This site is " + siteType.name);
|
||||
System.out.println(htmlContent); // Render content in a webview for example
|
||||
}
|
||||
|
||||
@Override
|
||||
public void handleMessage(String message) {
|
||||
System.out.println("Received message: " + message);
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user