com.liferay.portlet

Class PortletPreferencesFactoryImpl

java.lang.Object

com.liferay.portlet.PortletPreferencesFactoryImpl

All Implemented Interfaces:

com.liferay.portal.kernel.portlet.PortletPreferencesFactory

public class PortletPreferencesFactoryImpl
extends java.lang.Object
implements com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Author:

Brian Wing Shun Chan, Alexander Chow, Minhchau Dang, Raymond Augé

Constructor Summary

Constructors

Constructor and Description
PortletPreferencesFactoryImpl()

Method Summary

Modifier and Type	Method and Description
void	checkControlPanelPortletPreferences(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, com.liferay.portal.kernel.model.Portlet portlet)
static java.util.Map<java.lang.String,Preference>	createPreferencesMap(java.lang.String xml)
javax.portlet.PortletPreferences	fromDefaultXML(java.lang.String xml)
PortalPreferencesImpl	fromXML(long ownerId, int ownerType, java.lang.String xml)
PortletPreferencesImpl	fromXML(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId, java.lang.String xml)
javax.portlet.PortletPreferences	getExistingPortletSetup(com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId)
javax.portlet.PortletPreferences	getExistingPortletSetup(javax.portlet.PortletRequest portletRequest)
javax.portlet.PortletPreferences	getLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId)
javax.portlet.PortletPreferences	getLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId, java.lang.String defaultPreferences)
javax.portlet.PortletPreferences	getLayoutPortletSetup(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId, java.lang.String defaultPreferences)
com.liferay.portal.kernel.portlet.PortalPreferences	getPortalPreferences(javax.servlet.http.HttpServletRequest httpServletRequest)
com.liferay.portal.kernel.portlet.PortalPreferences	getPortalPreferences(javax.servlet.http.HttpSession httpSession, long userId, boolean signedIn)
com.liferay.portal.kernel.portlet.PortalPreferences	getPortalPreferences(long userId, boolean signedIn)
com.liferay.portal.kernel.portlet.PortalPreferences	getPortalPreferences(javax.portlet.PortletRequest portletRequest)
javax.portlet.PortletPreferences	getPortletPreferences(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId)
com.liferay.portal.kernel.model.PortletPreferencesIds	getPortletPreferencesIds(javax.servlet.http.HttpServletRequest httpServletRequest, com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId)
com.liferay.portal.kernel.model.PortletPreferencesIds	getPortletPreferencesIds(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId)
com.liferay.portal.kernel.model.PortletPreferencesIds	getPortletPreferencesIds(long siteGroupId, long userId, com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId, boolean modeEditGuest)
com.liferay.portal.kernel.model.PortletPreferencesIds	getPortletPreferencesIds(long companyId, long siteGroupId, long layoutGroupId, long plid, java.lang.String portletId)
com.liferay.portal.kernel.model.PortletPreferencesIds	getPortletPreferencesIds(long companyId, long siteGroupId, long plid, java.lang.String portletId, java.lang.String settingsScope)
javax.portlet.PortletPreferences	getPortletSetup(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId)
javax.portlet.PortletPreferences	getPortletSetup(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId, java.lang.String defaultPreferences)
javax.portlet.PortletPreferences	getPortletSetup(com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId, java.lang.String defaultPreferences)
javax.portlet.PortletPreferences	getPortletSetup(long siteGroupId, com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId, java.lang.String defaultPreferences)
protected javax.portlet.PortletPreferences	getPortletSetup(long companyId, long siteGroupId, long layoutGroupId, long plid, java.lang.String portletId, java.lang.String defaultPreferences, boolean strictMode)
javax.portlet.PortletPreferences	getPortletSetup(javax.portlet.PortletRequest portletRequest)
javax.portlet.PortletPreferences	getPortletSetup(javax.portlet.PortletRequest portletRequest, java.lang.String portletId)
java.util.Map<java.lang.Long,javax.portlet.PortletPreferences>	getPortletSetupMap(long companyId, long groupId, long ownerId, int ownerType, java.lang.String portletId, boolean privateLayout)
javax.portlet.PortletPreferences	getPreferences(javax.servlet.http.HttpServletRequest httpServletRequest)
javax.portlet.PreferencesValidator	getPreferencesValidator(com.liferay.portal.kernel.model.Portlet portlet)
javax.portlet.PortletPreferences	getStrictLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId)
javax.portlet.PortletPreferences	getStrictPortletSetup(com.liferay.portal.kernel.model.Layout layout, java.lang.String portletId)
javax.portlet.PortletPreferences	getStrictPortletSetup(long companyId, long groupId, java.lang.String portletId)
protected static Preference	readPreference(javax.xml.stream.XMLEventReader xmlEventReader)
StrictPortletPreferencesImpl	strictFromXML(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId, java.lang.String xml)
protected java.util.Map<java.lang.String,Preference>	toPreferencesMap(java.lang.String xml)
java.lang.String	toXML(com.liferay.portal.kernel.portlet.PortalPreferences portalPreferences)
java.lang.String	toXML(javax.portlet.PortletPreferences portletPreferences)

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletPreferencesFactoryImpl

public PortletPreferencesFactoryImpl()

Method Detail

createPreferencesMap

public static java.util.Map<java.lang.String,Preference> createPreferencesMap(java.lang.String xml)

checkControlPanelPortletPreferences

public void checkControlPanelPortletPreferences(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
                                                com.liferay.portal.kernel.model.Portlet portlet)
                                         throws com.liferay.portal.kernel.exception.PortalException

Specified by:

checkControlPanelPortletPreferences in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Throws:

com.liferay.portal.kernel.exception.PortalException

fromDefaultXML

public javax.portlet.PortletPreferences fromDefaultXML(java.lang.String xml)

Specified by:

fromDefaultXML in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

fromXML

public PortalPreferencesImpl fromXML(long ownerId,
                                     int ownerType,
                                     java.lang.String xml)

Specified by:

fromXML in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

fromXML

public PortletPreferencesImpl fromXML(long companyId,
                                      long ownerId,
                                      int ownerType,
                                      long plid,
                                      java.lang.String portletId,
                                      java.lang.String xml)

Specified by:

fromXML in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getExistingPortletSetup

public javax.portlet.PortletPreferences getExistingPortletSetup(com.liferay.portal.kernel.model.Layout layout,
                                                                java.lang.String portletId)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getExistingPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Throws:

com.liferay.portal.kernel.exception.PortalException

getExistingPortletSetup

public javax.portlet.PortletPreferences getExistingPortletSetup(javax.portlet.PortletRequest portletRequest)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getExistingPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Throws:

com.liferay.portal.kernel.exception.PortalException

getLayoutPortletSetup

public javax.portlet.PortletPreferences getLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout,
                                                              java.lang.String portletId)

Specified by:

getLayoutPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getLayoutPortletSetup

public javax.portlet.PortletPreferences getLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout,
                                                              java.lang.String portletId,
                                                              java.lang.String defaultPreferences)

Specified by:

getLayoutPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getLayoutPortletSetup

public javax.portlet.PortletPreferences getLayoutPortletSetup(long companyId,
                                                              long ownerId,
                                                              int ownerType,
                                                              long plid,
                                                              java.lang.String portletId,
                                                              java.lang.String defaultPreferences)

Specified by:

getLayoutPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortalPreferences

public com.liferay.portal.kernel.portlet.PortalPreferences getPortalPreferences(javax.servlet.http.HttpServletRequest httpServletRequest)

Specified by:

getPortalPreferences in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortalPreferences

public com.liferay.portal.kernel.portlet.PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession httpSession,
                                                                                long userId,
                                                                                boolean signedIn)

Specified by:

getPortalPreferences in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortalPreferences

public com.liferay.portal.kernel.portlet.PortalPreferences getPortalPreferences(long userId,
                                                                                boolean signedIn)

Specified by:

getPortalPreferences in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortalPreferences

public com.liferay.portal.kernel.portlet.PortalPreferences getPortalPreferences(javax.portlet.PortletRequest portletRequest)

Specified by:

getPortalPreferences in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortletPreferences

public javax.portlet.PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                              java.lang.String portletId)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPortletPreferences in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Throws:

com.liferay.portal.kernel.exception.PortalException

getPortletPreferencesIds

public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                      com.liferay.portal.kernel.model.Layout layout,
                                                                                      java.lang.String portletId)
                                                                               throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPortletPreferencesIds in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Throws:

com.liferay.portal.kernel.exception.PortalException

