org.apache.jetspeed.services.profiler
Interface ProfilerService

All Superinterfaces:
org.apache.turbine.services.Initable, org.apache.turbine.services.Service
All Known Implementing Classes:
JetspeedProfilerService

public interface ProfilerService
extends org.apache.turbine.services.Service

This interface is a facade for all profile related operations

Version:
$Id: ProfilerService.java,v 1.18 2004/02/23 03:35:24 jford Exp $
Author:
David Sean Taylor, Mark Orciuch
See Also:
Profile

Field Summary
static java.lang.String SERVICE_NAME
          The name of this service
 
Method Summary
 ProfileLocator createLocator()
          Creates a new ProfileLocator object that can be successfully managed by the current Profiler implementation
 Profile createProfile()
          Creates a new Profile object that can be successfully managed by the current Profiler implementation
 Profile createProfile(ProfileLocator locator)
          Creates a new Profile object for a specific locator.
 Profile createProfile(ProfileLocator locator, Portlets portlets)
          Create a new profile.
 Profile createProfile(org.apache.turbine.util.RunData data, Profile profile)
          Create a new profile.
 Profile createProfile(org.apache.turbine.util.RunData data, Profile profile, MimeType mt)
          Create a new profile.
 Profile getProfile(ProfileLocator locator)
          get the Profile object using a profile locator
 Profile getProfile(org.apache.turbine.util.RunData rundata)
          get the Profile object using the Rundata state and capability map this is the mapping functionality of the profiler
 Profile getProfile(org.apache.turbine.util.RunData rundata, CapabilityMap cm)
          get the Profile object using the Rundata state and capability map this is the mapping functionality of the profiler
 Profile getProfile(org.apache.turbine.util.RunData data, MimeType mt)
          Deprecated. Do not use a profiler method based on MimeType
 org.apache.turbine.util.DynamicURI makeDynamicURI(org.apache.turbine.util.RunData data, ProfileLocator locator)
          Creates a dynamic URI
 java.util.Iterator query(QueryLocator locator)
          Query for a collection of profiles given a profile locator criteria.
 void removeProfile(ProfileLocator locator)
          Removes a profile.
 boolean useRoleProfileMerging()
          Returns status of role profile merging feature
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
The name of this service

See Also:
Constant Field Values
Method Detail

getProfile

public Profile getProfile(org.apache.turbine.util.RunData rundata,
                          CapabilityMap cm)
                   throws ProfileException
get the Profile object using the Rundata state and capability map this is the mapping functionality of the profiler

Parameters:
rundata - The rundata object for the current request.
cm - The device capability map.
Returns:
A Profile object if found by the manager or null.
Throws:
ProfileException

getProfile

public Profile getProfile(org.apache.turbine.util.RunData rundata)
                   throws ProfileException
get the Profile object using the Rundata state and capability map this is the mapping functionality of the profiler

Parameters:
rundata - The rundata object for the current request.
Returns:
A new Profile object.
Throws:
ProfileException

getProfile

public Profile getProfile(org.apache.turbine.util.RunData data,
                          MimeType mt)
                   throws ProfileException
Deprecated. Do not use a profiler method based on MimeType

get the Profile object using the Rundata state and capability map this is the mapping functionality of the profiler

Returns:
a new Profile object
Throws:
ProfileException

getProfile

public Profile getProfile(ProfileLocator locator)
                   throws ProfileException
get the Profile object using a profile locator

Parameters:
locator - The locator containing criteria describing the profile.
Returns:
a new Profile object
Throws:
ProfileException

makeDynamicURI

public org.apache.turbine.util.DynamicURI makeDynamicURI(org.apache.turbine.util.RunData data,
                                                         ProfileLocator locator)
                                                  throws ProfileException
Creates a dynamic URI

Parameters:
locator - The description of the profile.
Returns:
A new dynamic URI representing all profile parameters from the locator.
Throws:
ProfileException

createProfile

public Profile createProfile()
Creates a new Profile object that can be successfully managed by the current Profiler implementation

Returns:
A new Profile object

createProfile

public Profile createProfile(ProfileLocator locator)
Creates a new Profile object for a specific locator.

Parameters:
locator - The description of the profile.
Returns:
A new Profile object

createLocator

public ProfileLocator createLocator()
Creates a new ProfileLocator object that can be successfully managed by the current Profiler implementation

Returns:
A new ProfileLocator object

createProfile

public Profile createProfile(org.apache.turbine.util.RunData data,
                             Profile profile)
                      throws ProfileException
Create a new profile. The profile parameter's document will be cloned.

Parameters:
profile - The description of the new profile to be created.
Returns:
The newly created profile.
Throws:
ProfileException

createProfile

public Profile createProfile(org.apache.turbine.util.RunData data,
                             Profile profile,
                             MimeType mt)
                      throws ProfileException
Create a new profile.

Parameters:
profile - The description of the new profile to be created.
mt - The specific mime type, which is converted to a mediatype.
Returns:
The newly created profile.
Throws:
ProfileException

createProfile

public Profile createProfile(ProfileLocator locator,
                             Portlets portlets)
                      throws ProfileException
Create a new profile.

Parameters:
locator - The description of the new profile to be created.
portlets - The PSML tree
Throws:
ProfileException

removeProfile

public void removeProfile(ProfileLocator locator)
                   throws ProfileException
Removes a profile.

Parameters:
locator - The profile locator criteria.
Throws:
ProfileException

query

public java.util.Iterator query(QueryLocator locator)
Query for a collection of profiles given a profile locator criteria.

Parameters:
locator - The profile locator criteria.
Returns:
The list of profiles matching the locator criteria.

useRoleProfileMerging

public boolean useRoleProfileMerging()
Returns status of role profile merging feature

Returns:
True if role profile merging is active


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.