|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.portal.provider.v2.personalize.PortletPersonalizationManager oracle.portal.provider.v2.personalize.PrefStorePersonalizationManager
public class PrefStorePersonalizationManager
The PrefStorePersonalizationManager
class implements a
PortletPersonalizationManager
using a PreferenceStore
to persist customized data objects.
The class of the data objects managed by a
PrefStorePersonalizationManager
is registered using PortletPersonalizationManager.setDataClass(String)
. Most commonly this will be the result of a
declaration in the provider XML registry (e.g.
<dataClass>className</dataClass>
). For maximum
extensibility, it is recommended that you use NameValuePersonalizationObject
as a basis for your data class.
Constructor Summary | |
---|---|
PrefStorePersonalizationManager()
Null Constructor |
Method Summary | |
---|---|
void |
copy(PortletReference from,
PortletReference to,
ProviderUser user)
Copies the instance customizations from one reference to another. |
void |
create(PortletReference ref,
PersonalizationObject o,
ProviderUser user)
Creates the initial personalization reference for this (new) PortletReference. |
void |
create(PortletReference ref,
ProviderUser user)
Creates the initial personalization reference for this (new) PortletReference and establishes its (static) defaults. |
void |
destroy(PortletReference ref,
ProviderUser user)
Destroys a given Portlet instance from the repository by reference. |
void |
destroy(ProviderInstance provider,
PortletDefinition pd)
Called to allow the Portlet Personalization manager to destroy its repository. |
boolean |
exists(PortletReference ref,
ProviderUser user)
Returns true if a customization exists for this given reference. |
void |
init(PortletDefinition p)
Initializes the repository for this PrefStorePersonalizationManager . |
void |
postInitialize()
Performs any extra steps required to initialize and validate this application object once its child application objects have been created. |
void |
preInitialize(java.lang.Object parent)
Performs any steps required to initialize this application object after it has been created, perhaps relating this object to its parent. |
PersonalizationObject |
read(PortletReference ref,
ProviderUser user)
Returns a data object containing the customizations particular to this reference. |
void |
validate(java.lang.String context,
ValidationError errors)
Validates the internal state of this PrefStorePersonalizationManager instance. |
void |
write(PortletReference ref,
PersonalizationObject o,
ProviderUser user)
Updates this reference's customization using the passed data object. |
Methods inherited from class oracle.portal.provider.v2.personalize.PortletPersonalizationManager |
---|
getDataClass, setDataClass |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrefStorePersonalizationManager() throws PersonalizationException
PersonalizationException
Method Detail |
---|
public void preInitialize(java.lang.Object parent) throws NodeHandlerException
InitializableXMLObject
preInitialize
in interface InitializableXMLObject
parent
- the application object that will become this object's parent
NodeHandlerException
- if an error occurs while initializing
this application objectpublic void postInitialize() throws NodeHandlerException
InitializableXMLObject
postInitialize
in interface InitializableXMLObject
NodeHandlerException
- if an error occurs while initializing or
validating this application objectpublic void init(PortletDefinition p)
PrefStorePersonalizationManager
. This method is invoked on
each of a Provider's PortletPersonalizationManagers whenever the
Provider is registered on a Portal Node (when the Provider's
register()
method is called). This gives the
personalization manager an opportunity to initialize the repository for
the corresponding Portlet.
The PrefStorePersonalizationManager
currently does nothing
in response to this call.
init
in class PortletPersonalizationManager
p
- the portlet this PrefStorePersonalizationManager
is controlling.public void destroy(ProviderInstance provider, PortletDefinition pd) throws AccessControlException, java.io.IOException
In response to this call, the
PrefStorePersonalizationManager
uses PreferenceStore.destroy(String,List)
to remove all the portlet
customization data for this Portlet.
destroy
in class PortletPersonalizationManager
pd
- definition of the portlet this PortletPersonalizationManager
is controlling.provider
- the provider instance that is being deregistered.
AccessControlException
java.io.IOException
public void create(PortletReference ref, ProviderUser user) throws java.io.IOException, PortletAlreadyExistsException, AccessControlException
In response to this call, the
PrefStorePersonalizationManager
creates a new instance of
the data object class that is registered to it, and calls its
init()
method to initialize it with the appropriate
defaults. Finally, the default data is written to the PreferenceStore
to ensure it persists.
create
in class PortletPersonalizationManager
ref
- the PortletReference. The details of the PortletReference
determine whether this creates the default, system instance or a specific
user instance.user
- the user attempting this operation. The manager is expected
to authorize the user before completing this operation.
java.io.IOException
PortletAlreadyExistsException
AccessControlException
public void create(PortletReference ref, PersonalizationObject o, ProviderUser user) throws PortletAlreadyExistsException, AccessControlException, java.io.IOException
In response to this call, the
PrefStorePersonalizationManager
saves the passed object to
the PreferenceStore
, ensuring the initial data persists.
create
in class PortletPersonalizationManager
ref
- the PortletReference. The details of the PortletReference
determine whether this creates the default, system instance or a specific
user instance.o
- the Object representing the initial values for this instance
(should implement PersonalizationObject
).user
- the user attempting this operation. The manager is expected
to authorize the user before completing this operation.
PortletAlreadyExistsException
AccessControlException
java.io.IOException
public boolean exists(PortletReference ref, ProviderUser user) throws AccessControlException, java.io.IOException
exists
in class PortletPersonalizationManager
ref
- the portlet instance to checkuser
- the user making this request -- passed to give the manager access
to the session.
AccessControlException
java.io.IOException
public PersonalizationObject read(PortletReference ref, ProviderUser user) throws AccessControlException, java.io.IOException
PortletNotFoundException
is thrown.
read
in class PortletPersonalizationManager
ref
- the portlet reference that identifies the instance whose
customizations are being requested.user
- the user attempting this operation. The manager is expected
to authorize the user before completing this operation.
setDataClass
) containing the customizations particular to
this reference
AccessControlException
java.io.IOException
public void write(PortletReference ref, PersonalizationObject o, ProviderUser user) throws AccessControlException, java.io.IOException
write
in class PortletPersonalizationManager
ref
- the portlet reference that identifies the instance whose
customizations are being updated.o
- the data object containing the new values (should implement
PersonalizationObject
).user
- the user attempting this operation. The manager is expected
to authorize the user before completing this operation.
AccessControlException
java.io.IOException
public void destroy(PortletReference ref, ProviderUser user) throws PortletNotFoundException, AccessControlException, java.io.IOException
destroy
in class PortletPersonalizationManager
ref
- the portlet reference that identifies the instance whose
customizations are being deleted.user
- the user attempting this operation. The manager is expected
to authorize the user before completing this operation.
PortletNotFoundException
AccessControlException
java.io.IOException
public void copy(PortletReference from, PortletReference to, ProviderUser user) throws PortletNotFoundException, AccessControlException, java.io.IOException
copy
in class PortletPersonalizationManager
from
- reference for the portlet instance we are copying from.to
- reference for the portlet instance we are copying to.user
- the user attempting this operation. The manager is expected
to authorize the user before completing this operation.
PortletNotFoundException
AccessControlException
java.io.IOException
public void validate(java.lang.String context, ValidationError errors)
PrefStorePersonalizationManager
instance. Errors found are
reported using the supplied ValidationError
instance.
validate
in interface Validateable
validate
in class PortletPersonalizationManager
context
- The context of the calling instance.errors
- The current list of errors.
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |