org.uberfire.ext.security.management.wildfly.properties

Class BaseWildflyUserPropertiesManager

java.lang.Object

org.uberfire.ext.security.management.wildfly.properties.BaseWildflyPropertiesManager

org.uberfire.ext.security.management.wildfly.properties.BaseWildflyUserPropertiesManager

All Implemented Interfaces:

AbstractEntityManager<org.jboss.errai.security.shared.api.identity.User,UserManagerSettings>, ContextualManager, UserManager

public abstract class BaseWildflyUserPropertiesManager
extends BaseWildflyPropertiesManager
implements UserManager, ContextualManager

Base (abstract) users manager service provider implementation for JBoss WildFly, when using default realm based on properties files. Implementation classes for different WildFly versions can use this as a base class.

Nested Class Summary

Nested classes/interfaces inherited from interface org.uberfire.ext.security.management.api.UserManager

UserManager.UserAttribute

Nested classes/interfaces inherited from interface org.uberfire.ext.security.management.api.AbstractEntityManager

AbstractEntityManager.SearchRequest, AbstractEntityManager.SearchResponse<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PASSWORD
static String	DEFAULT_USERS_FILE
protected String	usersFilePath
protected IdentifierRuntimeSearchEngine<org.jboss.errai.security.shared.api.identity.User>	usersSearchEngine
protected UserSystemManager	userSystemManager

Fields inherited from class org.uberfire.ext.security.management.wildfly.properties.BaseWildflyPropertiesManager

DEFAULT_REALM, realm

Constructor Summary

Constructors

Constructor and Description
BaseWildflyUserPropertiesManager()
BaseWildflyUserPropertiesManager(org.uberfire.commons.config.ConfigProperties gitPrefs)
BaseWildflyUserPropertiesManager(Map<String,String> gitPrefs)

Method Summary

Modifier and Type	Method and Description
void	assignGroups(String username, Collection<String> groups)
void	assignRoles(String username, Collection<String> roles)
protected abstract WildflyPropertiesFileLoader	buildFileLoader(String usersFilePath)
void	changePassword(String username, String newPassword)
org.jboss.errai.security.shared.api.identity.User	create(org.jboss.errai.security.shared.api.identity.User entity)
void	delete(String... usernames)
void	destroy()
org.jboss.errai.security.shared.api.identity.User	get(String identifier)
BaseWildflyGroupPropertiesManager	getGroupsPropertiesManager()
UserManagerSettings	getSettings()
protected List<String>	getUserNames() NOTE: To obtain the user names from the UsersFileLoader class, do not use the getEnabledUserNames method that comes in the jboss domain-management artifcat from Wildfly, as this method is not present when using the jboss domain-management artifact from EAP modules, as it's version for 6.4.0.GA is quite older.
WildflyPropertiesFileLoader	getUsersFileLoader()
String	getUsersFilePath()
void	initialize(UserSystemManager userSystemManager)
protected void	loadConfig(org.uberfire.commons.config.ConfigProperties config)
AbstractEntityManager.SearchResponse<org.jboss.errai.security.shared.api.identity.User>	search(AbstractEntityManager.SearchRequest request)
org.jboss.errai.security.shared.api.identity.User	update(org.jboss.errai.security.shared.api.identity.User entity)
protected void	updateUserProperty(String username, String errorMessage)
protected void	updateUserProperty(String username, String password, String errorMessage)

Methods inherited from class org.uberfire.ext.security.management.wildfly.properties.BaseWildflyPropertiesManager

generateHashPassword, isConfigPropertySet, isEmpty

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USERS_FILE

public static final String DEFAULT_USERS_FILE

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

See Also:

Constant Field Values

usersSearchEngine

protected final IdentifierRuntimeSearchEngine<org.jboss.errai.security.shared.api.identity.User> usersSearchEngine

userSystemManager

protected UserSystemManager userSystemManager

usersFilePath

protected String usersFilePath

Constructor Detail

BaseWildflyUserPropertiesManager

