com.sapportals.wcm.repository.manager
Interface ISecurityManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.framework_api.jar]

All Known Subinterfaces:

IAclSecurityManager

public interface ISecurityManager

An ISecurityManager is a repository submanager which controls the access to resources - an ISecurityManager might be an IAclSecurityManager (using Access Control Lists)

Method Summary

IPermission	getPermission(java.lang.String name) Returns the IPermission object for a supported permission with a given name
IPermissionList	getSupportedPermissions(IResource resource) Returns a a list of permissions which are supported by the security manager for a specific resource (the result depends on wether the resource is a collection or not)
java.lang.String	getType() Returns the type attribute of this security manager.
boolean	isAllowed(IResource resource, com.sapportals.portal.security.usermanagement.IUser user, IPermission permission) Checks, whether a user has a specific permission on a specific resource
boolean	isAllowed(IResource resource, com.sapportals.portal.security.usermanagement.IUser user, IPermissionList permissions) Checks, whether a user has some permissions on a specific resource
IRidSet	isAllowed(IRidList ridList, com.sapportals.portal.security.usermanagement.IUser user, IPermissionList permissions, IResourceContext context) Checks, whether a user has some permissions on all specified resources.

Method Detail

getSupportedPermissions

public IPermissionList getSupportedPermissions(IResource resource)
                                        throws ResourceException

Returns a a list of permissions which are supported by the security manager for a specific resource (the result depends on wether the resource is a collection or not)

Parameters:

resource - the resource

Returns:

the supported permissions

Throws:

ResourceException - the resource RID could not be determined

getPermission

public IPermission getPermission(java.lang.String name)

Returns the IPermission object for a supported permission with a given name

Parameters:

name - the permission name

Returns:

the IPermission object

isAllowed

public boolean isAllowed(IResource resource,
                         com.sapportals.portal.security.usermanagement.IUser user,
                         IPermission permission)
                  throws ResourceException

Checks, whether a user has a specific permission on a specific resource

Parameters:

resource - the resource

user - the user ID

permission - the permission

Returns:

true if the permission is granted

Throws:

ResourceException - the resource RID could not be determined

isAllowed

public boolean isAllowed(IResource resource,
                         com.sapportals.portal.security.usermanagement.IUser user,
                         IPermissionList permissions)
                  throws ResourceException

Checks, whether a user has some permissions on a specific resource

Parameters:

resource - the resource

user - the user ID

permissions - A list of permission

Returns:

true if the permission is granted

Throws:

ResourceException - the resource RID could not be determined

isAllowed

public IRidSet isAllowed(IRidList ridList,
                         com.sapportals.portal.security.usermanagement.IUser user,
                         IPermissionList permissions,
                         IResourceContext context)
                  throws ResourceException

Checks, whether a user has some permissions on all specified resources. A RID from the input list must be contained int the returned list if the user has all the permissions in the permission list.

Parameters:

ridList - A list of resource identifiers to check

user - the user ID

permissions - A list of permission

context - The resource context

Returns:

A set of RIDs

Throws:

ResourceException - the resource RID could not be determined

getType

public java.lang.String getType()

Returns the type attribute of this security manager.

Returns:

type