AdminResourceManager 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

com.bea.portal.admin.ejb
AdminResourceManager Interface

public interface AdminResourceManager

    extends EJBObject

Handles all resource personalization admin functionality.

All Superinterfaces
EJBObject, Remote

Method Summary
public PortalPersonalization
createPortalPersonalization(GroupPortal destinationGroupPortal, GroupPortal existingGroupPortal, boolean copyEntitlements, boolean copyAdmins)
Create a PortalPersonalization from an existing PortalPersonalization.
public List
getAllGroupPortals(PortalIdentifier portalId)
Retrieve the list of all group portals defined for this portal.
public GroupPortal
getGroupPortal(PortalIdentifier portalIdentifier, String userGroupIdentifier)
Retrieve a full GroupPortal
public List
getGroupPortalEligibleUserGroups(PortalIdentifier portalId)
Retrieve the list of eligible user group for the Portal
public List
getGroupPortals(PortalIdentifier portalIdentifier)
Retrieve list of GroupPortal objects for a Portal available to the calling Admin user Note: This will return all GroupPortals for a PortalAdmin
public Portal
getPortal(PortalIdentifier id)
Retrieves a Portal for a given PortalIdentifier
public PortalPersonalization
getPortalPersonalization(GroupPortal groupPortal)
Retrieve a full PortalPersonalization
public List
getPortals()
Retrieve list of PortalIdentifier objects available to the calling Admin user Note: This will return Portals visible to GroupAdmins, as well.
public void
removeDeletedLayoutsForGroupPageP13n(List availableLayouts, PagePersonalization pageP13n, PortalPersonalization groupPortal)
public void
removeGroupPortalP13nSkin(SkinIdentifier skinId, PortalPersonalization groupPortalP13n)
public List
removePortalPersonalization(GroupPortal groupPortal)
Remove a PortalPersonalization
public void
setPortalPersonalization(PortalPersonalization portalPersonalization)
Set a PortalPersonalization
 
Methods from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
   

Method Detail

createPortalPersonalization(GroupPortal, GroupPortal, boolean, boolean) Method

public PortalPersonalization createPortalPersonalization(GroupPortal destinationGroupPortal, 
                                                         GroupPortal existingGroupPortal, 
                                                         boolean copyEntitlements, 
                                                         boolean copyAdmins)
     throws RealmNotWritableAddException, RemoteException
Create a PortalPersonalization from an existing PortalPersonalization.

Parameters

destinationGroupPortal
GroupPortal to base creation on
existingGroupPortal
represents existing PortalPersonalization to create from
copyEntitlements
true if entitlements should be copied from the existing PortalPersonalization
copyAdmins
true if admins should be copied from the existing PortalPersonalization

Returns

newly-created PortalPersonalization

Exceptions

RealmNotWritableAddException
thrown if the underlying realm is not writable (ie. LDAP)
RemoteException
because of EJB contract

getAllGroupPortals(PortalIdentifier) Method

public List getAllGroupPortals(PortalIdentifier portalId)
     throws RemoteException
Retrieve the list of all group portals defined for this portal.

Parameters

portalId
the Portal

Returns

a List of GroupPortal objects defined for this portal.

Exceptions

RemoteException
because of EJB contract

getGroupPortal(PortalIdentifier, String) Method

public GroupPortal getGroupPortal(PortalIdentifier portalIdentifier, 
                                  String userGroupIdentifier)
     throws RemoteException
Retrieve a full GroupPortal

Parameters

portalIdentifier
the PortalIdentifier of the GroupPortal
userGroupIdentifier
the UserGroup Identifier of the GroupPortal

Returns

GroupPortal object

Exceptions

RemoteException
because of EJB contract

getGroupPortalEligibleUserGroups(PortalIdentifier) Method

public List getGroupPortalEligibleUserGroups(PortalIdentifier portalId)
     throws RemoteException
Retrieve the list of eligible user group for the Portal

Parameters

portalId
the Portal

Returns

a List of user group names represented as Strings

Exceptions

RemoteException
because of EJB contract

getGroupPortals(PortalIdentifier) Method

public List getGroupPortals(PortalIdentifier portalIdentifier)
     throws RemoteException
Retrieve list of GroupPortal objects for a Portal available to the calling Admin user Note: This will return all GroupPortals for a PortalAdmin

Parameters

portalIdentifier
the PortalIdentifier of the GroupPortals

Returns

list of GroupPortal objects

Exceptions

RemoteException
because of EJB contract

getPortal(PortalIdentifier) Method

public Portal getPortal(PortalIdentifier id)
     throws RemoteException
Retrieves a Portal for a given PortalIdentifier

Parameters

id
the PortalIdentifier to retrieve

Returns

the Portal

Exceptions

RemoteException
because of EJB contract

getPortalPersonalization(GroupPortal) Method

public PortalPersonalization getPortalPersonalization(GroupPortal groupPortal)
     throws RemoteException
Retrieve a full PortalPersonalization

Parameters

groupPortal
the GroupPortal that matches a PortalPersonalization

Returns

PortalPersonalization object

Exceptions

RemoteException
because of EJB contract

getPortals() Method

public List getPortals()
     throws RemoteException
Retrieve list of PortalIdentifier objects available to the calling Admin user Note: This will return Portals visible to GroupAdmins, as well. This is not a security hole as any future mutable operations on the Portal will check if the user is a PortalAdmin.

Returns

list of PortalIdentifier objects

Exceptions

RemoteException
because of EJB contract

removeDeletedLayoutsForGroupPageP13n(List, PagePersonalization, PortalPersonalization) Method

public void removeDeletedLayoutsForGroupPageP13n(List availableLayouts, 
                                                 PagePersonalization pageP13n, 
                                                 PortalPersonalization groupPortal)
     throws RemoteException

Exceptions

RemoteException

removeGroupPortalP13nSkin(SkinIdentifier, PortalPersonalization) Method

public void removeGroupPortalP13nSkin(SkinIdentifier skinId, 
                                      PortalPersonalization groupPortalP13n)
     throws RemoteException

Exceptions

RemoteException

removePortalPersonalization(GroupPortal) Method

public List removePortalPersonalization(GroupPortal groupPortal)
     throws RemoteException
Remove a PortalPersonalization

Parameters

groupPortal
the GroupPortal that matches a PortalPersonalization

Returns

list of admin users (String:username) that need to be MANUALLY removed from the DelegatedAdministrator User Group (in the case where an unwritable realm is being used)

Exceptions

RemoteException
because of EJB contract

setPortalPersonalization(PortalPersonalization) Method

public void setPortalPersonalization(PortalPersonalization portalPersonalization)
     throws RemoteException
Set a PortalPersonalization

Parameters

portalPersonalization
the PortalPersonalization to set

Exceptions

RemoteException
because of EJB contract