org.apache.jetspeed.security.spi.impl
Class SecurityAccessImpl

java.lang.Object
  org.springframework.dao.support.DaoSupport
      org.springframework.orm.ojb.support.PersistenceBrokerDaoSupport
          org.apache.jetspeed.components.dao.InitablePersistenceBrokerDaoSupport
              org.apache.jetspeed.security.spi.impl.SecurityAccessImpl

All Implemented Interfaces:

SecurityAccess, org.springframework.beans.factory.InitializingBean

public class SecurityAccessImpl
extends InitablePersistenceBrokerDaoSupport
implements SecurityAccess

Provides a utility class for common SPI queries.

Author:

David Le Strat , David Sean Taylor

Field Summary

Fields inherited from class org.apache.jetspeed.components.dao.InitablePersistenceBrokerDaoSupport

repositoryPath

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

SecurityAccessImpl(java.lang.String repositoryPath)

Method Summary

InternalGroupPrincipal	getInternalGroupPrincipal(java.lang.String groupFullPathName) Returns the InternalGroupPrincipalfrom the group full path name.
java.util.Iterator	getInternalGroupPrincipals(java.lang.String filter) Returns a InternalGroupPrincipal collection of Group given the filter.
InternalRolePrincipal	getInternalRolePrincipal(java.lang.String roleFullPathName) Returns the InternalRolePrincipalfrom the role full path name.
java.util.Iterator	getInternalRolePrincipals(java.lang.String filter) Returns a InternalRolePrincipal collection given the filter.
InternalUserPrincipal	getInternalUserPrincipal(java.lang.String username) Returns the InternalUserPrincipal from the user name.
InternalUserPrincipal	getInternalUserPrincipal(java.lang.String username, boolean isMappingOnly) Returns the InternalUserPrincipal from the user name.
java.util.Iterator	getInternalUserPrincipals(java.lang.String filter) Returns a collection of Principalgiven the filter.
boolean	isKnownUser(java.lang.String username) Returns if a Internal UserPrincipal is defined for the user name.
void	removeInternalGroupPrincipal(InternalGroupPrincipal internalGroup) Remove the given InternalGroupPrincipal.
void	removeInternalRolePrincipal(InternalRolePrincipal internalRole) Remove the given InternalRolePrincipal.
void	removeInternalUserPrincipal(InternalUserPrincipal internalUser) Remove the given InternalUserPrincipal.
void	setInternalGroupPrincipal(InternalGroupPrincipal internalGroup, boolean isMappingOnly) Sets the given InternalGroupPrincipal.
void	setInternalRolePrincipal(InternalRolePrincipal internalRole, boolean isMappingOnly) Sets the given InternalRolePrincipal.
void	setInternalUserPrincipal(InternalUserPrincipal internalUser, boolean isMappingOnly) Sets the given InternalUserPrincipal.

Methods inherited from class org.apache.jetspeed.components.dao.InitablePersistenceBrokerDaoSupport

init

Methods inherited from class org.springframework.orm.ojb.support.PersistenceBrokerDaoSupport

checkDaoConfig, closePersistenceBrokerIfNecessary, convertOjbAccessException, createPersistenceBrokerTemplate, getJcdAlias, getPersistenceBroker, getPersistenceBrokerTemplate, releasePersistenceBroker, setJcdAlias, setPersistenceBrokerTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityAccessImpl

public SecurityAccessImpl(java.lang.String repositoryPath)

Parameters:

repositoryPath -

Method Detail

isKnownUser

public boolean isKnownUser(java.lang.String username)

Returns if a Internal UserPrincipal is defined for the user name.

Specified by:

isKnownUser in interface SecurityAccess

Parameters:

username - The user name.

Returns:

true if the user is known

getInternalUserPrincipal

public InternalUserPrincipal getInternalUserPrincipal(java.lang.String username)

Returns the InternalUserPrincipal from the user name.

Specified by:

getInternalUserPrincipal in interface SecurityAccess

Parameters:

username - The user name.

Returns:

The InternalUserPrincipal.

getInternalUserPrincipal

public InternalUserPrincipal getInternalUserPrincipal(java.lang.String username,
                                                      boolean isMappingOnly)

Returns the InternalUserPrincipal from the user name.

Specified by:

getInternalUserPrincipal in interface SecurityAccess

Parameters:

username - The user name.

isMappingOnly - Whether a principal's purpose is for security mappping only.

