Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.ac
Interface AccessControlHome
public interface AccessControlHomeThe AccessControlHome interface can be used to access the Access Control component of WebSphere Portal.
An instance can be retrieved using a JNDI lookup for the following JNDI name portal:service/accesscontrol/home.
The name is also available via a constant of the Interface itself: AccessControlHome.JNDI_NAME. The returned instance provides a way to access different views on the Access Control configuration
The following sample shows you how to perform the JNDI lookupContext ctx = new InitialContext(); AccessControlHome acHome = (AccessControlHome) ctx.lookup(AccessControlHome.JNDI_NAME);
- Since:
- 6.1.0.3
- See Also:
- AccessControlRuntimeModel, AccessControlGlobalRuntimeModel, ManagedProtectedResourceModel, RoleData, RoleDataController, ManagedProtectedResource, ManagedProtectedResourceController
Field Summary static java.lang.String JNDI_NAME
The name can be used to lookup theAccessControlHome from JNDI
Method Summary AccessControlEnvironment getAccessControlEnvironment()
The returned instance ofAccessControlEnvironment
provides some general information about the Access Control configuration, for example the available role types.AccessControlGlobalRuntimeModel getAccessControlGlobalRuntimeModel()
The returned instance of AccessControlGlobalRuntimeModel provides read access to the current access control permissions on any resource that is registered at Portal Access ControlAccessControlRuntimeModel getAccessControlRuntimeModel(Identifiable resource)
The returned instance of AccessControlRuntimeModel provides read access to the current access control permissions on the given resourceManagedProtectedResource getManagedProtectedResource(Identifiable resource)
The returned instance of ManagedProtectedResource provides read access to the properties of a of the protected resource associated with the given resource, for example role blocks.ManagedProtectedResourceController getManagedProtectedResourceController(Identifiable resource)
The returned instance of ManagedProtectedResourceController provides write access to the properties of the protected resource associated with the given resource, for example role blocks.ManagedProtectedResourceModel getManagedProtectedResourceModel(Identifiable resource)
The returned instance of ManagedProtectedResourceModel provides read access on the tree model the given resource is part of.ManagedProtectedResourceModel getManagedProtectedResourceModel(int domain)
The returned instance of ManagedProtectedResourceModel provides read access on the tree model for the given domain.RoleData getRoleData(Identifiable resource)
The returned instance of RoleData provides read access to the role date of a of the protected resource associated with the given resource, for example the set of principals mapped to a specific role.RoleDataController getRoleDataController(Identifiable resource)
The returned instance of RoleDataController provides write access to the role date of a of the protected resource associated with the given resource, for example the set of principals mapped to a specific role.
Field Detail JNDI_NAME
static final java.lang.String JNDI_NAME
- The name can be used to lookup the
AccessControlHome from JNDI
- See Also:
- Constant Field Values
Method Detail getAccessControlEnvironment
AccessControlEnvironment getAccessControlEnvironment()
- The returned instance of
AccessControlEnvironment
provides some general information about the Access Control configuration, for example the available role types.
- Returns:
- an AccessControlEnvironment instance
getManagedProtectedResource
ManagedProtectedResource getManagedProtectedResource(Identifiable resource) throws AccessControlException, SystemException, MissingAccessRightsException
- The returned instance of ManagedProtectedResource provides read access to the properties of a of the protected resource associated with the given resource, for example role blocks.
- Parameters:
- resource - a resource or its ObjectID
- Returns:
- The protected resource associated with the given resource
- Throws:
- AccessControlException - will be thrown if any access control related error occurs
- SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
- MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation
getManagedProtectedResourceController
ManagedProtectedResourceController getManagedProtectedResourceController(Identifiable resource) throws AccessControlException, SystemException, MissingAccessRightsException
- The returned instance of ManagedProtectedResourceController provides write access to the properties of the protected resource associated with the given resource, for example role blocks.
- Parameters:
- resource - a resource or its ObjectID
- Returns:
- Controller on the protected resource associated with the given resource
- Throws:
- AccessControlException - will be thrown if any access control related error occurs
- SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
- MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation
getRoleData
RoleData getRoleData(Identifiable resource) throws AccessControlException, SystemException, MissingAccessRightsException
- The returned instance of RoleData provides read access to the role date of a of the protected resource associated with the given resource, for example the set of principals mapped to a specific role.
- Parameters:
- resource - a resource or its ObjectID
- Returns:
- RoleData of the given resource
- Throws:
- AccessControlException - will be thrown if any access control related error occurs
- SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
- MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation
getRoleDataController
RoleDataController getRoleDataController(Identifiable resource) throws AccessControlException, SystemException, MissingAccessRightsException
- The returned instance of RoleDataController provides write access to the role date of a of the protected resource associated with the given resource, for example the set of principals mapped to a specific role.
- Parameters:
- resource - a resource or its ObjectID
- Returns:
- RoleDataController of the given resource
- Throws:
- AccessControlException - will be thrown if any access control related error occurs
- SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
- MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation
getManagedProtectedResourceModel
ManagedProtectedResourceModel getManagedProtectedResourceModel(Identifiable resource) throws AccessControlException, SystemException, MissingAccessRightsException
- The returned instance of ManagedProtectedResourceModel provides read access on the tree model the given resource is part of.
- Parameters:
- resource - a resource or its ObjectID
- Returns:
- The ManagedProtectedResourceModel where the given resource is part of
- Throws:
- AccessControlException - will be thrown if any access control related error occurs
- SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
- MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation
getManagedProtectedResourceModel
ManagedProtectedResourceModel getManagedProtectedResourceModel(int domain) throws AccessControlException, SystemException, MissingAccessRightsException
- The returned instance of ManagedProtectedResourceModel provides read access on the tree model for the given domain. Valid input values are defined in DatabaseDomainConstants
- Parameters:
- domain - constant representing a database domain as defined in DatabaseDomainConstants
- Returns:
- The ManagedProtectedResourceModel for the given domain
- Throws:
- AccessControlException - will be thrown if any access control related error occurs
- SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
- MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation
- See Also:
- DatabaseDomainConstants
getAccessControlRuntimeModel
AccessControlRuntimeModel getAccessControlRuntimeModel(Identifiable resource) throws AccessControlException, SystemException, MissingAccessRightsException
- The returned instance of AccessControlRuntimeModel provides read access to the current access control permissions on the given resource
- Parameters:
- resource - a resource or its ObjectID
- Returns:
- AccessControlRuntimeModel
- Throws:
- AccessControlException - will be thrown if any access control related error occurs
- SystemException - will be thrown if a system resource problem, e.g. a database exception, occurs
- MissingAccessRightsException - will be thrown if the current user does not have the necessary access rights to perform the operation
getAccessControlGlobalRuntimeModel
AccessControlGlobalRuntimeModel getAccessControlGlobalRuntimeModel()
- The returned instance of AccessControlGlobalRuntimeModel provides read access to the current access control permissions on any resource that is registered at Portal Access Control
- Returns:
- AccessControlGlobalRuntimeModel
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD