Module org.apache.jena.fuseki.core

Package org.apache.jena.fuseki.auth

Class Auth

java.lang.Object

org.apache.jena.fuseki.auth.Auth

public class Auth
extends Object

Authorization Policies. See Users for special user names.

Field Summary

Fields

Modifier and Type	Field	Description
static AuthPolicy	ANY_ANON	Any user, whether authenticated or not.
static AuthPolicy	ANY_USER	Any authenticated user.
static AuthPolicy	DENY	Never allow.
static final String	dftRealm

Constructor Summary

Constructors

Constructor	Description
Auth()

Method Summary

Modifier and Type	Method	Description
static boolean	allow(String user, AuthPolicy policy)	Test whether a user (principal) is allowed by a authorization policy.
static boolean	allow(String user, AuthPolicy policy, Runnable notAllowed)	Test whether a user (principal) is allowed by a authorization policy and perform an action if the policy does not allow the user.
static AuthPolicy	policyAllowSpecific(String... allowedUsers)	A policy that allows specific users (convenience wrapped for policyAllowSpecific(Collection)).
static AuthPolicy	policyAllowSpecific(Collection<String> allowedUsers)	A policy that allows specific users.

Methods inherited from class java.lang.Object

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

Field Details

dftRealm

public static final String dftRealm

See Also:

• Constant Field Values

ANY_USER

public static AuthPolicy ANY_USER

Any authenticated user.

ANY_ANON

public static AuthPolicy ANY_ANON

Any user, whether authenticated or not.

DENY

public static AuthPolicy DENY

Never allow.

Constructor Details

Auth

public Auth()

Method Details

policyAllowSpecific

public static AuthPolicy policyAllowSpecific(String... allowedUsers)

A policy that allows specific users (convenience wrapped for policyAllowSpecific(Collection)).

policyAllowSpecific

public static AuthPolicy policyAllowSpecific(Collection<String> allowedUsers)

A policy that allows specific users.

• If any user is Users.UserAnyLoggedIn, then this policy is the same as ANY_USER.
• If any user is Users.UserAnyAnon, then this policy is the same as ANY_ANON.

allow

public static boolean allow(String user,
 AuthPolicy policy)

Test whether a user (principal) is allowed by a authorization policy. The policy can be null, meaning no restrictions, and the function returns true. user maybe null, meaning unauthenticated and any policy must deal with this.

Parameters:

user -

policy -

Returns:

boolean True if the policy is null or allows the user.

allow

public static boolean allow(String user,
 AuthPolicy policy,
 Runnable notAllowed)

Test whether a user (principal) is allowed by a authorization policy and perform an action if the policy does not allow the user. The action can throw an exception. Additional, return true/false - see allow(String, AuthPolicy). The policy can be null, meaning no restrictions, and the function returns true. user maybe null, meaning unauthenticated and any policy must deal with this.

Parameters:

user -

policy -

notAllowed - Runnable to execute if the policy does not allow the user.