getPortletPreferencesIds

public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                      java.lang.String portletId)
                                                                               throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPortletPreferencesIds in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Throws:

com.liferay.portal.kernel.exception.PortalException

getPortletPreferencesIds

public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(long siteGroupId,
                                                                                      long userId,
                                                                                      com.liferay.portal.kernel.model.Layout layout,
                                                                                      java.lang.String portletId,
                                                                                      boolean modeEditGuest)
                                                                               throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPortletPreferencesIds in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Throws:

com.liferay.portal.kernel.exception.PortalException

getPortletPreferencesIds

public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(long companyId,
                                                                                      long siteGroupId,
                                                                                      long layoutGroupId,
                                                                                      long plid,
                                                                                      java.lang.String portletId)
                                                                               throws java.lang.IllegalArgumentException

Specified by:

getPortletPreferencesIds in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

Throws:

java.lang.IllegalArgumentException

getPortletPreferencesIds

public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(long companyId,
                                                                                      long siteGroupId,
                                                                                      long plid,
                                                                                      java.lang.String portletId,
                                                                                      java.lang.String settingsScope)

Specified by:

getPortletPreferencesIds in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                        java.lang.String portletId)

Specified by:

getPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                        java.lang.String portletId,
                                                        java.lang.String defaultPreferences)

Specified by:

getPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(com.liferay.portal.kernel.model.Layout layout,
                                                        java.lang.String portletId,
                                                        java.lang.String defaultPreferences)

Specified by:

getPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(long siteGroupId,
                                                        com.liferay.portal.kernel.model.Layout layout,
                                                        java.lang.String portletId,
                                                        java.lang.String defaultPreferences)

Specified by:

getPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(javax.portlet.PortletRequest portletRequest)

Specified by:

getPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(javax.portlet.PortletRequest portletRequest,
                                                        java.lang.String portletId)

Specified by:

getPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPortletSetupMap

public java.util.Map<java.lang.Long,javax.portlet.PortletPreferences> getPortletSetupMap(long companyId,
                                                                                         long groupId,
                                                                                         long ownerId,
                                                                                         int ownerType,
                                                                                         java.lang.String portletId,
                                                                                         boolean privateLayout)

Specified by:

getPortletSetupMap in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPreferences

public javax.portlet.PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest httpServletRequest)

Specified by:

getPreferences in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getPreferencesValidator

public javax.portlet.PreferencesValidator getPreferencesValidator(com.liferay.portal.kernel.model.Portlet portlet)

Specified by:

getPreferencesValidator in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getStrictLayoutPortletSetup

public javax.portlet.PortletPreferences getStrictLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout,
                                                                    java.lang.String portletId)

Specified by:

getStrictLayoutPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getStrictPortletSetup

public javax.portlet.PortletPreferences getStrictPortletSetup(com.liferay.portal.kernel.model.Layout layout,
                                                              java.lang.String portletId)

Specified by:

getStrictPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

getStrictPortletSetup

public javax.portlet.PortletPreferences getStrictPortletSetup(long companyId,
                                                              long groupId,
                                                              java.lang.String portletId)

Specified by:

getStrictPortletSetup in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

strictFromXML

public StrictPortletPreferencesImpl strictFromXML(long companyId,
                                                  long ownerId,
                                                  int ownerType,
                                                  long plid,
                                                  java.lang.String portletId,
                                                  java.lang.String xml)

Specified by:

strictFromXML in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

toXML

public java.lang.String toXML(com.liferay.portal.kernel.portlet.PortalPreferences portalPreferences)

Specified by:

toXML in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

toXML

public java.lang.String toXML(javax.portlet.PortletPreferences portletPreferences)

Specified by:

toXML in interface com.liferay.portal.kernel.portlet.PortletPreferencesFactory

readPreference

protected static Preference readPreference(javax.xml.stream.XMLEventReader xmlEventReader)
                                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getPortletSetup

protected javax.portlet.PortletPreferences getPortletSetup(long companyId,
                                                           long siteGroupId,
                                                           long layoutGroupId,
                                                           long plid,
                                                           java.lang.String portletId,
                                                           java.lang.String defaultPreferences,
                                                           boolean strictMode)

toPreferencesMap

protected java.util.Map<java.lang.String,Preference> toPreferencesMap(java.lang.String xml)