com.mf.roundhouse.portal.domain
Class PortletPreferencesImpl

java.lang.Object
  KennewickObject
      com.mf.roundhouse.core.domain.RoundhouseObject
          com.mf.roundhouse.portal.domain.PortletPreferencesImpl

All Implemented Interfaces:

PortletPreferences, java.io.Serializable

public class PortletPreferencesImpl

extends RoundhouseObject

implements PortletPreferences

Represents system, user or group level portlet preferences.

See Also:

Serialized Form

Field Summary

static java.lang.String	OWNER_GROUP_ID
static java.lang.String	OWNER_USER_ID
static java.lang.String	PORTLET_DEFINITION_ID
static java.lang.String	PREFERENCES

Constructor Summary

PortletPreferencesImpl()

PortletPreferencesImpl(ObjectIdentifier anId)

Method Summary

void	addPreference(PortletPreference pref)
java.util.Map	getMap() Returns a Map of the preferences.
java.util.Enumeration	getNames() Returns all of the keys that have an associated value, or an empty Enumeration if no keys are available.
ObjectIdentifier	getOwnerGroupId()
ObjectIdentifier	getOwnerUserId()
PortletDefinition	getPortletDefinition()
ObjectIdentifier	getPortletDefinitionId()
PortletPreference	getPreference(java.lang.String key)
java.util.Map	getPreferences()
java.security.Principal	getRuntimePrincipal()
java.lang.String	getValue(java.lang.String key, java.lang.String def) Returns the first String value associated with the specified key of this preference.
java.lang.String[]	getValues(java.lang.String key, java.lang.String[] def) Returns the String array value associated with the specified key in this preference.
boolean	isReadOnly(java.lang.String key) Returns true, if the value of this key cannot be modified by the user.
void	reset(java.lang.String key) Resets or removes the value associated with the specified key.
void	setOwnerGroupId(ObjectIdentifier identifier)
void	setOwnerUserId(ObjectIdentifier identifier)
void	setPortletDefinitionId(ObjectIdentifier identifier)
void	setPreferences(java.util.Map prefMap)
void	setRuntimePrincipal(java.security.Principal principal)
void	setValue(java.lang.String key, java.lang.String value) Associates the specified String value with the specified key in this preference.
void	setValues(java.lang.String key, java.lang.String[] values) Associates the specified String array value with the specified key in this preference.
void	store() Commits all changes made to the preferences via the set methods in the persistent store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFERENCES

public static final java.lang.String PREFERENCES

See Also:

Constant Field Values

OWNER_GROUP_ID

public static final java.lang.String OWNER_GROUP_ID

See Also:

Constant Field Values

OWNER_USER_ID

public static final java.lang.String OWNER_USER_ID

See Also:

Constant Field Values

PORTLET_DEFINITION_ID

public static final java.lang.String PORTLET_DEFINITION_ID

See Also:

Constant Field Values

Constructor Detail

PortletPreferencesImpl

public PortletPreferencesImpl(ObjectIdentifier anId)
                       throws java.lang.Exception

Parameters:

anId -

Throws:

java.lang.Exception

PortletPreferencesImpl

public PortletPreferencesImpl()

Method Detail

getNames

public java.util.Enumeration getNames()

Description copied from interface: PortletPreferences

Returns all of the keys that have an associated value, or an empty Enumeration if no keys are available.

Specified by:

getNames in interface PortletPreferences

Returns:

an Enumeration of the keys that have an associated value, or an empty Enumeration if no keys are available.

getValue

public java.lang.String getValue(java.lang.String key,
                                 java.lang.String def)

Description copied from interface: PortletPreferences

Returns the first String value associated with the specified key of this preference. If there is one or more preference values associated with the given key it returns the first associated value. If there are no preference values associated with the given key, or the backing preference database is unavailable, it returns the given default value.

Specified by:

getValue in interface PortletPreferences

Parameters:

key - key for which the associated value is to be returned

def - the value to be returned in the event that there is no value available associated with this key.

Returns:

the value associated with key, or def if no value is associated with key, or the backing store is inaccessible.

See Also:

PortletPreferences.getValues(String, String[])

getValues

public java.lang.String[] getValues(java.lang.String key,
                                    java.lang.String[] def)

Description copied from interface: PortletPreferences

Returns the String array value associated with the specified key in this preference.

Returns the specified default if there is no value associated with the key, or if the backing store is inaccessible.

If the implementation supports stored defaults and such a default exists and is accessible, it is used in favor of the specified default.

Specified by:

getValues in interface PortletPreferences

Parameters:

key - key for which associated value is to be returned.

def - the value to be returned in the event that this preference node has no value associated with key or the associated value cannot be interpreted as a String array, or the backing store is inaccessible.

