PropertySetManager Interface

com.bea.p13n.controls.ejb.property
PropertySetManager Interface

public interface PropertySetManager

    extends Control

PropertySetManager is a stateless session bean that provides access to property sets, through PropertySetRepositories. It also provides translation between XML and property set objects for use in the data synchronization framework.

This control has been deprecated. Instead, use the ProfileControl to get an instance of the PropertySetManager associated with that profile manager, and use the API directly on the PropertySetManager.

The PropertySetManager EJB will maintain a mapping of property set types to property set repositories so that the appropriate repository will be queried when a PropertySet is requested.

To define a property set type to repository class mapping, create an entry in the PropertySetManager's deployment descriptor that follows this pattern:

   <env-entry>
     <env-entry-name>repository/USER</env-entry-name>
     <env-entry-type>java.lang.String</env-entry-type>
     <env-entry-value>com.bea.p13n.platform.property.internal.PropertySetRepositoryImpl</env-entry-value>
   </env-entry>
 

Related Topics

PropertySetManager
PropertySet
PropertySetRepository


All Superinterfaces
Control, Control, Serializable

Method Summary

public PropertySet
getPropertySet(String type, String name)
Get the PropertySet identified by the given type and name
public Map
getPropertySets(String type)
Get all PropertySets of a given type
public String
getPropertySetXml(String type, String name)
Retrieve the XML representation of a property set

Method Detail

getPropertySet(String, String) Method

DEPRECATED Use the ProfileControl to get the PropertySetManager associated with that profile manager and call the methods directly on the PropertySetManager.

public PropertySet getPropertySet(String type, 
                                  String name)
throws P13nControlException
Get the PropertySet identified by the given type and name

Parameters

type
provides the mapping of a property set type (eg, USER) with its data repository. See javadocs above.
name
the name of the PropertySet

Returns

the PropertySet, or null if it is not found

Exceptions

P13nControlException
if remote errors occurr while accessing the PropertySetManager EJB

getPropertySets(String) Method

DEPRECATED Use the ProfileControl to get the PropertySetManager associated with that profile manager and call the methods directly on the PropertySetManager

public Map getPropertySets(String type)
throws P13nControlException
Get all PropertySets of a given type

Parameters

type
provides the mapping of a property set type (eg, USER) with its data repository See javadocs above.

Returns

a map of name, PropertySet object pairs, or null if none are defined

Exceptions

P13nControlException
if remote errors occurr while accessing the PropertySetManager EJB

getPropertySetXml(String, String) Method

DEPRECATED Use the ProfileControl to get the PropertySetManager associated with that profile manager and call the methods directly on the PropertySetManager

public String getPropertySetXml(String type, 
                                String name)
throws P13nControlException
Retrieve the XML representation of a property set

Parameters

type
provides the mapping of a property set type (eg, USER) with its data repository See javadocs above.
name
the name of the PropertySet to retrieve

Returns

the XML representation of that PropertySet

Exceptions

P13nControlException
if remote errors occurr while accessing the PropertySetManager EJB