org.apereo.portal.permission.target

Class EntityTargetProviderImpl

java.lang.Object

org.apereo.portal.permission.target.EntityTargetProviderImpl

All Implemented Interfaces:

java.io.Serializable, IPermissionTargetProvider

public class EntityTargetProviderImpl
extends java.lang.Object
implements IPermissionTargetProvider, java.io.Serializable

EntityTargetProviderImpl provides uPortal entity keys as targets. Instances of this implementation may indicate which entity types may be used as targets. Target keys will be the key of the underlying entity itself, while the target human-readable name will similarly be the name of the entity.

TODO: This implementation currently has a number of problems. The code uses the EntityEnum class and is hardcoded to only recognize four types of entities: uPortal person groups, person entities, portlet categories, and portlet entities. This code also may perform poorly for large portal installations for searches that return many results.

Since:

3.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
EntityTargetProviderImpl(java.util.Set<java.lang.String> targetTypeNames) Construct a new instance of targets matching the set of allowed target entity types.

Method Summary

Modifier and Type	Method and Description
org.apereo.portal.permission.target.IPermissionTarget	getTarget(java.lang.String key) The key parameter should specify a unique entity across all 4 supported types: people, groups, portlets, and categories.
java.util.Collection<org.apereo.portal.permission.target.IPermissionTarget>	searchTargets(java.lang.String term) Search this provider for a particular target using a single string search term.
void	setGroupListHelper(org.apereo.portal.layout.dlm.remoting.IGroupListHelper helper)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final transient org.apache.commons.logging.Log log

Constructor Detail

EntityTargetProviderImpl

public EntityTargetProviderImpl(java.util.Set<java.lang.String> targetTypeNames)

Construct a new instance of targets matching the set of allowed target entity types.

Parameters:

targetTypeNames -

Method Detail

setGroupListHelper

@Autowired(required=true)
public void setGroupListHelper(org.apereo.portal.layout.dlm.remoting.IGroupListHelper helper)

getTarget

public org.apereo.portal.permission.target.IPermissionTarget getTarget(java.lang.String key)

The key parameter should specify a unique entity across all 4 supported types: people, groups, portlets, and categories.

Concrete examples of working keys:

• defaultTemplateUser (user)
• local.0 (group)
• PORTLET_ID.82 (portlet)
• local.1 (category)

Specified by:

getTarget in interface IPermissionTargetProvider

Returns:

searchTargets

public java.util.Collection<org.apereo.portal.permission.target.IPermissionTarget> searchTargets(java.lang.String term)

Description copied from interface: IPermissionTargetProvider

Search this provider for a particular target using a single string search term. Each target provider implementation is responsible for determining the definition a "matching" target.

Specified by:

searchTargets in interface IPermissionTargetProvider

Parameters:

term - search term

Returns:

collection of matching targets