Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating gateway doc for authentication support #165

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
+14 −5
Draft

Updating gateway doc for authentication support #165

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9806d88
doc(*): updating gateway doc for authentication support
notthetup Jan 22, 2021
b2ff218
Update Gateways.md
notthetup Jan 22, 2021
b7d2232
Update Gateways.md
notthetup Jan 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions gateways/Gateways.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,24 @@ All fjåge Gateway implementations should implement the following classes and me
- Must return a `null` if the connection to master container fails on the first attempt.
- May support auto-reconnect, where, once a connection with the master container is established if the connection fails, the Gateway tries to reconnect automatically.

### `getAgentID()` :: Void -> AgentID
### `authenticate` :: String credentials -> Boolean
- Tries to authenticate the Gateway connection with the master container.
- Must send the credential string using command `{"action":"auth","creds":"boo"}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a comment on what creds may contain?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would depend on the implementation of the Firewall that is being used.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but just a comment on this to state so?

- Must wait for a the first `{"auth": true}` or `{"auth": false}` received from the master and return the result.
- Must default timeout to 1000 millisecond.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is 1000 ms a MUST?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Will change to a suggestion.


### `getAgentID()` :: Void -> AgentID | Error
- Returns the _AgentID_ associated with the gateway.
- May be implemented as a property `agentID` on the _Gateway_.

### `close()` :: Void -> Void
- Closes the _Gateway_.
- Must send a `{"alive": false}` message to the master container before closing.

### `send()` :: Message -> Boolean
### `send()` :: Message -> Boolean
- Sends a _Message_ to the recipient indicated in the message.

### `receive()` :: (Object filter), (Int timeout) -> Message
### `receive()` :: (Object filter), (Int timeout) -> Message | Error
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

returning Error makes sense for some languages, other places it is throwing error. Do we need to define it as a return value?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #167, can't do this generally.

- Returns a _Message_ received by the agent.
- May accept optional filter and timeout arguments.
- May support filter of type `MessageClass class` to filter for a message of a specific class.
Expand All @@ -37,6 +43,7 @@ All fjåge Gateway implementations should implement the following classes and me

### `request()` :: Message, (Int timeout) -> Message
- Sends a request and waits for a response.
- May return an `Error` of type `AuthorizationError` if a `{"auth": false}` is seen while waiting for the response
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to go update all gateways to throw exceptions?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #167, can't do this generally.

- Must not **block** if timeout is 0.
- Must **block** indefinitely if timeout is -1.
- Must **block** for timeout milliseconds otherwise.
Expand All @@ -62,12 +69,14 @@ All fjåge Gateway implementations should implement the following classes and me
### `unsubscribe()` :: AgentID -> Boolean
- Unsubscribes the gateway from a given topic.

### `agentForService()` :: String -> AgentID
### `agentForService()` :: String -> AgentID | Error
- Finds an agent that provides a named service.
- Must default timeout to 1000 millisecond.

### `agentsForService()` :: String -> [AgentID]
### `agentsForService()` :: String -> [AgentID] | Error
- Find all agents that provides a named service.
- Returns an array/list.
- Must default timeout to 1000 millisecond.

### `flush()` :: Void -> Void
- Flushes the incoming queue in the `Gateway`.
Expand Down