Package org.apache.directory.fortress.core.rest

Class PropertyMgrRestImpl

java.lang.Object

org.apache.directory.fortress.core.rest.PropertyMgrRestImpl

All Implemented Interfaces:

Manageable, PropertyMgr

public class PropertyMgrRestImpl
extends Object
implements PropertyMgr

TODO: implement me...

Constructor Summary

Constructors

Constructor	Description
PropertyMgrRestImpl()

Method Summary

Modifier and Type	Method	Description
FortEntity	add(FortEntity entity, Properties props)	Adds properties (ftProps) to a supplied fortress entity (Group, Role, AdminRole, Permission, PermObj)
void	delete(FortEntity entity, Properties props)	Delete properties (ftProps) from a supplied fortress entity (Group, Role, AdminRole, Permission, PermObj)
Properties	get(FortEntity entity)	Retrieve properties (ftProps) from a supplied fortress entity (Group, Role, AdminRole, Permission, PermObj)
void	setAdmin(Session session)	Use this method to load an administrative user's ARBAC Session object into Manager object which will enable authorization to be performed on behalf of admin user.
void	setContextId(String contextId)	Use this method to set the tenant id onto function call into Fortress which allows segregation of data by customer.
FortEntity	update(FortEntity entity, Properties props)	Update properties (ftProps) to a supplied fortress entity (Group, Role, AdminRole, Permission, PermObj)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyMgrRestImpl

public PropertyMgrRestImpl()

Method Detail

add

public FortEntity add(FortEntity entity,
                      Properties props)
               throws SecurityException

Description copied from interface: PropertyMgr

Adds properties (ftProps) to a supplied fortress entity (Group, Role, AdminRole, Permission, PermObj)

Specified by:

add in interface PropertyMgr

Parameters:

entity - Entity to add properties

props - Properties to add to entity

Returns:

Updated entity

Throws:

SecurityException

update

public FortEntity update(FortEntity entity,
                         Properties props)
                  throws SecurityException

Description copied from interface: PropertyMgr

Update properties (ftProps) to a supplied fortress entity (Group, Role, AdminRole, Permission, PermObj)

Specified by:

update in interface PropertyMgr

Parameters:

entity - Entity to update properties

props - Properties to update to entity

Returns:

Updated entity

Throws:

SecurityException

delete

public void delete(FortEntity entity,
                   Properties props)
            throws SecurityException

Description copied from interface: PropertyMgr

Delete properties (ftProps) from a supplied fortress entity (Group, Role, AdminRole, Permission, PermObj)

Specified by:

delete in interface PropertyMgr

Parameters:

entity - Entity to delete properties from

props - Properties to delete from entity

Throws:

SecurityException

get

public Properties get(FortEntity entity)
               throws SecurityException

Description copied from interface: PropertyMgr

Retrieve properties (ftProps) from a supplied fortress entity (Group, Role, AdminRole, Permission, PermObj)

Specified by:

get in interface PropertyMgr

Parameters:

entity - Entity to return properties from

Returns:

Properties for the supplied entity

Throws:

SecurityException

setAdmin

public void setAdmin(Session session)

Description copied from interface: Manageable

Use this method to load an administrative user's ARBAC Session object into Manager object which will enable authorization to be performed on behalf of admin user. Setting Session into this object will enforce ARBAC controls and render this class' implementer thread unsafe.

Specified by:

setAdmin in interface Manageable

Parameters:

session - contains a valid Fortress ARBAC Session object.

setContextId

public void setContextId(String contextId)

Description copied from interface: Manageable

Use this method to set the tenant id onto function call into Fortress which allows segregation of data by customer. The contextId is used for multi-tenancy to isolate data sets within a particular sub-tree within DIT. Setting contextId into this object will render this class' implementer thread unsafe.

Specified by:

setContextId in interface Manageable

Parameters:

contextId - maps to sub-tree in DIT, e.g. ou=contextId, dc=example, dc=com.