|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProfileLocator
Profile Locators are used to locate profiled portal resources such as pages, documents, and fragments. A locator contains properties describing the actually resource to be located. Since the locator is based on properties that are usually related to a user or other subject's profile, it is referred to as a profile locator.
Profiles can be created from a normalized Profile Locator Path The format of the path is name/value pairs of all property, separated by a path separator. An example locator path:
page:default.psml:artist:al-stewart:song:on-the-border
path:/sports/football/nfl/chiefs:language:en
Field Summary | |
---|---|
static java.lang.String |
PAGE_LOCATOR
|
static java.lang.String |
PATH_SEPARATOR
|
static java.lang.String |
SECURITY_LOCATOR
|
Method Summary | |
---|---|
void |
add(RuleCriterion criterion,
boolean isControl,
boolean isNavigation,
java.lang.String value)
Add a property based on a @link org.apache.jetspeed.profiler.rules.RuleCriterion and a value. |
void |
add(java.lang.String name,
boolean isControl,
boolean isNavigation,
java.lang.String value)
Add a property based on a Simple name and value. |
void |
add(java.lang.String name,
java.lang.String value)
Add a property based on a Simple name and value assumed to be control property. |
void |
createFromLocatorPath(java.lang.String path)
Profiles can be created from a normalized Profile Locator Path The format of the path is name:value pairs of all property, separated by a path separator. |
java.lang.String |
getLocatorPath()
Profiles can be converted to a normalized Profile Locator Path The format of the path is name/value pairs of all property, separated by a path separator. |
java.lang.String |
getLocatorPath(ProfileLocatorProperty[] properties)
Normalize profile properties obtained from profile locator iterators into a Profile Locator Path. |
java.lang.String |
getRequestPath()
Locators are intended to be sufficient to locate managed pages, so the request path must be generally available in the event it is not otherwise captured in a rule criterion. |
java.lang.String |
getRequestServerName()
Retain the request server name to support additional page location mapping not part of the profiler rule criterion. |
java.lang.String |
getValue(java.lang.String name)
For a given property name, get a property of type @link ProfileLocatorProperty |
void |
init(Profiler profiler,
java.lang.String requestPath)
Initialize this page context. |
void |
init(Profiler profiler,
java.lang.String requestPath,
java.lang.String requestServerName)
Initialize this page context. |
boolean |
isControl(java.lang.String name)
For a given property name, return control status of property. |
boolean |
isNavigation(java.lang.String name)
For a given property name, return navigation status of property. |
java.util.Iterator |
iterator()
Get an iterator over the locator's properties. |
java.lang.String |
toString()
Returns a normalized path. |
Field Detail |
---|
static final java.lang.String PAGE_LOCATOR
static final java.lang.String SECURITY_LOCATOR
static final java.lang.String PATH_SEPARATOR
Method Detail |
---|
void init(Profiler profiler, java.lang.String requestPath)
profiler
- The profiler initializing this locator.requestPath
- The request path used to create this locator.void init(Profiler profiler, java.lang.String requestPath, java.lang.String requestServerName)
profiler
- The profiler initializing this locator.requestPath
- The request path used to create this locator.requestServerName
- The request server name used to create this locator.java.util.Iterator iterator()
void add(RuleCriterion criterion, boolean isControl, boolean isNavigation, java.lang.String value)
criterion
- The rule criterion on which this property is based.isControl
- The control classification for property.isNavigation
- The navigation classification for property.value
- The value to set on the property.void add(java.lang.String name, boolean isControl, boolean isNavigation, java.lang.String value)
name
- The name of the property.isControl
- The control classification for property.isNavigation
- The control classification for property.value
- The value to set on the property.void add(java.lang.String name, java.lang.String value)
name
- The name of the property.value
- The value to set on the property.java.lang.String getValue(java.lang.String name)
name
- The name of the property
boolean isControl(java.lang.String name)
name
- The name of the property
boolean isNavigation(java.lang.String name)
name
- The name of the property
void createFromLocatorPath(java.lang.String path)
Profiles can be created from a normalized Profile Locator Path The format of the path is name:value pairs of all property, separated by a path separator. Note: all locator property elements are assumed to be control properties. An example locator path:
:page:default.psml:artist:air:song:all-i-need
path
- The normalized path as shown above from which the locator is created.java.lang.String getLocatorPath()
Profiles can be converted to a normalized Profile Locator Path The format of the path is name/value pairs of all property, separated by a path separator. An example locator path:
:page:default.psml:artist:joni-mitchell:song:cary
java.lang.String getLocatorPath(ProfileLocatorProperty[] properties)
Normalize profile properties obtained from profile locator iterators into a Profile Locator Path.
properties
- The array of profile properties.
java.lang.String toString()
toString
in class java.lang.Object
java.lang.String getRequestPath()
Locators are intended to be sufficient to locate managed pages, so the request path must be generally available in the event it is not otherwise captured in a rule criterion.
java.lang.String getRequestServerName()
Retain the request server name to support additional page location mapping not part of the profiler rule criterion.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |