PrincipalUtils

Utility class with static helper methods for querying the current user's identity, roles, tenant, and authentication context from the Spring Security context. All methods are static.

Methods that access the current security context (e.g. getUser(), getRoles()) require a valid authenticated security context. In cron tasks or background threads use the token-based overloads (getUserByToken, getTenantIdByToken) or DbSessionManager to obtain authentication for a known token.

Current user

getUser

Description:

Method	Return values	Description
getUser()	String	Returns the username of the currently authenticated user from the Spring Security context.

Example:

System.out.println(PrincipalUtils.getUser()); // "jsmith"

isUser

Description:

Method	Return values	Description
isUser(String userId)	boolean	Returns `true` if the currently authenticated user has the given username.

getUserByToken

Description:

Method	Return values	Description
getUserByToken(String token)	String	Returns the username associated with the given session token. Throws `AccessDeniedException` if the token is not found.

Tenant

getTenantId

Description:

Method	Return values	Description
getTenantId()	long	Returns the tenant ID of the currently authenticated user. Falls back to `Config.DEFAULT_TENANT_ID` if the tenant cannot be resolved.

Example:

long tenantId = PrincipalUtils.getTenantId();
System.out.println("Tenant: " + tenantId);

getTenantIdByToken

Description:

Method	Return values	Description
getTenantIdByToken(String token)	long	Returns the tenant ID associated with the given session token. Throws `AccessDeniedException` if the token is not found.

Roles

getRoles

Description:

Method	Return values	Description
getRoles()	Set<String>	Returns the set of role names granted to the currently authenticated user. Returns an empty set if not authenticated.

hasRole

Description:

Method	Return values	Description
hasRole(String role)	boolean	Returns `true` if the currently authenticated user has the given role.

Example:

if (PrincipalUtils.hasRole("ROLE_ADMIN")) {
    System.out.println("User is admin");
}
Set<String> roles = PrincipalUtils.getRoles();
System.out.println("Roles: " + roles);

User type checks

isRegularUser

Description:

Method	Return values	Description
isRegularUser()	boolean	Returns `true` if the current user does not have the default admin role.

isAdminUser

Description:

Method	Return values	Description
isAdminUser()	boolean	Returns `true` if the current user has the default admin role.

isSystemUser

Description:

Method	Return values	Description
isSystemUser()	boolean	Returns `true` if the current user is the internal system user used for background operations.

isSuperUser

Description:

Method	Return values	Description
isSuperUser()	boolean	Returns `true` if the current user is the default administrator user (`okmAdmin`).

hasFullAccess

Description:

Method	Return values	Description
hasFullAccess()	boolean	Returns `true` if the current user has unrestricted access to the repository ? i.e. is the system user, the superuser, or has the admin role.

Example:

package com.openkm;

import com.openkm.principal.PrincipalUtils;

public class Test {

    public static void main(String[] args) {
        try {
            System.out.println("User: " + PrincipalUtils.getUser());
            System.out.println("TenantId: " + PrincipalUtils.getTenantId());
            System.out.println("IsAdmin: " + PrincipalUtils.isAdminUser());
            System.out.println("HasFullAccess: " + PrincipalUtils.hasFullAccess());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Authentication access

getAuthentication

Description:

Method	Return values	Description
getAuthentication()	Authentication	Returns the Spring Security `Authentication` object for the current request. Tries the custom `SecurityHolder`, then `SecurityContextHolder`, then the HTTP request. Returns `null` if no authenticated user is found.

getAuthenticationByToken

Description:

Method	Return values	Description
getAuthenticationByToken(String token)	Authentication	Returns the Spring Security `Authentication` object for the given session token. Throws `AccessDeniedException` if the token is not found in `DbSessionManager`.