Skip to main content

JOD Agent References

The John Object Daemon is software that expose a JOSP Object to the JOSP EcoSystem. It can be installed on computers, embedded devices, servers, etc...

NB!: normally it's distributed within a JOD Distribution designed by Makers.

info

The JOD Agent read object's structure from configs/struct.jod file and expose that structure to the JOSP EcoSystem and then to JOSP Services as a JOSP Object. Only JOSP Services with the right permission can access to the exposed JOSP Object. Depending on their permissions, they can:

  • if permission=STATE: read object's structure and contained Pillar's states
  • if permission=ACTION: require Pillar's actions executions
  • if permission=OWNER: edit object's name, owner or permissions
  • if permission=NONE: list object but can't get object's info or structure

In the JOSP EcoSystem each JOSP Object is identified by his ID. The Object's ID, if not yet set, is generated automatically at JOD Agent startup. This, normally happens on object's first startup. The only other circumstance when the object's ID changes, is when the object's change his owner. That happen on object's owner registration or when current owner 'sell' the object to another user.

At startup, the JOD Agent loads the object's structure and initialize all required object's Pillars and relative Workers. Then checks if configured JCP is reachable, if it's available, the object opens a connection with returned JCP Gateways.
Finally, it startup a local server for direct communication

It's possible to customize the exposed object changing the JOD Agent behaviour with his main configs file configs/jod.yml or editing the configs/struct.jod file to alter his structure. Here a list of all JOD Agent's files.

JOD Agent was developed to run on many different type of devices (computers, embedded, server...) and keep running 24/7.
Because of that, normally it's executed as a background process, but occasionally it can be executed also as a foreground command and managed by the JOD Shell. Mostly for configurations test purposes.

Here a simple guide on JOD Agent's usage and troubleshooting.

Versions​

Collaborate​

Any kind of collaboration is welcome! This is an Open Source project, so we are happy to share our experience with other developers, makers and users. Bug reporting, extension development, documentation and guides etc... are activities where anybody can help to improve this project.

Please email to tech@johnosproject.com.

Licences​

The John Object Daemon is an open-source project part of the John Os Project and is distributed with a GPLv3 license.