org.arl.fjage.auth

Class SimpleFirewallSupplier

java.lang.Object

org.arl.fjage.auth.SimpleFirewallSupplier

All Implemented Interfaces:

java.util.function.Supplier<Firewall>

public class SimpleFirewallSupplier
extends java.lang.Object
implements java.util.function.Supplier<Firewall>

Simple firewall supplier. This firewall is restrictive and applies access policies on a user-by-user basis. Example usage:

 
   final SimpleFirewallSupplier simpleFirewallSupplier = new SimpleFirewallSupplier()
       .addPolicy("policy1", policy -> policy
           .allowedServiceNames("server")
           .allowedAgentNames("server1")
           .allowedTopicNames("server1__ntf")
   )
   .addUser("user", "somecreds", "policy1")
   .addUser("app", "someappcreds", SimpleFirewallSupplier.POLICY_ID_ALLOW_ALL);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleFirewallSupplier.Policy Access policy.
static class	SimpleFirewallSupplier.User User information.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	POLICY_ID_ALLOW_ALL Allow all policy ID.

Constructor Summary

Constructors

Constructor and Description
SimpleFirewallSupplier()

Method Summary

Modifier and Type	Method and Description
SimpleFirewallSupplier	addPolicy(java.lang.String policyId, java.util.function.Consumer<SimpleFirewallSupplier.Policy> policyConsumer) Add/update a policy.
SimpleFirewallSupplier	addUser(java.lang.String username, java.lang.String credentials, java.lang.String policyId) Add/update a user.
SimpleFirewallSupplier.Policy	findPolicy(java.lang.String policyId) Find a policy.
SimpleFirewallSupplier.User	findUserByCredentials(java.lang.String credentials) Find a user by credentials.
Firewall	get()
void	removePolicy(java.lang.String policyId) Remove a policy.
void	removeUser(java.lang.String username) Remove a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

POLICY_ID_ALLOW_ALL

public static final java.lang.String POLICY_ID_ALLOW_ALL

Allow all policy ID.

See Also:

Constant Field Values

Constructor Detail

SimpleFirewallSupplier

public SimpleFirewallSupplier()

Method Detail

addUser

public SimpleFirewallSupplier addUser(java.lang.String username,
                                      java.lang.String credentials,
                                      java.lang.String policyId)

Add/update a user.

Parameters:

username - User name.

credentials - User credentials.

policyId - ID of policy to be applied to this user.

Returns:

This SimpleFirewallSupplier instance.

addPolicy

public SimpleFirewallSupplier addPolicy(java.lang.String policyId,
                                        java.util.function.Consumer<SimpleFirewallSupplier.Policy> policyConsumer)

Add/update a policy.

Parameters:

policyId - Policy ID.

policyConsumer - Policy consumer. Used to configure the policy.

Returns:

This SimpleFirewallSupplier instance.

removeUser

public void removeUser(java.lang.String username)

Remove a user.

Parameters:

username - User name.

removePolicy

public void removePolicy(java.lang.String policyId)

Remove a policy.

Parameters:

policyId - Policy ID.

findUserByCredentials

public SimpleFirewallSupplier.User findUserByCredentials(java.lang.String credentials)

Find a user by credentials.

Parameters:

credentials - Credentials.

Returns:

User if found, null otherwise.

findPolicy

public SimpleFirewallSupplier.Policy findPolicy(java.lang.String policyId)

Find a policy.

Parameters:

policyId - Policy ID.

Returns:

Policy if found, null otherwise.

get

public Firewall get()

Specified by:

get in interface java.util.function.Supplier<Firewall>