org.apache.jetspeed.profiler

Interface Profiler

public interface Profiler

The Jetspeed Profiler is a portal resource location rule-based engine. The profiler locates the following kinds of portal resources:

• PSML pages
• Folders
• Menus
• Links

When a request is received by the portal, the profiler will compute a normalized instruction set, known as a profile locator ProfileLocator. The locator is then added to the request context RequestContext, from which subsequent components on the Jetspeed pipeline, most notably the Page Manager PageManager and Portal Site PortalSite components, can take the profile locator and use it to find a requested resource. For example, the Page Manager uses the locator to find a page or folder. The Portal Site component uses the locator build the options on a menu. The profile locator is the output from the profiler. The input is a normalized set of runtime parameters and state. The profiler input is defined in profiling rules ProfilingRule, and can be made of any Java class available on the pipeline. Jetspeed comes with quite a few predefined rules for taking criteria RuleCriterion RuleCriterionResolver from request parameters, HTTP headers, security information, language and session attributes. The profiler is invoked during the request processing pipeline Pipeline in the profiler valve Valve.

Version:

$Id: Profiler.java 1510080 2013-08-03 23:35:19Z taylor $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
ProfileLocator	createLocator(RequestContext context) Creates a new ProfileLocator object that can be managed by the current Profiler implementation
PrincipalRule	createPrincipalRule() Factory for PrincipalRule, the container to connect profiling rule and (user) principals Replaces the previous Class.forName and .instantiate logic with the Spring based factory.
ProfilingRule	createProfilingRule(boolean standard) Factory for creating Profiling Rules.
RuleCriterion	createRuleCriterion() Factory for creating Rule Criterion
void	deletePrincipalRule(PrincipalRule rule)
void	deleteProfilingRule(ProfilingRule rule)
ProfileLocator	getDefaultProfile(RequestContext context, String locatorName) Retrieve the default profile locator ProfileLocator for the given runtime parameters represented in the request context and for the locatorName.
Map<String,ProfileLocator>	getDefaultProfileLocators(RequestContext context) Retrieves a map of all default locators, mapping locator name to profile locator
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) Retrieve a profile locator ProfileLocator for the given runtime parameters represented in the request context and for the provided ProfilingRule.
ProfileLocator	getProfile(RequestContext context, String locatorName) Retrieve a profile locator ProfileLocator for the given runtime parameters represented in the request context and for the locatorName.
Map<String,ProfileLocator>	getProfileLocators(RequestContext context, Principal principal) Retrieves a map of all supported locators for a principal, mapping locator name to profile locator
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<ProfilingRule>	getRules() Retrieves all profiling rules
Collection<PrincipalRule>	getRulesForPrincipal(Principal principal) For a given principal, find all supported locators and return a collection of principal rules.
void	setDefaultRule(String defaultRule) Resets the default rule for this portal
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

getProfile

ProfileLocator getProfile(RequestContext context,
                        String locatorName)
                          throws ProfilerException

Retrieve a profile locator ProfileLocator for the given runtime parameters represented in the request context and for the locatorName. Commonly used locator names are:

• To locate a page - ProfileLocator.PAGE_LOCATOR
• To locate a security redirect page - ProfileLocator.SECURITY_LOCATOR

The algorithm for this method looks up a ProfilingRule for the current user on the request context and for the locator name. That rule is then applied to return a normalized profile. The profile locator holds the normalized set of rules that are used further in the pipeline to locate the resource to be retrieved and rendered.

Parameters:

context - the request context holding runtime request parameters to be normalized

locatorName - the commonly known name of the profile locator such as ProfileLocator.PAGE_LOCATOR

Returns:

a new ProfileLocator object or null if failed to find a appropriate locator.

Throws:

ProfilerException

See Also:

ProfilingRule.apply(org.apache.jetspeed.request.RequestContext, Profiler)

getDefaultProfile

ProfileLocator getDefaultProfile(RequestContext context,
                               String locatorName)
                                 throws ProfilerException

Retrieve the default profile locator ProfileLocator for the given runtime parameters represented in the request context and for the locatorName. Differs from getProfile(org.apache.jetspeed.request.RequestContext, java.lang.String) in that instead of using the user principal found within the request context's subject, a default, global principal is used. Commonly used locator names are:

• To locate a page - ProfileLocator.PAGE_LOCATOR
• To locate a security redirect page - ProfileLocator.SECURITY_LOCATOR

The algorithm for this method looks up a ProfilingRule for the default principal and for the locator name. That rule is then applied to return a normalized profile. The profile locator holds the normalized set of rules that are used further in the pipeline to locate the resource to be retrieved and rendered.

Parameters:

context - the request context holding runtime request parameters to be normalized

locatorName - the commonly known name of the profile locator such as ProfileLocator.PAGE_LOCATOR

Returns:

a new object or null if failed to find a appropriate locator.

Throws:

ProfilerException

See Also:

ProfilingRule.apply(org.apache.jetspeed.request.RequestContext, Profiler)

getProfile