public BaseWildflyUserPropertiesManager()

BaseWildflyUserPropertiesManager

public BaseWildflyUserPropertiesManager(Map<String,String> gitPrefs)

BaseWildflyUserPropertiesManager

public BaseWildflyUserPropertiesManager(org.uberfire.commons.config.ConfigProperties gitPrefs)

Method Detail

buildFileLoader

protected abstract WildflyPropertiesFileLoader buildFileLoader(String usersFilePath)
                                                        throws Exception

Throws:

Exception

loadConfig

protected void loadConfig(org.uberfire.commons.config.ConfigProperties config)

Overrides:

loadConfig in class BaseWildflyPropertiesManager

initialize

public void initialize(UserSystemManager userSystemManager)
                throws Exception

Specified by:

initialize in interface ContextualManager

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface ContextualManager

Throws:

Exception

search

public AbstractEntityManager.SearchResponse<org.jboss.errai.security.shared.api.identity.User> search(AbstractEntityManager.SearchRequest request)
                                                                                               throws SecurityManagementException

Specified by:

search in interface AbstractEntityManager<org.jboss.errai.security.shared.api.identity.User,UserManagerSettings>

Throws:

SecurityManagementException

get

public org.jboss.errai.security.shared.api.identity.User get(String identifier)
                                                      throws SecurityManagementException

Specified by:

get in interface AbstractEntityManager<org.jboss.errai.security.shared.api.identity.User,UserManagerSettings>

Throws:

SecurityManagementException

getUsersFilePath

public String getUsersFilePath()

create

public org.jboss.errai.security.shared.api.identity.User create(org.jboss.errai.security.shared.api.identity.User entity)
                                                         throws SecurityManagementException

Specified by:

create in interface AbstractEntityManager<org.jboss.errai.security.shared.api.identity.User,UserManagerSettings>

Throws:

SecurityManagementException

update

public org.jboss.errai.security.shared.api.identity.User update(org.jboss.errai.security.shared.api.identity.User entity)
                                                         throws SecurityManagementException

Specified by:

update in interface AbstractEntityManager<org.jboss.errai.security.shared.api.identity.User,UserManagerSettings>

Throws:

SecurityManagementException

delete

public void delete(String... usernames)
            throws SecurityManagementException

Specified by:

delete in interface AbstractEntityManager<org.jboss.errai.security.shared.api.identity.User,UserManagerSettings>

Throws:

SecurityManagementException

assignGroups

public void assignGroups(String username,
                         Collection<String> groups)
                  throws SecurityManagementException

Specified by:

assignGroups in interface UserManager

Throws:

SecurityManagementException

assignRoles

public void assignRoles(String username,
                        Collection<String> roles)
                 throws SecurityManagementException

Specified by:

assignRoles in interface UserManager

Throws:

SecurityManagementException

changePassword

public void changePassword(String username,
                           String newPassword)
                    throws SecurityManagementException

Specified by:

changePassword in interface UserManager

Throws:

SecurityManagementException

getSettings

public UserManagerSettings getSettings()

Specified by:

getSettings in interface AbstractEntityManager<org.jboss.errai.security.shared.api.identity.User,UserManagerSettings>

getUserNames

protected List<String> getUserNames()

NOTE: To obtain the user names from the UsersFileLoader class, do not use the getEnabledUserNames method that comes in the jboss domain-management artifcat from Wildfly, as this method is not present when using the jboss domain-management artifact from EAP modules, as it's version for 6.4.0.GA is quite older. So in order to be compatible with both wildfly and eap, do not use the getEnabledUserNames method.

updateUserProperty

protected void updateUserProperty(String username,
                                  String errorMessage)

updateUserProperty

protected void updateUserProperty(String username,
                                  String password,
                                  String errorMessage)

getUsersFileLoader

public WildflyPropertiesFileLoader getUsersFileLoader()
                                               throws Exception

Throws:

Exception

getGroupsPropertiesManager

public BaseWildflyGroupPropertiesManager getGroupsPropertiesManager()