Package org.apache.directory.fortress.core.model

Class PermGrant

java.lang.Object

org.apache.directory.fortress.core.model.FortEntity

org.apache.directory.fortress.core.model.PermGrant

All Implemented Interfaces:

Serializable

public class PermGrant
extends FortEntity
implements Serializable

This entity is used by FortressAntTask to add Permission grants to RBAC Role, or ARBAC AdminRole. Can also be used to grant Permissions directly to Users. This entity is used for Ant and Fortress Rest processing only.

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.directory.fortress.core.model.FortEntity

adminSession, contextId, modCode, modId, sequenceId

Constructor Summary

Constructors

Constructor	Description
PermGrant()

Method Summary

Modifier and Type	Method	Description
String	getObjId()	Return the permission object id.
String	getObjName()	Return the permission object name.
String	getOpName()	Return the permission operation name.
String	getRoleNm()	Get the role name associated from this entity.
String	getUserId()	Get the userId attribute from this entity.
boolean	isAdmin()	If set to true entity will be stored in ldap subdirectory associated with administrative permissions GlobalIds.ADMIN_PERM_ROOT.
void	setAdmin(boolean admin)	Return boolean value that will be set to true if this entity will be stored in Administrative Permissions.
void	setObjId(String objId)	Set the permission object id.
void	setObjName(String objName)	Set the permission object name.
void	setOpName(String opName)	Set the permission operation name.
void	setRoleNm(String roleNm)	Set the role name associated with this entity.
void	setUserId(String userId)	Set the userId attribute on this entity.
String	toString()

Methods inherited from class org.apache.directory.fortress.core.model.FortEntity

getAdminSession, getContextId, getModCode, getModId, getSequenceId, setAdminSession, setContextId, setModCode, setSequenceId

Methods inherited from class java.lang.Object

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

Constructor Detail

PermGrant

public PermGrant()

Method Detail

getObjName

public String getObjName()

Return the permission object name.

Returns:

maps to 'ftObjNm' attribute on 'ftOperation' object class.

setObjName

public void setObjName(String objName)

Set the permission object name.

Parameters:

objName - maps to 'ftObjNm' attribute on 'ftOperation' object class.

getObjId

public String getObjId()

Return the permission object id.

Returns:

maps to 'ftObjId' attribute on 'ftOperation' object class.

setObjId

public void setObjId(String objId)

Set the permission object id.

Parameters:

objId - maps to 'ftObjId' attribute on 'ftOperation' object class.

getOpName

public String getOpName()

Return the permission operation name.

Returns:

maps to 'ftOpNm' attribute on 'ftOperation' object class.

setOpName

public void setOpName(String opName)

Set the permission operation name.

Parameters:

opName - maps to 'ftOpNm' attribute on 'ftOperation' object class.

getUserId

public String getUserId()

Get the userId attribute from this entity.

Returns:

maps to 'ftUsers' attribute on 'ftOperation' object class.

setUserId

public void setUserId(String userId)

Set the userId attribute on this entity.

Parameters:

userId - maps to 'ftUsers' attribute on 'ftOperation' object class.

getRoleNm

public String getRoleNm()

Get the role name associated from this entity.

Returns:

maps to 'ftRoles' attribute on 'ftOperation' object class.

setRoleNm

public void setRoleNm(String roleNm)

Set the role name associated with this entity.

Parameters:

roleNm - maps to 'ftRoles' attribute on 'ftOperation' object class.

isAdmin

public boolean isAdmin()

If set to true entity will be stored in ldap subdirectory associated with administrative permissions GlobalIds.ADMIN_PERM_ROOT. otherwise will be RBAC permissions GlobalIds.PERM_ROOT

Returns:

boolean if administrative entity.

setAdmin

public void setAdmin(boolean admin)

Return boolean value that will be set to true if this entity will be stored in Administrative Permissions.

Parameters:

admin - will be true if administrative entity.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()