|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ProfilerService Jetspeed-2 Profiler service. Locates portal resources given a set of request parameters, properties, and attributes The Profiler is invoked during the request processing pipeline. It requires that the request context is already populated with the portal request and response, and capability and user information. The request context parameters, properties and attributes make up the profile criterion which the profiler uses to locate portal resources: 1. page 2. navigations 3. document lists In all cases, a fallback algorithm should be applied to fallback to default portal resources.
Method Summary | |
ProfileLocator |
createLocator(RequestContext context)
Creates a new ProfileLocator object that can be managed by the current Profiler implementation |
void |
deletePrincipalRule(PrincipalRule rule)
|
void |
deleteProfilingRule(ProfilingRule rule)
|
ProfileLocator |
getDefaultProfile(RequestContext context,
String locatorName)
getDefaultProfile |
Map |
getDefaultProfileLocators(RequestContext context)
getDefaultProfileLocators |
ProfilingRule |
getDefaultRule()
Lookup the portal's default profiling rule. |
String[] |
getLocatorNamesForPrincipal(Principal principal)
For a given principal, find all supported locators and return a string array of locator names. |
ProfileLocator |
getProfile(RequestContext context,
ProfilingRule rule)
Get the Profile object using the request parameters and the rule. |
ProfileLocator |
getProfile(RequestContext context,
String locatorName)
Get the Profile object using the request parameters. |
Map |
getProfileLocators(RequestContext context,
Principal principal)
Gets all supported locators for a principal. |
ProfilingRule |
getRule(String id)
Given a rule id, get the rule |
ProfilingRule |
getRuleForPrincipal(Principal principal,
String locatorName)
For a given principal, lookup the associated profiling rule to that principal name. |
Collection |
getRules()
|
Collection |
getRulesForPrincipal(Principal principal)
For a given principal, find all supported locators and return a collection of principal rules. |
void |
setRuleForPrincipal(Principal principal,
ProfilingRule rule,
String locatorName)
For a given principal, associate a profiling rule to that principal name. |
void |
storePrincipalRule(PrincipalRule rule)
|
void |
storeProfilingRule(ProfilingRule rule)
|
Method Detail |
public ProfileLocator getProfile(RequestContext context, String locatorName) throws ProfilerException
context
- The request contextlocatorName
- The name of the profile locator to find i.e. "page", "docset", ...
ProfilerException
public ProfileLocator getDefaultProfile(RequestContext context, String locatorName) throws ProfilerException
getDefaultProfile
Intstead of using the princpal found within the request, the DEFAULT_RULE_PRINCIPAL is used.
context
- The request contextlocatorName
- The name of the profile locator to find i.e. "page", "docset", ...
ProfilerException
public ProfileLocator getProfile(RequestContext context, ProfilingRule rule) throws ProfilerException
context
- The request context
ProfilerException
public ProfileLocator createLocator(RequestContext context)
context
- The request context
public ProfilingRule getRuleForPrincipal(Principal principal, String locatorName)
principal
- Lookup the profiling rule based on this principal.locatorName
- the unique name of a locator for this principal/rule/locator
public void setRuleForPrincipal(Principal principal, ProfilingRule rule, String locatorName)
principal
- Lookup the profiling rule based on this principal.locatorName
- the unique name of a locator for this principal/rule/locatorpublic ProfilingRule getDefaultRule()
public Collection getRules()
public ProfilingRule getRule(String id)
id
-
public String[] getLocatorNamesForPrincipal(Principal principal)
principal
- The given principal.
public Collection getRulesForPrincipal(Principal principal)
principal
- The given principal.
public Map getProfileLocators(RequestContext context, Principal principal) throws ProfilerException
context
- principal
-
ProfilerException
public Map getDefaultProfileLocators(RequestContext context) throws ProfilerException
getDefaultProfileLocators
Gets all the supported locators for the DEFAULT_RULE_PRINCIPAL
context
-
ProfilerException
public void storeProfilingRule(ProfilingRule rule) throws ProfilerException
ProfilerException
public void deleteProfilingRule(ProfilingRule rule) throws ProfilerException
ProfilerException
public void storePrincipalRule(PrincipalRule rule) throws ProfilerException
ProfilerException
public void deletePrincipalRule(PrincipalRule rule) throws ProfilerException
ProfilerException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |