org.apache.jackrabbit.oak.spi.security.user.util

Class UserUtil

java.lang.Object

org.apache.jackrabbit.oak.spi.security.user.util.UserUtil

All Implemented Interfaces:

UserConstants

public final class UserUtil
extends Object
implements UserConstants

Utility methods for user management.

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.spi.security.user.UserConstants

CREDENTIALS_ATTRIBUTE_NEWPASSWORD, DEFAULT_ADMIN_ID, DEFAULT_ANONYMOUS_ID, DEFAULT_DEPTH, DEFAULT_ENABLE_RFC7613_USERCASE_MAPPED_PROFILE, DEFAULT_GROUP_PATH, DEFAULT_PASSWORD_INITIAL_CHANGE, DEFAULT_PASSWORD_MAX_AGE, DEFAULT_SYSTEM_RELATIVE_PATH, DEFAULT_USER_PATH, GROUP_PROPERTY_NAMES, MIX_REP_IMPERSONATABLE, NT_NAMES, NT_REP_AUTHORIZABLE, NT_REP_AUTHORIZABLE_FOLDER, NT_REP_GROUP, NT_REP_MEMBER_REFERENCES, NT_REP_MEMBER_REFERENCES_LIST, NT_REP_MEMBERS, NT_REP_PASSWORD, NT_REP_SYSTEM_USER, NT_REP_USER, PARAM_ADMIN_ID, PARAM_ANONYMOUS_ID, PARAM_AUTHORIZABLE_ACTION_PROVIDER, PARAM_AUTHORIZABLE_NODE_NAME, PARAM_DEFAULT_DEPTH, PARAM_ENABLE_RFC7613_USERCASE_MAPPED_PROFILE, PARAM_GROUP_PATH, PARAM_OMIT_ADMIN_PW, PARAM_PASSWORD_HASH_ALGORITHM, PARAM_PASSWORD_HASH_ITERATIONS, PARAM_PASSWORD_HISTORY_SIZE, PARAM_PASSWORD_INITIAL_CHANGE, PARAM_PASSWORD_MAX_AGE, PARAM_PASSWORD_SALT_SIZE, PARAM_SUPPORT_AUTOSAVE, PARAM_SYSTEM_RELATIVE_PATH, PARAM_USER_AUTHENTICATION_FACTORY, PARAM_USER_PATH, PASSWORD_HISTORY_DISABLED_SIZE, PWD_PROPERTY_NAMES, REP_AUTHORIZABLE_ID, REP_DISABLED, REP_IMPERSONATORS, REP_MEMBERS, REP_MEMBERS_LIST, REP_PASSWORD, REP_PASSWORD_LAST_MODIFIED, REP_PRINCIPAL_NAME, REP_PWD, REP_PWD_HISTORY, USER_PROPERTY_NAMES

Method Summary

Modifier and Type	Method and Description
static <T extends Authorizable> T	castAuthorizable(Authorizable authorizable, Class<T> authorizableClass)
static String	getAdminId(ConfigurationParameters parameters)
static String	getAnonymousId(ConfigurationParameters parameters)
static String	getAuthorizableId(org.apache.jackrabbit.oak.api.Tree authorizableTree)
static String	getAuthorizableId(org.apache.jackrabbit.oak.api.Tree authorizableTree, AuthorizableType type) Retrieve the id from the given authorizableTree, which must have been verified for being a valid authorizable of the specified type upfront.
static String	getAuthorizableRootPath(ConfigurationParameters parameters, AuthorizableType type)
static int	getImportBehavior(ConfigurationParameters config) Return the configured ImportBehavior for the given config.
static AuthorizableType	getType(String primaryTypeName)
static AuthorizableType	getType(org.apache.jackrabbit.oak.api.Tree authorizableNode)
static boolean	isAdmin(ConfigurationParameters parameters, String userId)
static boolean	isSystemUser(org.apache.jackrabbit.oak.api.Tree authorizableTree)
static boolean	isType(org.apache.jackrabbit.oak.api.Tree authorizableTree, AuthorizableType type)

Methods inherited from class java.lang.Object

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

Method Detail

isAdmin

public static boolean isAdmin(@Nonnull
                              ConfigurationParameters parameters,
                              @Nonnull
                              String userId)

getAdminId

@Nonnull
public static String getAdminId(@Nonnull
                                          ConfigurationParameters parameters)

getAnonymousId

@Nonnull
public static String getAnonymousId(@Nonnull
                                              ConfigurationParameters parameters)

isType

public static boolean isType(@Nullable
                             org.apache.jackrabbit.oak.api.Tree authorizableTree,
                             @Nonnull
                             AuthorizableType type)

getType

@CheckForNull
public static AuthorizableType getType(@Nonnull
                                                      org.apache.jackrabbit.oak.api.Tree authorizableNode)

getType

@CheckForNull
public static AuthorizableType getType(@CheckForNull
                                                      String primaryTypeName)

isSystemUser

public static boolean isSystemUser(@Nullable
                                   org.apache.jackrabbit.oak.api.Tree authorizableTree)

getAuthorizableRootPath

@CheckForNull
public static String getAuthorizableRootPath(@Nonnull
                                                            ConfigurationParameters parameters,
                                                            @Nullable
                                                            AuthorizableType type)

getAuthorizableId

@CheckForNull
public static String getAuthorizableId(@Nonnull
                                                      org.apache.jackrabbit.oak.api.Tree authorizableTree)

getAuthorizableId

@Nonnull
public static String getAuthorizableId(@Nonnull
                                                 org.apache.jackrabbit.oak.api.Tree authorizableTree,
                                                 @Nonnull
                                                 AuthorizableType type)

Retrieve the id from the given authorizableTree, which must have been verified for being a valid authorizable of the specified type upfront.

Parameters:

authorizableTree - The authorizable tree which must be of the given type/

type - The type of the authorizable tree.

Returns:

The id retrieved from the specified AuthorizableTree.

castAuthorizable

@CheckForNull
public static <T extends Authorizable> T castAuthorizable(@Nullable
                                                                         Authorizable authorizable,
                                                                         Class<T> authorizableClass)
                                                                  throws AuthorizableTypeException

Throws:

AuthorizableTypeException

getImportBehavior

public static int getImportBehavior(@Nonnull
                                    ConfigurationParameters config)

Return the configured ImportBehavior for the given config. The default behavior in case ProtectedItemImporter.PARAM_IMPORT_BEHAVIOR is not contained in the config object is ImportBehavior.IGNORE

Parameters:

config - The configuration parameters.

Returns:

The import behavior as defined by ProtectedItemImporter.PARAM_IMPORT_BEHAVIOR or ImportBehavior.IGNORE if this config parameter is missing.