ProfileLocator getProfile(RequestContext context,
                        ProfilingRule rule)
                          throws ProfilerException

Retrieve a profile locator ProfileLocator for the given runtime parameters represented in the request context and for the provided ProfilingRule.

The algorithm for this method takes the ProfilingRule directly and applies that rule to return a normalized profile. The profile locator holds the normalized set of rules that are used further in the pipeline to locate the resource to be retrieved and rendered.

Parameters:

context - The request context holding runtime request parameters to be normalized

rule - The ProfilingRule to apply and find a ProfileLocator

Returns:

a new ProfileLocator object or null if failed to find a appropriate locator.

Throws:

ProfilerException

See Also:

ProfilingRule.apply(org.apache.jetspeed.request.RequestContext, Profiler)

createLocator

ProfileLocator createLocator(RequestContext context)

Creates a new ProfileLocator object that can be managed by the current Profiler implementation

Parameters:

context - The request context containing runtime parameters to determine which locator to create

Returns:

A new ProfileLocator object

getRuleForPrincipal

ProfilingRule getRuleForPrincipal(Principal principal,
                                String locatorName)

For a given principal, lookup the associated profiling rule to that principal name.

Parameters:

principal - Lookup the profiling rule based on this principal

locatorName - the unique name of a locator for this principal/rule/locator

Returns:

The rule found or null if not found

setRuleForPrincipal

void setRuleForPrincipal(Principal principal,
                       ProfilingRule rule,
                       String locatorName)

For a given principal, associate a profiling rule to that principal name.

Parameters:

principal - Lookup the profiling rule based on this principal.

rule - rule used to find profiles for this user

locatorName - the unique name of a locator for this principal/rule/locator

getDefaultRule

ProfilingRule getDefaultRule()

Lookup the portal's default profiling rule.

Returns:

The portal's default profiling rule.

getRules

Collection<ProfilingRule> getRules()

Retrieves all profiling rules

Returns:

a collection of all rules

getRule

ProfilingRule getRule(String id)

Given a rule id, get the rule

Parameters:

id -

Returns:

the rule associated the given id

getLocatorNamesForPrincipal

String[] getLocatorNamesForPrincipal(Principal principal)

For a given principal, find all supported locators and return a string array of locator names.

Parameters:

principal - The given principal.

Returns:

array of String locator names

getRulesForPrincipal

Collection<PrincipalRule> getRulesForPrincipal(Principal principal)

For a given principal, find all supported locators and return a collection of principal rules.

Parameters:

principal - The given principal such as a user principal

Returns:

collection of PrincipalRules

getProfileLocators

Map<String,ProfileLocator> getProfileLocators(RequestContext context,
                                            Principal principal)
                                              throws ProfilerException

Retrieves a map of all supported locators for a principal, mapping locator name to profile locator

Parameters:

context - the request context holding runtime request parameters to be normalized

principal - the given principal such a User Principal

Returns:

a map of locator names mapping to profile locators

Throws:

ProfilerException

getDefaultProfileLocators

Map<String,ProfileLocator> getDefaultProfileLocators(RequestContext context)
                                                     throws ProfilerException

Retrieves a map of all default locators, mapping locator name to profile locator

Parameters:

context - the request context holding runtime request parameters to be normalized

Returns:

a map of locator names mapping to profile locators

Throws:

ProfilerException

storeProfilingRule

void storeProfilingRule(ProfilingRule rule)
                        throws ProfilerException

Throws:

ProfilerException

deleteProfilingRule

void deleteProfilingRule(ProfilingRule rule)
                         throws ProfilerException

Throws:

ProfilerException

storePrincipalRule

void storePrincipalRule(PrincipalRule rule)
                        throws ProfilerException

Throws:

ProfilerException

deletePrincipalRule

void deletePrincipalRule(PrincipalRule rule)
                         throws ProfilerException

Throws:

ProfilerException

createProfilingRule

ProfilingRule createProfilingRule(boolean standard)
                                  throws ClassNotFoundException

Factory for creating Profiling Rules. The boolean argument specifies whether to obtain a new instance of a standard profiling rule or of a fallback rule.

Parameters:

standard - true if standard rule is requested, false if fallback

Returns:

New instance of a (standard or fallback) Profiling Rule

Throws:

ClassNotFoundException - if the bean factory couldn't instantiate the bean

createPrincipalRule

PrincipalRule createPrincipalRule()
                                  throws ClassNotFoundException

Factory for PrincipalRule, the container to connect profiling rule and (user) principals Replaces the previous Class.forName and .instantiate logic with the Spring based factory.

Returns:

New instance of a principal rule

Throws:

ClassNotFoundException - if the bean factory couldn't instantiate the bean

createRuleCriterion

RuleCriterion createRuleCriterion()
                                  throws ClassNotFoundException

Factory for creating Rule Criterion

Returns:

New instance of a rule criterion

Throws:

ClassNotFoundException - if the beanfactory couldn't instantiate the bean

setDefaultRule

void setDefaultRule(String defaultRule)

Resets the default rule for this portal

Parameters:

defaultRule - The name of the rule to set as default