org.arl.fjage.auth

Interface Firewall

All Known Implementing Classes:

AbstractFirewall, AllowAfterAuth, AllowAll, DenyAll

public interface Firewall

Firewall interface for API access to fjage master containers. Each connection to a master container should and will be assigned its own Firewall instance. Firewall instances should be considered stateful.

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(java.lang.String creds) Authenticates peer using specified credentials.
boolean	permit(AgentID aid) Checks whether a message intended for the specified agent/topic may be sent over this connection.
boolean	permit(JsonMessage rq) Checks whether a JSON message can be accepted over this connection.
void	signoff() Called when the connection is closed.

Method Detail

authenticate

boolean authenticate(java.lang.String creds)

Authenticates peer using specified credentials.

Parameters:

creds - credentials, or null if logging out.

Returns:

true if authenticated successfully, false otherwise.

permit

boolean permit(JsonMessage rq)

Checks whether a JSON message can be accepted over this connection.

Parameters:

rq - incoming JSON request.

Returns:

true to accept, false to reject.

permit

boolean permit(AgentID aid)

Checks whether a message intended for the specified agent/topic may be sent over this connection.

Parameters:

aid - recipient agent/topic for the message.

Returns:

true to permit, false to reject.

signoff

void signoff()

Called when the connection is closed. The Firewall instance should perform cleanup.