PortalAdminEntitlementHelper Class
- public class PortalAdminEntitlementHelper
extends Object
This class contains helper methods used by the portal admin jsp tools to access and deal
with portal entitlements.
-
Hierarchy
-
Object
PortalAdminEntitlementHelper
public static boolean |
-
doesPlaceholderDefinitionPolicyExist (String webApp, PageDefinitionId pageDefId, PlaceholderDefinitionId placeholderDefId, HttpServletRequest request)
|
public static boolean |
-
doesPlaceholderInstancePolicyExist (DesktopDefinitionId desktopDefId, PageDefinitionId pageDefId, PlaceholderDefinitionId placeholderDefId, HttpServletRequest request)
Method that checks to see if a PlaceholderDefinition is locked, meaning it has an
admin level entitlement set on it.
|
public static void |
-
findAndRemoveBookInstancePolicies (String webAppName, String bookDefinitionId, DesktopView [] desktopViews, HttpServletRequest request)
|
public static void |
-
findAndRemovePageInstancePolicies (String webAppName, String pageDefinitionId, DesktopView [] desktopViews, HttpServletRequest request)
|
public static void |
-
findAndRemovePortletInstancePolicies (String webAppName, String portletId, DesktopView [] desktopViews, boolean findAllInstances, HttpServletRequest request)
|
public static List |
-
getDefinitionPolicies (String webApp, String resourceType, String definitionLabel, List capabilityNames)
|
public static List |
-
getDefinitionPolicies (String webApp, String resourceType, String definitionLabel, List capabilityNames, ArrayList populatedList)
|
public static List |
-
getInstancePolicies (String webApp, String resourceType, String instanceLabel, String definitionLabel, List capabilityNames, String desktopId)
Method that gets all Entitlements set for a given Resource.
|
public static void |
-
removeBookDefinitionPolicies (String webApp, String definitionId, String definitionLabel, DesktopView [] desktopViews, HttpServletRequest request)
Method that removes all Entitlements set for a given Role.
|
public static void |
-
removeBookInstancePolicies (String webApp, BookView bv, String portalPath, String desktopPath, HttpServletRequest request)
|
public static void |
-
removeDesktopInstancePolicies (String webApp, DesktopView dv, String portalPath, String desktopPath, HttpServletRequest request)
|
public static void |
-
removeLookAndFeelDefinitionPolicies (String webApp, String definitionId, String definitionLabel, HttpServletRequest request)
|
public static void |
-
removePageDefinitionPolicies (String webApp, String definitionId, String definitionLabel, DesktopView [] desktopViews, HttpServletRequest request)
|
public static void |
-
removePageInstancePolicies (String webApp, PageView pv, String portalPath, String desktopPath, HttpServletRequest request)
|
public static void |
-
removePlaceholderDefinitionPolicy (String webApp, PageDefinitionId pageDefId, PlaceholderDefinitionId placeholderDefId, HttpServletRequest request)
|
public static void |
-
removePlaceholderInstancePolicy (DesktopDefinitionId desktopDefId, PageDefinitionId pageDefId, PlaceholderDefinitionId placeholderDefId, HttpServletRequest request)
Method that unlocks a PlaceholderDefinition by removing any admin level entitlement on it.
|
public static void |
-
removePortletDefinitionPolicies (String webApp, String definitionId, String definitionLabel, DesktopView [] desktopViews, HttpServletRequest request)
|
public static void |
-
removePortletInstancePolicies (String webApp, PortletView pv, String portalPath, String desktopPath, HttpServletRequest request)
|
public static void |
-
setPlaceholderDefinitionPolicy (String webApp, PageDefinitionId pageDefId, PlaceholderDefinitionId placeholderDefId, HttpServletRequest request)
|
public static void |
-
setPlaceholderInstancePolicy (DesktopDefinitionId desktopDefId, PageDefinitionId pageDefId, PlaceholderDefinitionId placeholderDefId, HttpServletRequest request)
Method that locks a PlaceholderDefinition by setting an admin level entitlement on it.
|
public static void |
-
updatePolicies (String webApp, String resourceType, String definitionLabel, List allRoles, String desktopId, String descriptionText, ServletRequest request)
Method that adds/removes Entitlements for a given List of Roles.
|
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PortalAdminEntitlementHelper
public PortalAdminEntitlementHelper()
doesPlaceholderDefinitionPolicyExist(String, PageDefinitionId, PlaceholderDefinitionId, HttpServletRequest) Method
public static boolean doesPlaceholderDefinitionPolicyExist(String
webApp,
PageDefinitionId
pageDefId,
PlaceholderDefinitionId
placeholderDefId,
HttpServletRequest
request)
doesPlaceholderInstancePolicyExist(DesktopDefinitionId, PageDefinitionId, PlaceholderDefinitionId, HttpServletRequest) Method
public static boolean doesPlaceholderInstancePolicyExist(DesktopDefinitionId
desktopDefId,
PageDefinitionId
pageDefId,
PlaceholderDefinitionId
placeholderDefId,
HttpServletRequest
request)
Method that checks to see if a PlaceholderDefinition is locked, meaning it has an
admin level entitlement set on it.
Parameters
-
desktopDefId
- The current HttpServletRequest
Returns
- true if the PlaceholderDefinition is currently locked
findAndRemoveBookInstancePolicies(String, String, DesktopView[], HttpServletRequest) Method
public static void findAndRemoveBookInstancePolicies(String
webAppName,
String
bookDefinitionId,
DesktopView
[] desktopViews,
HttpServletRequest
request)
findAndRemovePageInstancePolicies(String, String, DesktopView[], HttpServletRequest) Method
public static void findAndRemovePageInstancePolicies(String
webAppName,
String
pageDefinitionId,
DesktopView
[] desktopViews,
HttpServletRequest
request)
findAndRemovePortletInstancePolicies(String, String, DesktopView[], boolean, HttpServletRequest) Method
public static void findAndRemovePortletInstancePolicies(String
webAppName,
String
portletId,
DesktopView
[] desktopViews,
boolean findAllInstances,
HttpServletRequest
request)
getDefinitionPolicies(String, String, String, List) Method
public static List
getDefinitionPolicies(String
webApp,
String
resourceType,
String
definitionLabel,
List
capabilityNames)
getDefinitionPolicies(String, String, String, List, ArrayList) Method
public static List
getDefinitionPolicies(String
webApp,
String
resourceType,
String
definitionLabel,
List
capabilityNames,
ArrayList
populatedList)
getInstancePolicies(String, String, String, String, List, String) Method
public static List
getInstancePolicies(String
webApp,
String
resourceType,
String
instanceLabel,
String
definitionLabel,
List
capabilityNames,
String
desktopId)
Method that gets all Entitlements set for a given Resource.
The value of the resourceType argument must be one of PortalEntitlementResource.PAGE_RESOURCE_TYPE,
PortalEntitlementResource.BOOK_RESOURCE_TYPE, PortalEntitlementResource.DESKTOP_RESOURCE_TYPE,
PortalEntitlementResource.LOOK_AND_FEEL_RESOURCE_TYPE, PortalEntitlementResource.PORTLET_RESOURCE_TYPE,
or null if dealing with the top level library entitlement.
The value of the definitionLabel argument must be the result of the getDefinitionLabel()
call from the actual resource Definition.
Parameters
-
webApp
- The web application the Entitlements to be returned are scoped to
-
resourceType
- The type of the resource to get the list of Entitlements for.
-
instanceLabel
- The definition label of the resource to get the List of Entitlements for.
-
definitionLabel
- The List of capabilities of the resource to get the List of Entitlements for.
-
capabilityNames
- The desktopId of the resource to remove.
removeBookDefinitionPolicies(String, String, String, DesktopView[], HttpServletRequest) Method
public static void removeBookDefinitionPolicies(String
webApp,
String
definitionId,
String
definitionLabel,
DesktopView
[] desktopViews,
HttpServletRequest
request)
Method that removes all Entitlements set for a given Role.
The value of the resourceType argument must be one of PortalEntitlementResource.PAGE_RESOURCE_TYPE,
PortalEntitlementResource.BOOK_RESOURCE_TYPE, PortalEntitlementResource.DESKTOP_RESOURCE_TYPE,
PortalEntitlementResource.LOOK_AND_FEEL_RESOURCE_TYPE, PortalEntitlementResource.PORTLET_RESOURCE_TYPE,
or null if dealing with the top level library entitlement.
The value of the definitionLabel argument must be the result of the getDefinitionLabel()
call from the actual resource Definition.
Parameters
-
webApp
- The web application the Entitlements to be removed are scoped to
-
definitionId
- The type of the resource the Entitlement is set on.
-
definitionLabel
- The definition label of the resource the Entitlement is set on.
-
desktopViews
- The PolicyByRole object, constructed with the Role to remove, and the associated capabilities for the resource.
-
request
- The desktopId of the resource to remove.
removeBookInstancePolicies(String, BookView, String, String, HttpServletRequest) Method
public static void removeBookInstancePolicies(String
webApp,
BookView
bv,
String
portalPath,
String
desktopPath,
HttpServletRequest
request)
removeDesktopInstancePolicies(String, DesktopView, String, String, HttpServletRequest) Method
public static void removeDesktopInstancePolicies(String
webApp,
DesktopView
dv,
String
portalPath,
String
desktopPath,
HttpServletRequest
request)
removeLookAndFeelDefinitionPolicies(String, String, String, HttpServletRequest) Method
public static void removeLookAndFeelDefinitionPolicies(String
webApp,
String
definitionId,
String
definitionLabel,
HttpServletRequest
request)
removePageDefinitionPolicies(String, String, String, DesktopView[], HttpServletRequest) Method
public static void removePageDefinitionPolicies(String
webApp,
String
definitionId,
String
definitionLabel,
DesktopView
[] desktopViews,
HttpServletRequest
request)
removePageInstancePolicies(String, PageView, String, String, HttpServletRequest) Method
public static void removePageInstancePolicies(String
webApp,
PageView
pv,
String
portalPath,
String
desktopPath,
HttpServletRequest
request)
removePlaceholderDefinitionPolicy(String, PageDefinitionId, PlaceholderDefinitionId, HttpServletRequest) Method
public static void removePlaceholderDefinitionPolicy(String
webApp,
PageDefinitionId
pageDefId,
PlaceholderDefinitionId
placeholderDefId,
HttpServletRequest
request)
removePlaceholderInstancePolicy(DesktopDefinitionId, PageDefinitionId, PlaceholderDefinitionId, HttpServletRequest) Method
public static void removePlaceholderInstancePolicy(DesktopDefinitionId
desktopDefId,
PageDefinitionId
pageDefId,
PlaceholderDefinitionId
placeholderDefId,
HttpServletRequest
request)
Method that unlocks a PlaceholderDefinition by removing any admin level entitlement on it.
Parameters
-
desktopDefId
- The current HttpServletRequest
removePortletDefinitionPolicies(String, String, String, DesktopView[], HttpServletRequest) Method
public static void removePortletDefinitionPolicies(String
webApp,
String
definitionId,
String
definitionLabel,
DesktopView
[] desktopViews,
HttpServletRequest
request)
removePortletInstancePolicies(String, PortletView, String, String, HttpServletRequest) Method
public static void removePortletInstancePolicies(String
webApp,
PortletView
pv,
String
portalPath,
String
desktopPath,
HttpServletRequest
request)
setPlaceholderDefinitionPolicy(String, PageDefinitionId, PlaceholderDefinitionId, HttpServletRequest) Method
public static void setPlaceholderDefinitionPolicy(String
webApp,
PageDefinitionId
pageDefId,
PlaceholderDefinitionId
placeholderDefId,
HttpServletRequest
request)
setPlaceholderInstancePolicy(DesktopDefinitionId, PageDefinitionId, PlaceholderDefinitionId, HttpServletRequest) Method
public static void setPlaceholderInstancePolicy(DesktopDefinitionId
desktopDefId,
PageDefinitionId
pageDefId,
PlaceholderDefinitionId
placeholderDefId,
HttpServletRequest
request)
Method that locks a PlaceholderDefinition by setting an admin level entitlement on it.
The Visitor Tools Manager API then in turn checks to see whether placeholders have this
entitlement set on them, which determines whether or not a visitor is able to update
a placeholder.
Parameters
-
desktopDefId
- The current HttpServletRequest
updatePolicies(String, String, String, List, String, String, ServletRequest) Method
public static void updatePolicies(String
webApp,
String
resourceType,
String
definitionLabel,
List
allRoles,
String
desktopId,
String
descriptionText,
ServletRequest
request)
Method that adds/removes Entitlements for a given List of Roles.
The value of the resourceType argument must be one of PortalEntitlementResource.PAGE_RESOURCE_TYPE,
PortalEntitlementResource.BOOK_RESOURCE_TYPE, PortalEntitlementResource.DESKTOP_RESOURCE_TYPE,
PortalEntitlementResource.LOOK_AND_FEEL_RESOURCE_TYPE, PortalEntitlementResource.PORTLET_RESOURCE_TYPE,
or null if dealing with the top level library entitlement.
The value of the definitionLabel argument must be the result of the getDefinitionLabel()
call from the actual resource Definition.
Parameters
-
webApp
- The web application the Entitlements to be updated are scoped to
-
resourceType
- The type of the resource the Entitlement to be updated is set on.
-
definitionLabel
- The definition label of the resource the Entitlement to be updated is set on.
-
allRoles
- A List containing PolicyByRole objects for each Role to update
-
desktopId
- The desktopId of the resource to update.