org.sakaiproject.rights.impl

Class BaseRightsService

java.lang.Object

org.sakaiproject.rights.impl.BaseRightsService

All Implemented Interfaces:

RightsService

Direct Known Subclasses:

BasicRightsService

public abstract class BaseRightsService
extends Object
implements RightsService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseRightsService.BasicCopyright
static class	BaseRightsService.BasicCreativeCommonsLicense
static class	BaseRightsService.BasicRightsAssignment Init and Destroy
static interface	BaseRightsService.Storage

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseRightsService.Storage	m_storage

Constructor Summary

Constructors

Constructor and Description
BaseRightsService()

Method Summary

Modifier and Type	Method and Description
RightsAssignment	addRightsAssignment(String entityRef)
SiteRightsPolicy	addSiteRightsPolicy(String context)
UserRightsPolicy	addUserRightsPolicy(String context, String userId)
void	destroy() Returns to uninitialized state.
RightsAssignment	getRightsAssignment(String entityRef)
SiteRightsPolicy	getSiteRightsPolicy(String context)
UserRightsPolicy	getUserRightsPolicy(String context, String userId)
void	init() Final initialization, once all dependencies are set.
protected abstract BaseRightsService.Storage	newStorage() Construct a Storage object.
void	save(RightsAssignment rights)
void	save(RightsPolicy policy)
void	setRightsAssignment(String entityRef, RightsAssignment rights)

Methods inherited from class java.lang.Object

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

Field Detail

m_storage

protected BaseRightsService.Storage m_storage

Constructor Detail

BaseRightsService

public BaseRightsService()

Method Detail

addRightsAssignment

public RightsAssignment addRightsAssignment(String entityRef)

Specified by:

addRightsAssignment in interface RightsService

Parameters:

entityRef -

Returns:

addSiteRightsPolicy

public SiteRightsPolicy addSiteRightsPolicy(String context)

Specified by:

addSiteRightsPolicy in interface RightsService

addUserRightsPolicy

public UserRightsPolicy addUserRightsPolicy(String context,
                                            String userId)

Specified by:

addUserRightsPolicy in interface RightsService

destroy

public void destroy()

Returns to uninitialized state.

getRightsAssignment

public RightsAssignment getRightsAssignment(String entityRef)
                                     throws IdUnusedException

Specified by:

getRightsAssignment in interface RightsService

Throws:

IdUnusedException

getSiteRightsPolicy

public SiteRightsPolicy getSiteRightsPolicy(String context)

Specified by:

getSiteRightsPolicy in interface RightsService

getUserRightsPolicy

public UserRightsPolicy getUserRightsPolicy(String context,
                                            String userId)

Specified by:

getUserRightsPolicy in interface RightsService

init

public void init()

Final initialization, once all dependencies are set.

newStorage

protected abstract BaseRightsService.Storage newStorage()

Construct a Storage object.

Returns:

The new storage object.

save

public void save(RightsAssignment rights)

Specified by:

save in interface RightsService

Parameters:

rights -

save

public void save(RightsPolicy policy)

Specified by:

save in interface RightsService

setRightsAssignment

public void setRightsAssignment(String entityRef,
                                RightsAssignment rights)

Specified by:

setRightsAssignment in interface RightsService