Returns:

the String array value associated with key, or def if the associated value does not exist.

See Also:

PortletPreferences.getValue(String,String)

getPreference

public PortletPreference getPreference(java.lang.String key)

isReadOnly

public boolean isReadOnly(java.lang.String key)

Description copied from interface: PortletPreferences

Returns true, if the value of this key cannot be modified by the user.

Modifiable preferences can be changed by the portlet in any standard portlet mode (EDIT, HELP, VIEW). Per default every preference is modifiable.

Read-only preferences cannot be changed by the portlet in any standard portlet mode, but inside of custom modes it may be allowed changing them. Preferences are read-only, if they are defined in the deployment descriptor with read-only set to true, or if the portlet container restricts write access.

Specified by:

isReadOnly in interface PortletPreferences

Returns:

false, if the value of this key can be changed, or if the key is not known

reset

public void reset(java.lang.String key)
           throws ReadOnlyException

Description copied from interface: PortletPreferences

Resets or removes the value associated with the specified key.

If this implementation supports stored defaults, and there is such a default for the specified preference, the given key will be reset to the stored default.

If there is no default available the key will be removed.

Specified by:

reset in interface PortletPreferences

Parameters:

key - to reset

Throws:

ReadOnlyException - if this preference cannot be modified for this request

setValue

public void setValue(java.lang.String key,
                     java.lang.String value)
              throws ReadOnlyException

Description copied from interface: PortletPreferences

Associates the specified String value with the specified key in this preference.

The key cannot be null, but null values for the value parameter are allowed.

Specified by:

setValue in interface PortletPreferences

Parameters:

key - key with which the specified value is to be associated.

value - value to be associated with the specified key.

Throws:

ReadOnlyException - if this preference cannot be modified for this request

See Also:

PortletPreferences.setValues(String, String[])

setValues

public void setValues(java.lang.String key,
                      java.lang.String[] values)
               throws ReadOnlyException

Description copied from interface: PortletPreferences

Associates the specified String array value with the specified key in this preference.

The key cannot be null, but null values in the values parameter are allowed.

Specified by:

setValues in interface PortletPreferences

Parameters:

key - key with which the value is to be associated

values - values to be associated with key

Throws:

ReadOnlyException - if this preference cannot be modified for this request

See Also:

PortletPreferences.setValue(String,String)

store

public void store()
           throws java.io.IOException,
                  ValidatorException

Description copied from interface: PortletPreferences

Commits all changes made to the preferences via the set methods in the persistent store.

If this call returns succesfull, all changes are made persistent. If this call fails, no changes are made in the persistent store. This call is an atomic operation regardless of how many preference attributes have been modified.

All changes made to preferences not followed by a call to the store method are discarded when the portlet finishes the processAction method.

If a validator is defined for this preferences in the deployment descriptor, this validator is called before the actual store is performed to check wether the given preferences are vaild. If this check fails a ValidatorException is thrown.

Specified by:

store in interface PortletPreferences

Throws:

ValidatorException - if the validation performed by the associated validator fails

java.io.IOException - if changes cannot be written into the backend store

See Also:

PreferencesValidator

getOwnerGroupId

public ObjectIdentifier getOwnerGroupId()

Returns:

getPreferences

public java.util.Map getPreferences()

Returns:

setOwnerGroupId

public void setOwnerGroupId(ObjectIdentifier identifier)

Parameters:

identifier -

setPreferences

public void setPreferences(java.util.Map prefMap)

getOwnerUserId

public ObjectIdentifier getOwnerUserId()

Returns:

setOwnerUserId

public void setOwnerUserId(ObjectIdentifier identifier)

Parameters:

identifier -

getPortletDefinition

public PortletDefinition getPortletDefinition()
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getPortletDefinitionId

public ObjectIdentifier getPortletDefinitionId()

Returns:

setPortletDefinitionId

public void setPortletDefinitionId(ObjectIdentifier identifier)

Parameters:

identifier -

addPreference

public void addPreference(PortletPreference pref)

getRuntimePrincipal

public java.security.Principal getRuntimePrincipal()

Returns:

setRuntimePrincipal

public void setRuntimePrincipal(java.security.Principal principal)

Parameters:

principal -

getMap

public java.util.Map getMap()

Description copied from interface: PortletPreferences

Returns a Map of the preferences.

The values in the returned Map are from type String array (String[]).

If no preferences exist this method returns an empty Map.

Specified by:

getMap in interface PortletPreferences

Returns:

an immutable Map containing preference names as keys and preference values as map values, or an empty Map if no preference exist. The keys in the preference map are of type String. The values in the preference map are of type String array (String[]).