org.apache.jetspeed.profiler.rules
Interface PrincipalRule

All Superinterfaces:

java.io.Serializable

public interface PrincipalRule
extends java.io.Serializable

PrincipalRule is a paired association from principal to rule. This pair is unique in that there can only be a one entry for a principal which maps to a rule. This association is used by the profiler to determine which profiling rule to apply for a principal. If a rule is not found, there should be a default system wide rule.

Version:

$Id: PrincipalRule.java 516448 2007-03-09 16:25:47Z ate $

Author:

David Sean Taylor

Method Summary

java.lang.String	getLocatorName() Gets the name of the locator in this principal/rule/locator pair association.
java.lang.String	getPrincipalName() Gets the name of the principal in this principal/rule/locator pair association.
ProfilingRule	getProfilingRule() Gets the profiling rule associated with the principal name
void	setLocatorName(java.lang.String name) Sets the name of the locator in this principal/locator/rule pair association.
void	setPrincipalName(java.lang.String name) Sets the name of the principal in this principal/rule/locator pair association.
void	setProfilingRule(ProfilingRule rule) Sets the profiling rule associated with the principal name

Method Detail

getPrincipalName

java.lang.String getPrincipalName()

Gets the name of the principal in this principal/rule/locator pair association. The principal name identifies the uniqueness of the relationship. It is used for keyed lookups to find the rule associated with this principal.

Returns:

The name of the principal in this association.

setPrincipalName

void setPrincipalName(java.lang.String name)

Sets the name of the principal in this principal/rule/locator pair association. The principal name identifies the uniqueness of the relationship. It is used for keyed lookups to find the rule associated with this principal.

Parameters:

name - The name of the principal in this association.

getLocatorName

java.lang.String getLocatorName()

Gets the name of the locator in this principal/rule/locator pair association. The principal + locator name identifies the uniqueness of the relationship. It is used for keyed lookups to find the rule associated with this principal for a given locator

Returns:

The name of the locator in this association.

setLocatorName

void setLocatorName(java.lang.String name)

Sets the name of the locator in this principal/locator/rule pair association. The principal name + locator name identifies the uniqueness of the relationship. It is used for keyed lookups to find the rule associated with this principal for a given locator

Parameters:

name - The name of the locator in this association.

getProfilingRule

ProfilingRule getProfilingRule()

Gets the profiling rule associated with the principal name

Returns:

The profiling rule associated with the principal name

setProfilingRule

void setProfilingRule(ProfilingRule rule)

Sets the profiling rule associated with the principal name

Parameters:

rule - The profiling rule associated with the principal name