DelegatedAdminManager Interface
DEPRECATED com.bea.portal is only useful in the compatibility domain. For the new portal framework please
use the classes under the com.bea.netuix package
- public interface DelegatedAdminManager
extends EJBObject
Handles all delegated admin functionality.
-
All Superinterfaces
-
EJBObject
, Remote
public void |
-
addGroupAdmin (ProfileIdentity delegateeUser, GroupPortal groupPortal)
- Adds a GroupAdmin for a given GroupPortal
|
public void |
-
addPortalAdmin (ProfileIdentity delegateeUser, PortalIdentifier portalIdentifier, List groupPortals)
- Adds a PortalAdmin for a given Portal
|
public boolean |
-
canAdministerGroupPortal (ProfileIdentity delegateeUser, GroupPortal groupPortal)
- Returns true if the calling Admin is an (SA), (PA with assoc to Portal), or (GA with assoc to GroupPortal)
|
public boolean |
-
canAdministerPortal (ProfileIdentity delegateeUser, PortalIdentifier portalId)
- Returns true if the calling Admin is an (SA) or (PA with assoc to Portal)
|
public boolean |
-
canDelegateGroupAdmin (ProfileIdentity delegateeUser, GroupPortal groupPortal)
- Returns true if the calling Admin has at least at least 1 delegate capability for the given Portal
|
public boolean |
-
canDelegatePortalAdmin (ProfileIdentity delegateeUser, PortalIdentifier portalId)
- Returns true if the Admin has at least at least 1 delegate capability for the given Portal
|
public void |
-
copyGroupAdminEntitlements (ProfileIdentity delegateeUser, GroupPortal sourceGroupPortal, GroupPortal destinationGroupPortal)
- Copy the complete set of capabilities for a given user
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used to copy capabilities for a user
|
public void |
-
copyPortalAdminEntitlements (ProfileIdentity delegateeUser, PortalIdentifier sourcePortalId, PortalIdentifier destinationPortalId)
- Copy the complete set of capabilities for a given user
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used to copy capabilities for a user
|
public List |
-
getGroupAdminEligibleUsers (GroupPortal groupPortal)
- Retrieve admin eligible usernames for an SA, PA or GA to choose from when creating a GA for a GroupPortal.
|
public List |
-
getGroupAdmins (GroupPortal groupPortal)
- Get all GroupAdmin usernames for a GroupPortal for an SA, PA or GA to manage.
|
public List |
-
getPortalAdminEligibleGroupAdmins (PortalIdentifier portalId, List groupPortals)
- Retrieve admin eligible existing GroupAdmin user names for an SA or PA to choose from when promoting a GA to a PA for a Portal.
|
public List |
-
getPortalAdminEligibleUsers (PortalIdentifier portalIdentifier, List groupPortals)
- Retrieve admin eligible user names for an SA or PA to choose from when creating a PA for a Portal.
|
public List |
-
getPortalAdmins (PortalIdentifier portalId)
- Get all PortalAdmin usernames for a Portal for an SA or PA to manage
(Note: Only PA's will be returned.
|
public boolean |
-
isAdmin (ProfileIdentity delegateeUser)
- Returns true if the given user is an admin for ANY resource
|
public boolean |
-
isAdminEligible (String userName)
- Returns true if the given user is a member of the group for users who
are elibible to be delegated administrators (usually "AdminEligible",
but can be overridden with an env-entry.
|
public boolean |
-
isAdminGroup (String userGroup)
- Returns true if the given user group is an admin or admin eligible group
|
public boolean |
-
isDelegatedAdmin (String userName)
- Returns true if the given user is a member of the group for assigned
delegated administrators (usually "DelegatedAdministrator", but can be
overridden with an env-entry.
|
public boolean |
-
isGroupAdminAccessAllowed (ProfileIdentity delegateeUser, GroupPortal groupPortal, String resourceType, String adminTask, String capabilityKey)
- Retrieve a capability for a given key
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used by the UI to retrieve capabilities for a user during a capability edit
|
public boolean |
-
isMemberOf (String userGroupName, String userName)
- Returns true if the given user is a member of the given group
|
public boolean |
-
isPortalAdminAccessAllowed (ProfileIdentity delegateeUser, PortalIdentifier portalId, String resourceType, String adminTask, String capabilityKey)
- Retrieve a capability for a given key
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used by the UI to retrieve capabilities for a user during a capability edit
|
public boolean |
-
isPortalSystemAdmin (String userName)
- Returns true if the given user is a member of the group for Portal
System Administrators (usually "SystemAdministrator", but can be
overridden with an env-entry.
|
public boolean |
-
isWritableRealm ()
- Checks if the underlying user realm is writable or not
|
public void |
-
removeGroupAdmin (ProfileIdentity delegateeUser, GroupPortal groupPortal)
- Removes a GroupAdmin from a given GroupPortal
|
public void |
-
removeGroupAdminEntitlements (ProfileIdentity delegateeUser, GroupPortal groupPortal)
- Remove the complete set of capabilities for a given user
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used to copy capabilities for a user
|
public void |
-
removePortalAdmin (ProfileIdentity delegateeUser, PortalIdentifier portalIdentifier)
- Removes a PortalAdmin from a given Portal
|
public void |
-
removePortalAdminEntitlements (ProfileIdentity delegateeUser, PortalIdentifier portalId)
- Remove the complete set of capabilities for a given user
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used to copy capabilities for a user
|
public void |
-
setGroupAdminAccessAllowed (ProfileIdentity delegateeUser, GroupPortal groupPortal, String resourceType, String adminTask, String capabilityKey, boolean capabilityValue)
- Set a capability for a given task and capability
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used by the UI to set capabilities for a user during a capability edit
|
public void |
-
setPortalAdminAccessAllowed (ProfileIdentity delegateeUser, PortalIdentifier portalId, String resourceType, String adminTask, String capabilityKey, boolean capabilityValue)
- Set a capability for a given task and capability
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used by the UI to set capabilities for a user during a capability edit
|
addGroupAdmin(ProfileIdentity, GroupPortal) Method
public void addGroupAdmin(ProfileIdentity
delegateeUser,
GroupPortal
groupPortal)
throws RealmNotWritableAddException
, RemoteException
Adds a GroupAdmin for a given GroupPortal
Parameters
-
delegateeUser
- the user to add as an GroupAdmin
-
groupPortal
- the GroupPortal to administer
Exceptions
-
RealmNotWritableAddException
- thrown if the underlying realm is not writable (ie. LDAP)
-
RemoteException
- because of EJB contract
addPortalAdmin(ProfileIdentity, PortalIdentifier, List) Method
public void addPortalAdmin(ProfileIdentity
delegateeUser,
PortalIdentifier
portalIdentifier,
List
groupPortals)
throws RealmNotWritableAddException
, RemoteException
Adds a PortalAdmin for a given Portal
Parameters
-
delegateeUser
- the user to add as an Admin
-
portalIdentifier
- the PortalIdentifier of the Portal to administer
-
groupPortals
- all Group Portals for the Portal - required if GA -> PA promotion is being performed
Exceptions
-
RealmNotWritableAddException
- thrown if the underlying realm is not writable (ie. LDAP) during add operation
-
RemoteException
- because of EJB contract
canAdministerGroupPortal(ProfileIdentity, GroupPortal) Method
public boolean canAdministerGroupPortal(ProfileIdentity
delegateeUser,
GroupPortal
groupPortal)
throws RemoteException
Returns true if the calling Admin is an (SA), (PA with assoc to Portal), or (GA with assoc to GroupPortal)
Parameters
-
delegateeUser
- the delegatee admin user to check
-
groupPortal
- the GroupPortal
Exceptions
-
RemoteException
- because of EJB contract
canAdministerPortal(ProfileIdentity, PortalIdentifier) Method
public boolean canAdministerPortal(ProfileIdentity
delegateeUser,
PortalIdentifier
portalId)
throws RemoteException
Returns true if the calling Admin is an (SA) or (PA with assoc to Portal)
Parameters
-
delegateeUser
- the delegatee admin user to check
-
portalId
- the Portal
Exceptions
-
RemoteException
- because of EJB contract
canDelegateGroupAdmin(ProfileIdentity, GroupPortal) Method
public boolean canDelegateGroupAdmin(ProfileIdentity
delegateeUser,
GroupPortal
groupPortal)
throws RemoteException
Returns true if the calling Admin has at least at least 1 delegate capability for the given Portal
Parameters
-
delegateeUser
- the delegatee admin user to check
-
groupPortal
- the GroupPortal
Exceptions
-
RemoteException
- because of EJB contract
canDelegatePortalAdmin(ProfileIdentity, PortalIdentifier) Method
public boolean canDelegatePortalAdmin(ProfileIdentity
delegateeUser,
PortalIdentifier
portalId)
throws RemoteException
Returns true if the Admin has at least at least 1 delegate capability for the given Portal
Parameters
-
delegateeUser
- the delegatee admin user to check
-
portalId
- the Portal
Exceptions
-
RemoteException
- because of EJB contract
copyGroupAdminEntitlements(ProfileIdentity, GroupPortal, GroupPortal) Method
public void copyGroupAdminEntitlements(ProfileIdentity
delegateeUser,
GroupPortal
sourceGroupPortal,
GroupPortal
destinationGroupPortal)
throws RemoteException
Copy the complete set of capabilities for a given user
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used to copy capabilities for a user
Parameters
-
delegateeUser
- the delegatee admin user to set capabilities
-
sourceGroupPortal
- the source GroupPortal
-
destinationGroupPortal
- the destination GroupPortal
Exceptions
-
RemoteException
- because of EJB contract
copyPortalAdminEntitlements(ProfileIdentity, PortalIdentifier, PortalIdentifier) Method
public void copyPortalAdminEntitlements(ProfileIdentity
delegateeUser,
PortalIdentifier
sourcePortalId,
PortalIdentifier
destinationPortalId)
throws RemoteException
Copy the complete set of capabilities for a given user
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used to copy capabilities for a user
Parameters
-
delegateeUser
- the delegatee admin user to set capabilities
-
sourcePortalId
- the source PortalIdentifier
-
destinationPortalId
- the destination PortalIdentifier
Exceptions
-
RemoteException
- because of EJB contract
getGroupAdminEligibleUsers(GroupPortal) Method
public List
getGroupAdminEligibleUsers(GroupPortal
groupPortal)
throws RemoteException
Retrieve admin eligible usernames for an SA, PA or GA to choose from when creating a GA for a GroupPortal.
Parameters
-
groupPortal
- the GroupPortal
Returns
- list of usernames (String)
Exceptions
-
RemoteException
- because of EJB contract
getGroupAdmins(GroupPortal) Method
public List
getGroupAdmins(GroupPortal
groupPortal)
throws RemoteException
Get all GroupAdmin usernames for a GroupPortal for an SA, PA or GA to manage.
(Note: Only GA's will be returned. For PAs, use the getPortalAdmins()
Parameters
-
groupPortal
- the GroupPortal
Returns
- list of GroupAdmin Users
Exceptions
-
RemoteException
- because of EJB contract
getPortalAdminEligibleGroupAdmins(PortalIdentifier, List) Method
public List
getPortalAdminEligibleGroupAdmins(PortalIdentifier
portalId,
List
groupPortals)
throws RemoteException
Retrieve admin eligible existing GroupAdmin user names for an SA or PA to choose from when promoting a GA to a PA for a Portal.
Parameters
-
portalId
- the PortalIdentifier of the Portal
-
groupPortals
- list of all Group Portal objects for the given Portal
Returns
- list of usernames (String)
Exceptions
-
RemoteException
- because of EJB contract
getPortalAdminEligibleUsers(PortalIdentifier, List) Method
public List
getPortalAdminEligibleUsers(PortalIdentifier
portalIdentifier,
List
groupPortals)
throws RemoteException
Retrieve admin eligible user names for an SA or PA to choose from when creating a PA for a Portal.
Note: This method will NOT return existing GroupAdmins for the Portal. Use the getPortalAdminEligibleGroupAdmins() method for each
to obtain that list separately if "promotion" is supported.
Parameters
-
portalIdentifier
- the PortalIdentifier of the Portal
-
groupPortals
- list of all Group Portal objects for the given Portal
Returns
- list of usernames (String)
Exceptions
-
RemoteException
- because of EJB contract
getPortalAdmins(PortalIdentifier) Method
public List
getPortalAdmins(PortalIdentifier
portalId)
throws RemoteException
Get all PortalAdmin usernames for a Portal for an SA or PA to manage
(Note: Only PA's will be returned. SAs are managed outside of the portal tools as they have full-control.
Parameters
-
portalId
- the PortalIdentifier
Returns
- list of PortalAdmin Users
Exceptions
-
RemoteException
- because of EJB contract
isAdmin(ProfileIdentity) Method
public boolean isAdmin(ProfileIdentity
delegateeUser)
throws RemoteException
Returns true if the given user is an admin for ANY resource
Parameters
-
delegateeUser
- the admin user
Exceptions
-
RemoteException
- because of EJB contract
isAdminEligible(String) Method
public boolean isAdminEligible(String
userName)
throws RemoteException
Returns true if the given user is a member of the group for users who
are elibible to be delegated administrators (usually "AdminEligible",
but can be overridden with an env-entry.
Parameters
-
userName
- the user name
Exceptions
-
RemoteException
- because of EJB contract
isAdminGroup(String) Method
public boolean isAdminGroup(String
userGroup)
throws RemoteException
Returns true if the given user group is an admin or admin eligible group
Parameters
-
userGroup
- the User Group
Exceptions
-
RemoteException
- because of EJB contract
isDelegatedAdmin(String) Method
public boolean isDelegatedAdmin(String
userName)
throws RemoteException
Returns true if the given user is a member of the group for assigned
delegated administrators (usually "DelegatedAdministrator", but can be
overridden with an env-entry.
Parameters
-
userName
- the user name
Exceptions
-
RemoteException
- because of EJB contract
isGroupAdminAccessAllowed(ProfileIdentity, GroupPortal, String, String, String) Method
public boolean isGroupAdminAccessAllowed(ProfileIdentity
delegateeUser,
GroupPortal
groupPortal,
String
resourceType,
String
adminTask,
String
capabilityKey)
throws RemoteException
Retrieve a capability for a given key
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used by the UI to retrieve capabilities for a user during a capability edit
Parameters
-
delegateeUser
- the delegatee admin user to set capabilities
-
groupPortal
- the GroupPortal
-
resourceType
- the type of resource - see either PortalAdminTaskResourceConstants or PortalEntitlementResourceConstants * @param adminTask the adminTask
-
adminTask
- the key to set a capability
Returns
- capabilityValue the value of the capability
Exceptions
-
RemoteException
- because of EJB contract
isMemberOf(String, String) Method
public boolean isMemberOf(String
userGroupName,
String
userName)
throws RemoteException
Returns true if the given user is a member of the given group
Parameters
-
userGroupName
- the user group name
-
userName
- the user name
Exceptions
-
RemoteException
- because of EJB contract
isPortalAdminAccessAllowed(ProfileIdentity, PortalIdentifier, String, String, String) Method
public boolean isPortalAdminAccessAllowed(ProfileIdentity
delegateeUser,
PortalIdentifier
portalId,
String
resourceType,
String
adminTask,
String
capabilityKey)
throws RemoteException
Retrieve a capability for a given key
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used by the UI to retrieve capabilities for a user during a capability edit
Parameters
-
delegateeUser
- the delegatee admin user to set capabilities
-
portalId
- the PortalIdentifier
-
resourceType
- the type of resource - see either PortalAdminTaskResourceConstants or PortalEntitlementResourceConstants
-
adminTask
- the adminTask
-
capabilityKey
- the key to set a capability
Returns
- capabilityValue the value of the capability
Exceptions
-
RemoteException
- because of EJB contract
isPortalSystemAdmin(String) Method
public boolean isPortalSystemAdmin(String
userName)
throws RemoteException
Returns true if the given user is a member of the group for Portal
System Administrators (usually "SystemAdministrator", but can be
overridden with an env-entry.
Parameters
-
userName
- the user name
Exceptions
-
RemoteException
- because of EJB contract
isWritableRealm() Method
public boolean isWritableRealm()
throws RemoteException
Checks if the underlying user realm is writable or not
Returns
- true if realm is writable
Exceptions
-
RemoteException
removeGroupAdmin(ProfileIdentity, GroupPortal) Method
public void removeGroupAdmin(ProfileIdentity
delegateeUser,
GroupPortal
groupPortal)
throws RemoteException
Removes a GroupAdmin from a given GroupPortal
Parameters
-
delegateeUser
- the user to remove as a PortalAdmin
-
groupPortal
- the GroupPortal to administer
Exceptions
-
RemoteException
- because of EJB contract
removeGroupAdminEntitlements(ProfileIdentity, GroupPortal) Method
public void removeGroupAdminEntitlements(ProfileIdentity
delegateeUser,
GroupPortal
groupPortal)
throws RemoteException
Remove the complete set of capabilities for a given user
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used to copy capabilities for a user
Parameters
-
delegateeUser
- the delegatee admin user to set capabilities
-
groupPortal
- the GroupPortal
Exceptions
-
RemoteException
- because of EJB contract
removePortalAdmin(ProfileIdentity, PortalIdentifier) Method
public void removePortalAdmin(ProfileIdentity
delegateeUser,
PortalIdentifier
portalIdentifier)
throws RemoteException
Removes a PortalAdmin from a given Portal
Parameters
-
delegateeUser
- the user to remove as a PortalAdmin
-
portalIdentifier
- the PortalIdentifier of the Portal to administer
Exceptions
-
RemoteException
- because of EJB contract
removePortalAdminEntitlements(ProfileIdentity, PortalIdentifier) Method
public void removePortalAdminEntitlements(ProfileIdentity
delegateeUser,
PortalIdentifier
portalId)
throws RemoteException
Remove the complete set of capabilities for a given user
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used to copy capabilities for a user
Parameters
-
delegateeUser
- the delegatee admin user to set capabilities
-
portalId
- the PortalIdentifier
Exceptions
-
RemoteException
- because of EJB contract
setGroupAdminAccessAllowed(ProfileIdentity, GroupPortal, String, String, String, boolean) Method
public void setGroupAdminAccessAllowed(ProfileIdentity
delegateeUser,
GroupPortal
groupPortal,
String
resourceType,
String
adminTask,
String
capabilityKey,
boolean capabilityValue)
throws RemoteException
Set a capability for a given task and capability
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used by the UI to set capabilities for a user during a capability edit
Parameters
-
delegateeUser
- the delegatee admin user to set capabilities
-
groupPortal
- the GroupPortal
-
resourceType
- the type of resource - see either PortalAdminTaskResourceConstants or PortalEntitlementResourceConstants
-
adminTask
- the adminTask
-
capabilityKey
- the key to set a capability
-
capabilityValue
- the value of the capability
Exceptions
-
RemoteException
- because of EJB contract
setPortalAdminAccessAllowed(ProfileIdentity, PortalIdentifier, String, String, String, boolean) Method
public void setPortalAdminAccessAllowed(ProfileIdentity
delegateeUser,
PortalIdentifier
portalId,
String
resourceType,
String
adminTask,
String
capabilityKey,
boolean capabilityValue)
throws RemoteException
Set a capability for a given task and capability
(Note: Constants can be found in com.bea.portal.entitlement.resource.PortalAdminTaskResourceConstants)
This method is used by the UI to set capabilities for a user during a capability edit
Parameters
-
delegateeUser
- the delegatee admin user to set capabilities
-
portalId
- the PortalIdentifier
-
resourceType
- the type of resource - see either PortalAdminTaskResourceConstants or PortalEntitlementResourceConstants
-
adminTask
- the adminTask
-
capabilityKey
- the key to set a capability
Returns
- capabilityValue the value of the capability
Exceptions
-
RemoteException
- because of EJB contract