org.apereo.portal.permission.target

Class SimpleStringTargetProviderImpl

java.lang.Object

org.apereo.portal.permission.target.SimpleStringTargetProviderImpl

All Implemented Interfaces:

java.io.Serializable, IPermissionTargetProvider

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

SimpleStringTargetProviderImpl provides a basic target provider implementation capable of registering static strings as targets. This implementation is appropriate for permission owners for which targets are simple static strings that are well-defined and known in advance.

Since:

3.3

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleStringTargetProviderImpl()

Method Summary

Modifier and Type	Method and Description
void	addTarget(org.apereo.portal.permission.target.IPermissionTarget target) Add a permission target to this target provider.
org.apereo.portal.permission.target.IPermissionTarget	getTarget(java.lang.String key) Return the permission target associated with the specified key under this provider.
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	setTargets(java.util.Collection<org.apereo.portal.permission.target.IPermissionTarget> targets) Set the permission targets for this provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleStringTargetProviderImpl

public SimpleStringTargetProviderImpl()

Method Detail

addTarget

public void addTarget(org.apereo.portal.permission.target.IPermissionTarget target)

Add a permission target to this target provider.

Parameters:

target -

setTargets

public void setTargets(java.util.Collection<org.apereo.portal.permission.target.IPermissionTarget> targets)

Set the permission targets for this provider.

Parameters:

targets - collection of targets

getTarget

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

Description copied from interface: IPermissionTargetProvider

Return the permission target associated with the specified key under this provider. If no target with the given key is valid for this provider, return null.

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