Returns:

The InternalUserPrincipal.

getInternalUserPrincipals

public java.util.Iterator getInternalUserPrincipals(java.lang.String filter)

Returns a collection of Principalgiven the filter.

Specified by:

getInternalUserPrincipals in interface SecurityAccess

Parameters:

filter - The filter.

Returns:

Collection of InternalUserPrincipal.

setInternalUserPrincipal

public void setInternalUserPrincipal(InternalUserPrincipal internalUser,
                                     boolean isMappingOnly)
                              throws SecurityException

Sets the given InternalUserPrincipal.

Specified by:

setInternalUserPrincipal in interface SecurityAccess

Parameters:

internalUser - The InternalUserPrincipal.

isMappingOnly - Whether a principal's purpose is for security mappping only.

Throws:

SecurityException - Throws a SecurityException.

removeInternalUserPrincipal

public void removeInternalUserPrincipal(InternalUserPrincipal internalUser)
                                 throws SecurityException

Remove the given InternalUserPrincipal.

Specified by:

removeInternalUserPrincipal in interface SecurityAccess

Parameters:

internalUser - The InternalUserPrincipal.

Throws:

SecurityException - Throws a SecurityException.

getInternalRolePrincipal

public InternalRolePrincipal getInternalRolePrincipal(java.lang.String roleFullPathName)

Returns the InternalRolePrincipalfrom the role full path name.

Specified by:

getInternalRolePrincipal in interface SecurityAccess

Parameters:

roleFullPathName - The role full path name.

Returns:

The InternalRolePrincipal.

setInternalRolePrincipal

public void setInternalRolePrincipal(InternalRolePrincipal internalRole,
                                     boolean isMappingOnly)
                              throws SecurityException

Sets the given InternalRolePrincipal.

Specified by:

setInternalRolePrincipal in interface SecurityAccess

Parameters:

internalRole - The InternalRolePrincipal.

isMappingOnly - Whether a principal's purpose is for security mappping only.

Throws:

SecurityException - Throws a SecurityException.

removeInternalRolePrincipal

public void removeInternalRolePrincipal(InternalRolePrincipal internalRole)
                                 throws SecurityException

Remove the given InternalRolePrincipal.

Specified by:

removeInternalRolePrincipal in interface SecurityAccess

Parameters:

internalRole - The InternalRolePrincipal.

Throws:

SecurityException - Throws a SecurityException.

getInternalGroupPrincipal

public InternalGroupPrincipal getInternalGroupPrincipal(java.lang.String groupFullPathName)

Returns the InternalGroupPrincipalfrom the group full path name.

Specified by:

getInternalGroupPrincipal in interface SecurityAccess

Parameters:

groupFullPathName - The group full path name.

Returns:

The InternalGroupPrincipal.

setInternalGroupPrincipal

public void setInternalGroupPrincipal(InternalGroupPrincipal internalGroup,
                                      boolean isMappingOnly)
                               throws SecurityException

Sets the given InternalGroupPrincipal.

Specified by:

setInternalGroupPrincipal in interface SecurityAccess

Parameters:

internalGroup - The InternalGroupPrincipal.

isMappingOnly - Whether a principal's purpose is for security mappping only.

Throws:

SecurityException - Throws a SecurityException.

removeInternalGroupPrincipal

public void removeInternalGroupPrincipal(InternalGroupPrincipal internalGroup)
                                  throws SecurityException

Remove the given InternalGroupPrincipal.

Specified by:

removeInternalGroupPrincipal in interface SecurityAccess

Parameters:

internalGroup - The InternalGroupPrincipal.

Throws:

SecurityException - Throws a SecurityException.

getInternalRolePrincipals

public java.util.Iterator getInternalRolePrincipals(java.lang.String filter)

Description copied from interface: SecurityAccess

Returns a InternalRolePrincipal collection given the filter.

Specified by:

getInternalRolePrincipals in interface SecurityAccess

Parameters:

filter - The filter.

Returns:

Collection of InternalRolePrincipal.

getInternalGroupPrincipals

public java.util.Iterator getInternalGroupPrincipals(java.lang.String filter)

Description copied from interface: SecurityAccess

Returns a InternalGroupPrincipal collection of Group given the filter.

Specified by:

getInternalGroupPrincipals in interface SecurityAccess

Parameters:

filter - The filter.

Returns:

Collection of InternalGroupPrincipal.