org.argeo.osgi.useradmin

Class AbstractUserDirectory

java.lang.Object

org.argeo.osgi.useradmin.AbstractUserDirectory

All Implemented Interfaces:

UserDirectory, UserAdmin

Direct Known Subclasses:

LdapUserAdmin, LdifUserAdmin, OsUserDirectory

public abstract class AbstractUserDirectory
extends java.lang.Object
implements UserAdmin, UserDirectory

Base class for a UserDirectory.

Constructor Summary

Constructors

Constructor and Description
AbstractUserDirectory(java.net.URI uriArg, java.util.Dictionary<java.lang.String,?> props)

Method Summary

Modifier and Type	Method and Description
protected void	checkEdit()
java.util.Dictionary<java.lang.String,java.lang.Object>	cloneProperties()
protected void	commit(org.argeo.osgi.useradmin.UserDirectoryWorkingCopy wc)
Role	createRole(java.lang.String name, int type)
protected abstract org.argeo.osgi.useradmin.DirectoryUser	daoGetRole(javax.naming.ldap.LdapName key)
protected abstract java.lang.Boolean	daoHasRole(javax.naming.ldap.LdapName dn)
void	destroy()
protected org.argeo.osgi.useradmin.DirectoryUser	doGetRole(javax.naming.ldap.LdapName dn)
protected abstract java.util.List<org.argeo.osgi.useradmin.DirectoryUser>	doGetRoles(Filter f)
protected void	doGetUser(java.lang.String key, java.lang.String value, java.util.List<org.argeo.osgi.useradmin.DirectoryUser> collectedUsers)
protected java.util.List<Role>	getAllRoles(org.argeo.osgi.useradmin.DirectoryUser user)
Authorization	getAuthorization(User user)
javax.naming.ldap.LdapName	getBaseDn() The base DN of all entries in this user directory
protected java.util.List<java.lang.String>	getCredentialAttributeIds()
protected abstract java.util.List<javax.naming.ldap.LdapName>	getDirectGroups(javax.naming.ldap.LdapName dn) Returns the groups this user is a direct member of.
protected UserAdmin	getExternalRoles()
java.lang.String	getGroupBase()
java.lang.String	getGroupObjectClass()
protected java.lang.String	getMemberAttributeId()
java.util.Dictionary<java.lang.String,java.lang.Object>	getProperties()
Role	getRole(java.lang.String name)
Role[]	getRoles(java.lang.String filter)
protected java.net.URI	getUri()
User	getUser(java.lang.String key, java.lang.String value)
java.lang.String	getUserBase()
java.lang.String	getUserObjectClass() dn can be null, in that case a default should be returned.
protected org.argeo.osgi.useradmin.UserDirectoryWorkingCopy	getWorkingCopy()
org.argeo.osgi.useradmin.WcXaResource	getXaResource() The related XAResource
void	init()
boolean	isDisabled()
protected boolean	isEditing()
boolean	isReadOnly()
protected org.argeo.osgi.useradmin.DirectoryUser	newRole(javax.naming.ldap.LdapName dn, int type, javax.naming.directory.Attributes attrs)
protected java.lang.String	newUserObjectClass(javax.naming.ldap.LdapName dn)
protected void	prepare(org.argeo.osgi.useradmin.UserDirectoryWorkingCopy wc)
boolean	removeRole(java.lang.String name)
protected int	roleType(javax.naming.ldap.LdapName dn)
protected void	rollback(org.argeo.osgi.useradmin.UserDirectoryWorkingCopy wc)
protected abstract AbstractUserDirectory	scope(User user)
void	setExternalRoles(UserAdmin externalRoles)
void	setTransactionManager(javax.transaction.TransactionManager transactionManager)
protected javax.naming.ldap.LdapName	toDn(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUserDirectory

public AbstractUserDirectory(java.net.URI uriArg,
                             java.util.Dictionary<java.lang.String,?> props)

Method Detail

getDirectGroups

protected abstract java.util.List<javax.naming.ldap.LdapName> getDirectGroups(javax.naming.ldap.LdapName dn)

Returns the groups this user is a direct member of.

daoHasRole

protected abstract java.lang.Boolean daoHasRole(javax.naming.ldap.LdapName dn)

daoGetRole

protected abstract org.argeo.osgi.useradmin.DirectoryUser daoGetRole(javax.naming.ldap.LdapName key)
                                                              throws javax.naming.NameNotFoundException

Throws:

javax.naming.NameNotFoundException

doGetRoles

protected abstract java.util.List<org.argeo.osgi.useradmin.DirectoryUser> doGetRoles(Filter f)

scope

protected abstract AbstractUserDirectory scope(User user)

init

public void init()

destroy

public void destroy()

isEditing

protected boolean isEditing()

getWorkingCopy

protected org.argeo.osgi.useradmin.UserDirectoryWorkingCopy getWorkingCopy()

checkEdit

protected void checkEdit()

getAllRoles

protected java.util.List<Role> getAllRoles(org.argeo.osgi.useradmin.DirectoryUser user)

getRole

public Role getRole(java.lang.String name)

Specified by:

getRole in interface UserAdmin

doGetRole

protected org.argeo.osgi.useradmin.DirectoryUser doGetRole(javax.naming.ldap.LdapName dn)

getRoles

public Role[] getRoles(java.lang.String filter)
                throws InvalidSyntaxException

Specified by:

getRoles in interface UserAdmin

Throws:

InvalidSyntaxException

getUser

public User getUser(java.lang.String key,
                    java.lang.String value)

Specified by:

getUser in interface UserAdmin

doGetUser

protected void doGetUser(java.lang.String key,
                         java.lang.String value,
                         java.util.List<org.argeo.osgi.useradmin.DirectoryUser> collectedUsers)

getAuthorization

public Authorization getAuthorization(User user)

Specified by:

getAuthorization in interface UserAdmin

createRole

public Role createRole(java.lang.String name,
                       int type)

Specified by:

createRole in interface UserAdmin

newRole

protected org.argeo.osgi.useradmin.DirectoryUser newRole(javax.naming.ldap.LdapName dn,
                                                         int type,
                                                         javax.naming.directory.Attributes attrs)

removeRole

public boolean removeRole(java.lang.String name)

Specified by:

removeRole in interface UserAdmin

prepare

protected void prepare(org.argeo.osgi.useradmin.UserDirectoryWorkingCopy wc)

commit

protected void commit(org.argeo.osgi.useradmin.UserDirectoryWorkingCopy wc)

rollback

protected void rollback(org.argeo.osgi.useradmin.UserDirectoryWorkingCopy wc)

toDn

protected javax.naming.ldap.LdapName toDn(java.lang.String name)

getMemberAttributeId

protected java.lang.String getMemberAttributeId()

getCredentialAttributeIds

protected java.util.List<java.lang.String> getCredentialAttributeIds()

getUri

protected java.net.URI getUri()

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface UserDirectory

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface UserDirectory

getExternalRoles

protected UserAdmin getExternalRoles()

roleType

protected int roleType(javax.naming.ldap.LdapName dn)

getUserObjectClass

public java.lang.String getUserObjectClass()

dn can be null, in that case a default should be returned.

Specified by:

getUserObjectClass in interface UserDirectory

getUserBase

public java.lang.String getUserBase()

Specified by:

getUserBase in interface UserDirectory

newUserObjectClass

protected java.lang.String newUserObjectClass(javax.naming.ldap.LdapName dn)

getGroupObjectClass

public java.lang.String getGroupObjectClass()

Specified by:

getGroupObjectClass in interface UserDirectory

getGroupBase

public java.lang.String getGroupBase()

Specified by:

getGroupBase in interface UserDirectory

getBaseDn

public javax.naming.ldap.LdapName getBaseDn()

Description copied from interface: UserDirectory

The base DN of all entries in this user directory

Specified by:

getBaseDn in interface UserDirectory

getProperties

public java.util.Dictionary<java.lang.String,java.lang.Object> getProperties()

cloneProperties

public java.util.Dictionary<java.lang.String,java.lang.Object> cloneProperties()

setExternalRoles

public void setExternalRoles(UserAdmin externalRoles)

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager transactionManager)

getXaResource

public org.argeo.osgi.useradmin.WcXaResource getXaResource()

Description copied from interface: UserDirectory

The related XAResource

Specified by:

getXaResource in interface UserDirectory