This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay developers or users. We try our best to minimize these disruptions, but sometimes they are unavoidable.
Here are some of the types of changes documented in this file:
- Functionality that is removed or replaced
- API incompatibilities: Changes to public Java or JavaScript APIs
- Changes to context variables available to templates
- Changes in CSS classes available to Liferay themes and portlets
- Configuration changes: Changes in configuration files, like
portal.properties,system.properties, etc. - Execution requirements: Java version, J2EE Version, browser versions, etc.
- Deprecations or end of support: For example, warning that a certain feature or API will be dropped in an upcoming version.
- Recommendations: For example, recommending using a newly introduced API that replaces an old API, in spite of the old API being kept in Liferay Portal for backwards compatibility.
This document has been reviewed through commit b6a7500.
Each change must have a brief descriptive title and contain the following information:
- [Title] Provide a brief descriptive title. Use past tense and follow the capitalization rules from http://en.wikibooks.org/wiki/Basic_Book_Design/Capitalizing_Words_in_Titles.
- Date: Specify the date you submitted the change. Format the date as YYYY-MMM (e.g., 2014-Mar) or YYYY-MMM-DD (e.g., 2014-Feb-25).
- JIRA Ticket: Reference the related JIRA ticket (e.g., LPS-123456) (Optional).
- What changed? Identify the affected component and the type of change that was made.
- Who is affected? Are end-users affected? Are developers affected? If the only affected people are those using a certain feature or API, say so.
- How should I update my code? Explain any client code changes required.
- Why was this change made? Explain the reason for the change. If applicable, justify why the breaking change was made instead of following a deprecation process.
Here's the template to use for each breaking change (note how it ends with a horizontal rule):
### Title
- **Date:**
- **JIRA Ticket:**
#### What changed?
#### Who is affected?
#### How should I update my code?
#### Why was this change made?
---------------------------------------
80 Columns Rule: Text should not exceed 80 columns. Keeping text within 80 columns makes it easier to see the changes made between different versions of the document. Titles, links, and tables are exempt from this rule. Code samples must follow the column rules specified in Liferay's Development Style.
The remaining content of this document consists of the breaking changes listed in ascending chronological order.
- Date: 2013-Dec-05
- JIRA Ticket: LPS-42645
The Logo Selector tag now supports uploading an image, storing it as a temporary
file, cropping it, and canceling edits. The tag no longer requires creating a UI
to include the image. Consequently, the editLogoURL parameter is no longer
needed and has been removed. The tag now uses the following parameters to
support the new features:
currentLogoURL: the URL to display the image being storedhasUpdateLogoPermission:trueif the current user can update the logomaxFileSize: the size limit for the logo to be uploadedtempImageFileName: the unique identifier to store the temporary image on upload
Plugins or templates that are using the liferay-ui:logo-selector tag need
to update their usage of the tag.
You should remove the parameter editLogoURL and include (if neccessary) the
parameters currentLogoURL, hasUpdateLogoPermission, maxFileSize, and/or
tempImageFileName.
Example
Old way:
<portlet:renderURL var="editUserPortraitURL" windowState="<%= LiferayWindowState.POP_UP.toString() %>">
<portlet:param name="struts_action" value="/users_admin/edit_user_portrait" />
<portlet:param name="redirect" value="<%= currentURL %>" />
<portlet:param name="p_u_i_d" value="<%= String.valueOf(selUser.getUserId()) %>" />
<portlet:param name="portrait_id" value="<%= String.valueOf(selUser.getPortraitId()) %>" />
</portlet:renderURL>
<liferay-ui:logo-selector
defaultLogoURL="<%= UserConstants.getPortraitURL(themeDisplay.getPathImage(), selUser.isMale(), 0) %>"
editLogoURL="<%= editUserPortraitURL %>"
imageId="<%= selUser.getPortraitId() %>"
logoDisplaySelector=".user-logo"
/>
New way:
<liferay-ui:logo-selector
currentLogoURL="<%= selUser.getPortraitURL(themeDisplay) %>"
defaultLogoURL="<%= UserConstants.getPortraitURL(themeDisplay.getPathImage(), selUser.isMale(), 0) %>"
hasUpdateLogoPermission='<%= UsersAdminUtil.hasUpdateFieldPermission(permissionChecker, null, selUser, "portrait") %>'
imageId="<%= selUser.getPortraitId() %>"
logoDisplaySelector=".user-logo"
maxFileSize="<%= PrefsPropsUtil.getLong(PropsKeys.USERS_IMAGE_MAX_SIZE) / 1024 %>"
tempImageFileName="<%= String.valueOf(selUser.getUserId()) %>"
/>
This change helps keep a unified UI and consistent experience for uploading logos in the portal. The logos can be customized from a single location and used throughout the portal. In addition, the change adds new features such as image cropping and support for canceling image upload.
Merged Configured Email Signature Field into the Body of Email Messages from Message Boards and Wiki
- Date: 2014-Feb-28
- JIRA Ticket: LPS-44599
The configuration for email signatures of notifications from Message Boards and
Wiki has been removed. An automatic update process is available that appends
existing signatures into respective email message bodies for Message Boards and
Wiki notifications. The upgrade process only applies to configured signatures in
the database. In case you declared signatures in portal properties (e.g.,
portal-ext.properties), you must make the manual changes explained below.
Users and system administrators who have configured email signatures for Message
Boards or Wiki notifications are affected. System administrators who have
configured portal properties (e.g., portal-ext.properties) must make the
manual changes described below.
You should modify your portal-ext.properties file to remove the properties
message.boards.email.message.added.signature,
message.boards.email.message.updated.signature,
wiki.email.page.added.signature, and wiki.email.page.updated.signature.
Then, you should append the contents of the signatures to the bodies you had
previously configured in your portal-ext.properties file.
Example
Old way:
wiki.email.page.updated.body=A wiki page was updated.
wiki.email.page.updated.signature=For any doubts email the system administrator
New way:
wiki.email.page.updated.body=A wiki page was updated.\n--\nFor any doubts email the system administrator
This change helps simplify the user interface. The signatures can still be set inside the message body. There was no real benefit in keeping the signature and body fields separate.
- Date: 2014-Mar-07
- JIRA Ticket: LPS-44342
All the methods get() and format() which had the PortletConfig as a
parameter have been removed.
Any invocations from Java classes or JSPs to these methods in LanguageUtil and
UnicodeLanguageUtil are affected.
Replace invocations to these methods with invocations to methods of the same
name that take a ResourceBundle parameter, instead of taking a
PortletConfig parameter.
Example
Old call:
LanguageUtil.get(portletConfig, locale, key);
New call:
LanguageUtil.get(portletConfig.getResourceBundle(locale), key);
The removed methods didn't work properly and would never work properly, since they didn't have all the information they required. Since we expected the methods were rarely used, we thought it better to remove them without deprecation than to leave them as buggy methods in the API.
- Date: 2014-Mar-18
- JIRA Ticket: LPS-45107
Web content is now required to use a structure and template. A default structure and template named Basic Web Content was added to the global scope, and can be modified or deleted.
Applications that use the Journal API to create web content without a structure or template are affected.
You should always use a structure and template when creating web content. You
can still use the Basic Web Content from the global scope (using the
structure key basic-web-content), but you should keep in mind that users can
modify or delete it.
This change gives users the flexibility to modify the default structure and template.
Changed the AssetRenderer and Indexer APIs to Include the PortletRequest and PortletResponse Parameters
- Date: 2014-May-07
- JIRA Ticket: LPS-44639 and LPS-44894
The getSummary() method in the AssetRenderer API and the doGetSummary()
method in the Indexer API have changed and must include a PortletRequest
and PortletResponse parameter as part of their signatures.
These methods must be updated in all AssetRenderer and Indexer implementations.
Add a PortletRequest and PortletResponse parameter to the signatures of
these methods.
Example 1
Old signature:
protected Summary doGetSummary(Document document, Locale locale, String snippet, PortletURL portletURL)
New signature:
protected Summary doGetSummary(Document document, Locale locale, String snippet, PortletRequest portletRequest, PortletResponse portletResponse)
Example 2
Old signature:
public String getSummary(Locale locale)
New signature:
public String getSummary(PortletRequest portletRequest, PortletResponse portletResponse)
Some content (such as web content) needs the PortletRequest and
PortletResponse parameters in order to be rendered.
- Date: 2014-Jun-06
- JIRA Ticket: LPS-43134
Previously, some portlets allowed separate setups per portlet instance, regardless of whether the instances were in the same page or in different pages. For some of the portlet setup fields, however, it didn't make sense to allow different values in different instances. The flexibility of these fields was unnecessary and confused users. As part of this change, these fields have been moved from portlet instance setup to Site Administration.
The upgrade process takes care of making the necessary database changes. In the case of several portlet instances having different configurations, however, only one configuration is preserved.
For example, if you configured three Bookmarks portlets where the mail configuration was the same, upgrade will be the same and you won't have any problem. But if you configured the three portlet instances differently, only one configuration will be chosen. To find out which configuration is chosen, you can check the log generated in the console by the upgrade process.
Since configuring instances of the same portlet type differently is highly discouraged and notoriously problematic, we expect this change will inconvenience only a very low minority of portal users.
Affected users are those who have specified varying configurations for multiple portlet instances of a portlet type, that stores configurations at the layout level.
The upgrade process chooses one portlet instance's configurations and stores it at the service level. After the upgrade, you should review the portlet's configuration and make any necessary modifications.
Unifying portlet and service configuration facilitates managing them.
- Date: 2014-Jun-11
- JIRA Ticket: LPS-47559
The updateXSDFieldMetadata() operation was removed from the DDM Structure
Local Service API.
DDM Structure Local API users should reference a structure's internal representation; any call to modify a DDM structure's content should be done through the DDMForm model.
Applications that use the DDM Structure Local Service API might be affected.
You should always use DDMForm to update the DDM Structure content. You can
retrieve it by calling ddmStructure.getDDMForm(). Perform any changes to it and
then call DDMStructureLocalServiceUtil.updateDDMStructure(ddmStructure).
This change gives users the flexibility to modify the structure content without concerning themselves with the DDM Structure's internal content representation of data.
The aui:input Tag for Type checkbox No Longer Creates a Hidden Input
- Date: 2014-Jun-16
- JIRA Ticket: LPS-44228
Whenever the aui:input tag is used to generate an input of type checkbox, only an input tag will be generated, instead of the checkbox and hidden field it was generating before.
Anyone trying to grab the previously generated fields is affected. The change mostly affects JavaScript code trying to add some additional actions when clicking on the checkboxes.
In your front-end JavaScript code, follow these steps:
- Remove the
Checkboxsuffix when querying for the node in any of its forms, likeA.one(...),$(...), etc. - Remove any action that tries to set the value of the checkbox on the previously generated hidden field.
This change makes generated forms more standard and interoperable since it falls back to the checkboxes default behavior. It allows the form to be submitted properly even when JavaScript is disabled.
- Date: 2014-Jun-19
- JIRA Ticket: LPS-47682
Several APIs in portal-kernel.jar contained references to the
javax.servlet.jsp package. This forced util-taglib, which depended on many
of the package's features, to be bound to the same JSP implementation.
Due to this, the following APIs had breaking changes:
LanguageUtilUnicodeLanguageUtilVelocityTaglibImplThemeUtilRuntimePageUtilPortletDisplayTemplateUtilDDMXSDUtilPortletResourceBundlesResourceActionsUtilPortalUtil
This affects anyone calling the classes listed above.
Code invoking the APIs listed above should be updated to use an
HttpServletRequest parameter instead of the formerly used PageContext
parameter.
As stated previously, the use of the javax.servlet.jsp API in portal-kernel
prevented the use of any other JSP impl within plugins (OSGi or otherwise). This
limited what Liferay could change with respect to providing its own JSP
implementation within OSGi.
- Date: 2014-Jul-03
- JIRA Ticket: LPS-47130
In order to provide more information about the root cause of an exception, several exceptions have been extended with static inner classes, one for each cause. As a result of this effort, some exceptions have been identified that really belong as static inner subclasses of existing exceptions.
Client code which is handling any of the following exceptions:
DuplicateUserScreenNameExceptionDuplicateUserEmailAddressException
Replace the old exception with the equivalent inner class exception as follows:
DuplicateUserScreenNameException→UserScreenNameException.MustNotBeDuplicateDuplicateUserEmailAddressException→UserEmailAddressException.MustNotBeDuplicate
This change provides more information to clients of the services API about the root cause of an error. It provides a more helpful error message to the end-user and it allows for easier recovery, when possible.
- Date: 2014-Jul-22
- JIRA Ticket: LPS-47508
The deleteFileEntry() and deleteFolder() methods in
DLAppHelperLocalService deleted the corresponding trash entry in the database.
This logic has been removed from these methods.
Every caller of the deleteFileEntry() and deleteFolder() methods is
affected.
There is no direct replacement. Trash operations are now accessible through the
TrashCapability implementations for each repository. The following code
demonstrates using a TrashCapability instance to delete a FileEntry:
Repository repository = getRepository();
TrashCapability trashCapability = repository.getCapability(
TrashCapability.class);
FileEntry fileEntry = repository.getFileEntry(fileEntryId);
trashCapability.deleteFileEntry(fileEntry);
Note that the deleteFileEntry() and deleteFolder() methods in
TrashCapability not only remove the trash entry, but also remove the folder or
file entry itself, and any associated data, such as assets, previews, etc.
This change was made to allow different kinds of repositories to support trash operations in a uniform way.
- Date: 2014-Sep-05
- JIRA Ticket: LPS-48895
The moveFileEntry() and moveFolder() methods in DLAppHelperLocalService
fired Liferay Sync events. These methods have been removed.
Every caller of the moveFileEntry() and moveFolder() methods is affected.
There is no direct replacement. Sync operations are now accessible through the
SyncCapability implementations for each repository. The following code
demonstrates using a SyncCapability instance to move a FileEntry:
Repository repository = getRepository();
SyncCapability syncCapability = repository.getCapability(
SyncCapability.class);
FileEntry fileEntry = repository.getFileEntry(fileEntryId);
syncCapability.moveFileEntry(fileEntry);
There are repositories that don't support Liferay Sync operations.
- Date: 2014-Sep-26
- JIRA Ticket: LPS-50348
The .aui namespace was removed from prefixing all of Bootstrap's CSS.
Theme and plugin developers that targeted their CSS to rely on the namespace are affected.
Theme developers can still manually add an aui.css file in their _diffs
directory, and add it back in. The aui CSS class can also be added to the
$root_css_class variable.
Due to changes in the Sass parser, the nesting of third-party libraries was causing some syntax errors which broke other functionality (e.g., RTL conversion). There was also a lot of additional complexity for a relatively minor benefit.
- Date: 2014-Sep-26
- JIRA Ticket: LPS-50156
The classes from package com.liferay.util.bridges.mvc in util-bridges.jar
were moved to a new package com.liferay.portal.kernel.portlet.bridges.mvc in
portal-kernel.jar.
Old classes:
com.liferay.util.bridges.mvc.ActionCommand
com.liferay.util.bridges.mvc.BaseActionCommand
New classes:
com.liferay.portal.kernel.portlet.bridges.mvc.BaseMVCActionCommand
com.liferay.portal.kernel.portlet.bridges.mvc.MVCActionCommand
In addition, com.liferay.util.bridges.mvc.MVCPortlet is deprecated, but was
made to extend com.liferay.portal.kernel.portlet.bridges.mvc.MVCPortlet.
The classes in the com.liferay.portal.kernel.portlet.bridges.mvc package have
been renamed to add the MVC prefix. These modifications were made after this
breaking change, and can be referenced in
LPS-56372.
This will affect any implementations of ActionCommand.
Replace imports of com.liferay.util.bridges.mvc.ActionCommand with
com.liferay.portal.kernel.portlet.bridges.mvc.ActionCommand and imports of
com.liferay.util.bridges.mvc.BaseActionCommand with
com.liferay.portal.kernel.portlet.bridges.mvc.BaseActionCommand.
This change was made to avoid duplication of an implementable interface in the
system. Duplication can cause ClassCastExceptions.
Convert Process Classes Are No Longer Specified via the convert.processes Portal Property, but Are Contributed as OSGi Modules
- Date: 2014-Oct-09
- JIRA Ticket: LPS-50604
The implementation class com.liferay.portal.convert.ConvertProcess was renamed
com.liferay.portal.convert.BaseConvertProcess. An interface named
com.liferay.portal.convert.ConvertProcess was created for it.
The convert.processes key was removed from portal.properties.
Consequentially, ConvertProcess implementations must register as OSGi
components.
This affects any implementations of the former ConvertProcess class, including
ConvertProcess class implementations in EXT plugins. Until version 6.2, this
type of service could only be implemented with an EXT plugin, given that the
ConvertProcess class resided in portal-impl.
You should replace extends com.liferay.portal.convert.ConvertProcess with
extends com.liferay.portal.convert.BaseConvertProcess and annotate the class
with @Component(service=ConvertProcess.class).
Then turn your EXT plugin into an OSGi bundle and deploy it to the portal. You should see your convert process in the configuration UI.
This change was made as a part of the ongoing strategy to modularize Liferay Portal by means of an OSGi container.
- Date: 2014-Oct-13
- JIRA Ticket: LPS-50764
The field type from the Journal Article entity has been removed. The Journal API no longer supports this parameter. A new vocabulary called Web Content Types is created when migrating from previous versions of Liferay, and the types from the existing articles are kept as categories of this vocabulary.
This affects any caller of the removed methods JournalArticle.getType() and
JournalFeed.getType(), and callers of ArticleTypeException's methods, that
attempt to use the former type parameter of the JournalArticle or
JournalFeed service.
If your logic was not affected by the type, you can simply remove the type
parameter from the Journal API call. If your logic was affected by the type, you
should now use the AssetCategoryService to obtain the category of the journal
articles.
Web Content Types had to be updated in a properties file and could not be translated easily. Categories provide a much more flexible behavior and a better UI. In addition, all the features, such as filters, developed for categories can be used now in asset publishers and faceted search.
- Date: 2014-Nov-11
- JIRA Ticket: LPS-50604
The getClassNamePortletId(String) method from the PortalUtil class has been
removed.
This affects any plugin using the method.
If you are using the method, you should implement it yourself in a private utility class.
This change was needed in order to modularize the portal. Also, the method is no longer being used inside Liferay Portal.
- Date: 2014-Nov-12
- JIRA Ticket: LPS-46984
The Header Web Content and Footer Web Content preferences from the RSS portlet have been removed. The portlet now supports Application Display Templates (ADT), which provide templating capabilities that can apply web content to the portlet's header and footer.
This affects RSS portlets that are displayed on pages and that use these preferences. These preferences are no longer used in the RSS portlet.
Even though these preferences have been removed, an ADT can be created to produce the same result. Liferay will publish this ADT so that it can be used in the RSS portlet.
The support for ADTs in the RSS portlet not only covers this use case, but also covers many other use cases, providing a much simpler way to create custom preferences.
- Date: 2014-Dec-18
- JIRA Ticket: LPS-52275
The Liferay.Util.createFlyouts method has been completely removed from core
files.
This only affects third party developers who are explicitly calling
Liferay.Util.createFlyouts for the creation of flyout menus. It will not
affect any menus in core files.
If you are using the method, you can achieve the same behavior with CSS.
This method was removed due to there being no working use cases in Portal, and its overall lack of functionality.
- Date: 2014-Dec-30
- JIRA Ticket: LPS-51876
Discussion comments are now displayed using the Combination thread view, and the number of levels displayed in the tree is limited.
This affects installations that specify portal property setting
discussion.thread.view=flat, which was the default setting.
There is no need to update anything since the portal property has been removed
and the combination thread view is now hard-coded.
Flat view comments were originally implemented as an option to tree view comments, which were having performance issues with comment pagination.
Portal now uses a new pagination implementation that performs well. It allows
comments to display in a hierarchical view, making it easier to see reply
history. Therefore, the flat thread view is no longer needed.
- Date: 2015-Jan-13
- JIRA Ticket: LPS-52588
The Asset Tag Properties have been removed. The service no longer exists and the Asset Tag Service API no longer has this parameter. The behavior associated with tag properties in the Asset Publisher and XSL portlets has also been removed.
This affects any plugin that uses the Asset Tag Properties service.
If you are using this functionality, you can achieve the same behavior with
Asset Category Properties. If you are using the Asset Tag Service, remove the
String[] tag properties parameter from your calls to the service's methods.
The Asset Tag Properties were deprecated for the 6.2 version of Liferay Portal.
- Date: 2015-Jan-22
- JIRA Ticket: LPS-52966
The asset.publisher.asset.entry.query.processors property has been removed
from portal.properties.
This affects any hook that uses the
asset.publisher.asset.entry.query.processors property.
If you are using this property to register Asset Entry Query Processors, your
Asset Entry Query Processor must implement the
com.liferay.portlet.assetpublisher.util.AssetEntryQueryProcessor interface and
must specify the @Component(service=AssetEntryQueryProcessor.class)
annotation.
This change was made as a part of the ongoing strategy to modularize Liferay Portal.
Replaced the ReservedUserScreenNameException with UserScreenNameException.MustNotBeReserved in UserLocalService
- Date: 2015-Jan-29
- JIRA Ticket: LPS-53113
Previous to Liferay 7, several methods of UserLocalService could throw a
ReservedUserScreenNameException when a user set a screen name that was not
allowed. That exception has been deprecated and replaced with
UserScreenNameException.MustNotBeReserved.
This affects developers who have written code that catches the
ReservedUserScreenNameException while calling the affected methods.
You should replace catching exception ReservedUserScreenNameException with
catching exception UserScreenNameException.MustNotBeReserved.
A new pattern has been defined for exceptions that provides higher expressivity in their names and also more information regarding why the exception was thrown.
The new exception UserScreenNameException.MustNotBeReserved has all the
necessary information about why the exception was thrown and its context. In
particular, it contains the user ID, the problematic screen name, and the list
of reserved screen names.
Replaced the ReservedUserEmailAddressException with UserEmailAddressException Inner Classes in User Services
- Date: 2015-Feb-03
- JIRA Ticket: LPS-53279
Previous to Liferay 7, several methods of UserLocalService and UserService
could throw a ReservedUserEmailAddressException when a user set an email
address that was not allowed. That exception has been deprecated and replaced
with UserEmailAddressException.MustNotUseCompanyMx,
UserEmailAddressException.MustNotBePOP3User, and
UserEmailAddressException.MustNotBeReserved.
This affects developers who have written code that catches the
ReservedUserEmailAddressException while calling the affected methods.
Depending on the method you're calling and the context in which you're calling
it, you should replace catching exception ReservedUserEmailAddressException
with catching exception UserEmailAddressException.MustNotUseCompanyMx,
UserEmailAddressException.MustNotBePOP3User, or
UserEmailAddressException.MustNotBeReserved.
A new pattern has been defined for exceptions. This pattern requires using higher expressivity in exception names and requires that each exception provide more information regarding why it was thrown.
Each new exception provides its context and has all the necessary information
about why the exception was thrown. For example, the
UserEmailAddressException.MustNotBeReserved exception contains the problematic
email address and the list of reserved email addresses.
- Date: 2015-Feb-10
- JIRA Ticket: LPS-53487
The ReservedUserIdException has been deprecated and replaced with
UserIdException.MustNotBeReserved.
This affects developers who have written code that catches the
ReservedUserIdException while calling the affected methods.
You should replace catching exception ReservedUserIdException with
catching exception UserIdException.MustNotBeReserved.
A new pattern has been defined for exceptions that provides higher expressivity in their names and also more information regarding why the exception was thrown.
The new exception UserIdException.MustNotBeReserved provides its context and
has all the necessary information about why the exception was thrown. In
particular, it contains the problematic user ID and the list of reserved user
IDs.
- Date: 2015-Feb-11
- JIRA Ticket: LPS-52744
The class AssetPublisherUtil from the portal-kernel module has been moved to
the module AssetPublisher and it is no longer a part of the public API.
This affects developers who have written code that uses the AssetPublisherUtil
class.
This AssetPublisherUtil class should no longer be used from other modules
since it contains utility methods for the Asset Publisher portlet. If needed,
you can define a dependency with the Asset Publisher module and use the new
class.
This change has been made as part of the modularization efforts to decouple the different parts of the portal.
- Date: 2015-Feb-11
- JIRA Ticket: LPS-53021
All operations that used the Fields class have been removed from the
StorageAdapter interface.
This affects developers who have written code that directly calls these operations.
You should update your code to use the DDMFormValues class instead of the
Fields class.
This change has been made due to the deprecation of the Fields class.
- Date: 2015-Feb-17
- JIRA Ticket: LPS-53574
The DLProcessor interface has a new method getType().
This affects developers who have created a DLProcessor.
You should implement the new method and return the type of processor. You can
check the class DLProcessorConstants to see processor types.
Previous to Liferay 7, developers were forced to extend one of the existing
DLProcessor classes and developers using the extended class had to check the
instance of that class to determine its processor type.
With this change, developers no longer need to extend any particular class to
create their own DLProcessor and their processor's type can be clearly
specified by a constant from the class DLProcessorConstants.
- Date: 2015-Mar-01
- JIRA Ticket: LPS-54106
The usage of the taglib tag liferay-ui:restore-entry serves a different
purpose now. It renders the UI to restore elements from the Recycle Bin.
This affects developers using the tag liferay-ui:restore-entry.
You should replace your calls to the tag with code like the listing below:
<aui:script use="liferay-restore-entry">
new Liferay.RestoreEntry(
{
checkEntryURL: '<%= checkEntryURL.toString() %>',
duplicateEntryURL: '<%= duplicateEntryURL.toString() %>',
namespace: '<portlet:namespace />'
}
);
</aui:script>
In the above code, the checkEntryURL should be an ActionURL of your portlet,
which checks whether the current entry can be restored from the Recycle Bin. The
duplicateEntryURL should be a RenderURL of your portlet, that renders the UI
to restore the entry, resolving any existing conflicts. In order to generate
that URL, you can use the tag liferay-ui:restore-entry, which has been
refactored for this usage.
This change allows the Trash portlet to be an independent module. Its actions and views are no longer used by the tag; they are now the responsability of each plugin.
- Date: 2015-Mar-03
- JIRA Ticket: LPS-52990
The DDM template search and searchCount operations have a new parameter
called resourceClassNameId.
This affects developers who have direct calls to the DDMTemplateService or
DDMTemplateLocalService.
You should add the resourceClassNameId parameter to your calls. This parameter
represents the resource that owns the permission for the DDM template. For
example, if the template is a WCM template, the resourceClassNameId points to
the JournalArticle's classNameId. If the template is a DDL template, the
resourceClassNameId points to the DDLRecordSet's classNameId. If the
template is an ADT template, the resourceClassNameId points to the
PortletDisplayTemplate's classNameId.
This change was made in order to implement model resource permissions for DDM
templates, such as VIEW, DELETE, PERMISSIONS, and UPDATE.
- Date: 2015-Mar-12
- JIRA Ticket: LPS-53577
The custom display styles of the breadcrumb tag added using JSPs no longer work. They have been replaced by Application Display Templates (ADT).
This affects developers that use the following properties:
breadcrumb.display.style.default=horizontal
breadcrumb.display.style.options=horizontal,vertical
To style the Breadcrumb portlet, you should use ADTs instead of using custom styles in your JSPs. ADTs can be created from the UI of the portal by navigating to Site Settings → Application Display Templates. ADTs can also be created programatically.
ADTs allow you to change an application's look and feel without changing its JSP code.
- Date: 2015-Mar-16
- JIRA Ticket: LPS-53790
The attribute classNameId of the liferay-ui:ddm-template-selector taglib tag
has been renamed className.
This affects developers using the liferay-ui:ddm-template-selector tag.
In your liferay-ui:ddm-template-selector tags, rename the classNameId
attribute to className.
Application Display Templates were being referenced by their UUID, which was usually not known by the developer. Referencing all DDM templates by their class name simplifies using this tag.
- Date: 2015-Mar-16
- JIRA Ticket: LPS-53972
Instead of directly including the JSP referenced by the AssetRenderer's
getPreviewPath method to preview an asset, you now use a taglib tag.
This affects developers who have written code that directly calls an
AssetRenderer's getPreviewPath method to preview an asset.
JSP code that previews an asset by calling an AssetRenderer's getPreviewPath
method, such as in the example code below, must be replaced:
<liferay-util:include
page="<%= assetRenderer.getPreviewPath(liferayPortletRequest, liferayPortletResponse) %>"
portletId="<%= assetRendererFactory.getPortletId() %>"
servletContext="<%= application %>"
/>
To preview an asset, you should instead use the liferay-ui:asset-display tag,
passing it an instance of the asset entry and an asset renderer preview
template. Here's an example of using the tag:
<liferay-ui:asset-display
assetEntry="<%= assetEntry %>"
template="<%= AssetRenderer.TEMPLATE_PREVIEW %>"
/>
This change simplifies using asset previews.
- Date: 2015-Mar-17
- JIRA Ticket: LPS-53409
The ScreenNameValidator interface has new methods getDescription(Locale) and
getJSValidation().
This affects developers who have implemented a custom screen name validator with
the ScreenNameValidator interface.
You should implement the new methods introduced in the interface.
-
getDescription(Locale): returns a description of what the screen name validator validates. -
getJSValidation(): returns the JavaScript input validator on the client side.
Previous to Liferay 7, validation for user screen name characters was hard-coded
in UserLocalService. A new portal property named
users.screen.name.special.characters has been added to provide configurability
of special characters allowed in screen names.
In addition, developers can now specify a custom input validator for the screen
name on the client side by providing a JavaScript validator in
getJSValidation().
- Date: 2015-Mar-30
- JIRA Ticket: LPS-54419
The custom display styles of the language tag added using JSPs no longer work. They have been replaced by Application Display Templates (ADT).
This affects developers that use the following properties:
language.display.style.default=icon
language.display.style.options=icon,long-text
To style the Language portlet, you should use ADTs instead of using custom styles in your JSPs. ADTs can be created from the UI of the portal by navigating to Site Settings → Application Display Templates. ADTs can also be created programatically.
ADTs allow you to change an application's look and feel without changing its JSP code.
- Date: 2015-Mar-31
- JIRA Ticket: LPS-54570
The API for adding tags, categories, and vocabularies now requires passing the
groupId parameter. Previously, it had to be included in the ServiceContext
parameter passed to the method.
This affects developers who have direct calls to the following methods:
addTaginAssetTagServiceorAssetTagLocalServiceaddCategoryinAssetCategoryServiceorAssetCategoryLocalServiceaddVocabularyinAssetVocabularyServiceorAssetVocabularyLocalServiceupdateFolderinJournalFolderServiceorJournalFolderLocalService
You should add the groupId parameter to your calls. This parameter represents
the site in which you are creating the tag, category, or vocabulary. It can be
obtained from the themeDisplay or serviceContext using
themeDisplay.getScopeGroupId() or serviceContext.getScopeGroupId(),
respectively.
This change was made in order improve the API. The groupId parameter was
always required, but it was hidden by the ServiceContext object.
- Date: 2015-Mar-31
- JIRA Ticket: LPS-54620
The following tags have been removed:
portlet:icon-closeportlet:icon-configurationportlet:icon-editportlet:icon-edit-defaultsportlet:icon-edit-guestportlet:icon-export-importportlet:icon-helpportlet:icon-maximizeportlet:icon-minimizeportlet:icon-portlet-cssportlet:icon-printportlet:icon-refreshportlet:icon-staging
This affects developers who have written code that uses these tags.
The tag liferay-ui:icon can replace the call to the previous tags. All the
previous tags have been converted into Java classes that implement the methods
that the icon tag requires.
See the modules portlet-configuration-icon-* in the modules/addons folder.
These tags were used to generate the configuration icon of portlets. This functionality will now be managed from OSGi modules instead of tags since OSGi modules provide more flexibility and can be included in any app.
- Date: 2015-Apr-15
- JIRA Ticket: LPS-54798
The copy-request-parameters init parameter's default value is now set to
true in all portlets that extend MVCPortlet.
This affects developers that have created portlets that extend MVCPortlet.
To continue using the property the same way you did before this change was
implemented, you'll need to change the default property. To change the property,
set the init parameter to false in your class extending MVCPortlet:
javax.portlet.init-param.copy-request-parameters=false
This change was made to allow for backwards compatibility.
- Date: 2015-Apr-16
- JIRA Ticket: LPS-54903
The following portal properties (and the equivalent PropsKeys and
PropsValues) that were used to decide what sections would be displayed in the
form-navigator have been removed:
company.settings.form.configurationcompany.settings.form.identificationcompany.settings.form.miscellaneouscompany.settings.form.socialjournal.article.form.addjournal.article.form.updatejournal.article.form.default.valueslayout.form.addlayout.form.updatelayout.set.form.updateorganizations.form.add.identificationorganizations.form.add.mainorganizations.form.add.miscellaneousorganizations.form.update.identificationorganizations.form.update.mainorganizations.form.update.miscellaneoussites.form.add.advancedsites.form.add.mainsites.form.add.miscellaneoussites.form.add.seosites.form.update.advancedsites.form.update.mainsites.form.update.miscellaneoussites.form.update.seousers.form.add.identificationusers.form.add.mainusers.form.add.miscellaneoususers.form.my.account.identificationusers.form.my.account.mainusers.form.my.account.miscellaneoususers.form.update.identificationusers.form.update.mainusers.form.update.miscellaneous
The sections and categories of form navigators are now OSGi components.
This affects administrators who may have added, removed, or reordered sections
using those portal properties. Developers using the constants defined in
PropsKeys or PropsValues for those portal properties will also be affected.
Since those properties no longer exist, you cannot rely on them. References to
the constants of PropsKeys and PropsValues will need to be updated. You can
use FormNavigatorCategoryUtil and FormNavigatorEntryUtil to obtain a list of
the available sections and categories for a form navigator instance.
Changes to remove or reorder specific sections will need to be done through the OSGi console to update the service ranking or stop the components.
Adding new sections with Liferay Hooks will still work as a legacy feature, but the recommended way is using OSGi components to add new sections.
The old mechanism to add new sections to form-navigator tags was very
limited because it could only depend on portal for services and utils due to the
new section that was rendered from the portal classloader.
There was a need to add new sections and categories to form-navigator tags via
OSGi plugins in a more extensible way, allowing the developer to include new
sections to access to their own utils and services.
- Date: 2015-Apr-21
- JIRA Ticket: LPS-54791
The type setting breadcrumbShowParentGroups was removed from groups and is
no longer available in the site configuration. Now, it is only available in the
breadcrumb configuration.
This affects all site administrators that have set the showParentGroups
preference in Site Administration.
There are no code updates required. This should only be updated at the portlet instance level.
This change was introduced to support the new Settings API.
- Date: 2015-Apr-28
- JIRA Ticket: LPS-52698
The method getText now returns the editor's content, without any HTML markup.
This affects developers that are using the getText method of the editor's
window API.
To continue using the editor the same way you did before this change was
implemented, you should change calls to the getText method to instead call the
getHTML method.
This change was made in the editor's window API to provide a proper getText
method that returns just the editor's content, without any HTML markup. This
change is used for the blog abstract field.
- Date: 2015-May-05
- JIRA Ticket: LPS-55364
The use of classes ContactFirstNameException, ContactFullNameException, and
ContactLastNameException has been moved to inner classes in a new class called
ContactNameException.
This affects developers who may have included one of the three classes above in their code.
While the old classes remain for backwards-compatibility, they are being
deprecated. You're encouraged to use the new pattern of inner classes for
exceptions wherever possible. For example, instead of using
ContactFirstNameExeception, use ContactNameException.MustHaveFirstName.
This change was made in accordance with the new exceptions pattern being applied throughout Portal. It also allows the new localized user name configuration feature to be thoroughly covered by exceptions for different configurations.
Removed USERS_LAST_NAME_REQUIRED from portal.properties in Favor of language.properties Configurations
- Date: 2015-May-07
- JIRA Ticket: LPS-54956
The USERS_LAST_NAME_REQUIRED property has been removed from
portal.properties and the corresponding UI. Required names are now handled on
a per-language basis via the language.properties files. It has also been
removed as an option from the Portal Settings section of the Control Panel.
This affects anyone who uses the USERS_LAST_NAME_REQUIRED portal property.
If you need to require the user's last name, list it on the
lang.user.name.required.field.names line of the appropriate
language.properties files:
lang.user.name.required.field.names=last-name
Portal property USERS_LAST_NAME_REQUIRED didn't support the multicultural user
name configurations introduced in LPS-48406. Language property files (e.g.,
language.properties) now support these configurations. Control of all user
name configuration, except with regards to first name, is relegated to language
property files. First name is required and always present.
Removed Methods getGroupLocalRepositoryImpl and getLocalRepositoryImpl from RepositoryLocalService and RepositoryService
- Date: 2015-May-14
- JIRA Ticket: LPS-55566
The methods getGroupLocalRepositoryImpl(...) and getLocalRepositoryImpl(...)
have been removed from RepositoryLocalService and RepositoryService.
Although the methods are related to the service, they belong in a different
level of abstraction.
This affects anyone who uses those methods.
The removed methods were generic and had long signatures with optional
parameters. They now have one specialized version per parameter and are
in the RepositoryProvider service.
Example
Old call:
RepositoryLocalServiceUtil.getRepositoryImpl(0, fileEntryId, 0)
New call:
RepositoryProviderUtil.getLocalRepositoryByFileEntryId(fileEntryId)
This change was made to enhance the Repository API and facilitate decoupling the API from the Document Library, as a part of the portal modularization effort.
- Date: 2015-May-20
- JIRA Ticket: LPS-47645
The addFileEntry method has been removed from DLAppHelperLocalService.
This affects anyone who calls the addFileEntry method.
If you need to invoke the addFileEntry method as part of a custom repository
implementation, use the provided repository capabilities instead. See
LiferayRepositoryDefiner for examples on their use.
For other use cases, you may need to explicitly invoke each of the service
methods used by addFileEntry.
The logic inside the addFileEntry method was moved, out from
DLAppHelperLocalService and into repository capabilities, to further decouple
core repository implementations from additional (optional) functionality.
- Date: 2015-May-20
- JIRA Ticket: LPS-55613
Indexers that previously received a DLFileEntry object (e.g., in the
addRelatedEntryFields method) no longer receive a DLFileEntry, but a
FileEntry.
This affects anyone who implements an Indexer handling DLFileEntry objects.
You should try to use methods in FileEntry or exported repository capabilities
to obtain the value you were using. If no capability exists for your use case,
you can resort to calling fileEntry.getModel() and casting the result to a
DLFileEntry. However, this breaks all encapsulation and may result in future
failures or compatibility problems.
Old code:
@Override
public void addRelatedEntryFields(Document document, Object obj)
throws Exception {
DLFileEntry dlFileEntry = (DLFileEntry)obj;
long fileEntryId = dlFileEntry.getFileEntryId();
New Code:
@Override
public void addRelatedEntryFields(Document document, Object obj)
throws Exception {
FileEntry fileEntry = (FileEntry)obj;
long fileEntryId = fileEntry.getFileEntryId();
This change was made to enhance the Repository API and make decoupling from Document Library easier when modularizing the portal.
- Date: 2015-May-27
- JIRA Ticket: LPS-55877
The parameters permissionClassName, permissionClassPK, and permissionOwner
have been removed from the Message Boards API and Discussion tag.
This affects anyone who invokes the affected methods (locally or remotely) and any view that uses the Discussion tag.
It suffices to remove the parameters from the method calls (for consumers of the API) or the attributes in tag invocations.
Those API methods were exposed in the remote services, allowing any consumer to
bypass the permission system by providing customized className, classPK, or
ownerId parameters.
Moved Indexer.addRelatedEntryFields and Indexer.reindexDDMStructures, and Removed Indexer.getQueryString
- Date: 2015-May-27
- JIRA Ticket: LPS-55928
Method Indexer.addRelatedEntryFields(Document, Object) has been moved into
RelatedEntryIndexer.
Indexer.reindexDDMStructures(List<Long>) has been moved into
DDMStructureIndexer.
Indexer.getQueryString(SearchContext, Query) has been removed, in favor of
calling SearchEngineUtil.getQueryString(SearchContext, Query).
This affects any code that invokes the affected methods, as well as any code that implements the interface methods.
Any code implementing Indexer.addRelatedEntryFields(...) should implement the
RelatedEntryIndexer interface.
Any code calling Indexer.addRelatedEntryFields(...) should determine first if
the Indexer is an instance of RelatedEntryIndexer.
Old code:
mbMessageIndexer.addRelatedEntryFields(...);
New code:
if (mbMessageIndexer instanceof RelatedEntryIndexer) {
RelatedEntryIndexer relatedEntryIndexer =
(RelatedEntryIndexer)mbMessageIndexer;
relatedEntryIndexer.addRelatedEntryFields(...);
}
Any code implementing Indexer.reindexDDMStructures(...) should implement the
DDMStructureIndexer interface.
Any code calling Indexer.reindexDDMStructures(...) should determine first if
the Indexer is an instance of DDMStructureIndexer.
Old code:
mbMessageIndexer.reindexDDMStructures(...);
New code:
if (journalIndexer instanceof DDMStructureIndexer) {
DDMStructureIndexer ddmStructureIndexer =
(DDMStructureIndexer)journalIndexer;
ddmStructureIndexer.reindexDDMStructures(...);
}
Any code calling Indexer.getQueryString(...) should call
SearchEngineUtil.getQueryString(...).
Old code:
mbMessageIndexer.getQueryString(...);
New code:
SearchEngineUtil.getQueryString(...);
The addRelatedEntryFields and reindexDDMStructures methods were not related
to core indexing functions. They were functions of specialized indexers.
The getQueryString method was an unnecessary convenience method.
- Date: 2015-May-27
- JIRA Ticket: LPS-55886
The mbMessages and fileEntryTuples attributes from the
app-view-search-entry tag have been removed. Related methods getMbMessages,
getFileEntryTuples, and addMbMessage have also been removed from the
SearchResult class.
This affects developers that use the app-view-search-entry tag in their views,
have developed hooks to customize the tag JSP, or have developed a portlet that
uses that tag. Also, any custom code that uses the SearchResult class may be
affected.
The new attributes commentRelatedSearchResults and
fileEntryRelatedSearchResults should be used instead. The expected value is
the one returned by the getCommentRelatedSearchResults and
getFileEntryRelatedSearchResults methods in SearchResult.
When adding comments to the SearchResult, the new addComment method should
be used instead of the addMbMessage method.
As part of the modularization efforts, references to MBMessage needed to be
removed for the Message Boards portlet to be placed into its own OSGi bundle.
Replaced Method getPermissionQuery with getPermissionFilter in SearchPermissionChecker, and getFacetQuery with getFacetBooleanFilter in Indexer
- Date: 2015-Jun-02
- JIRA Ticket: LPS-56064
Method SearchPermissionChecker.getPermissionQuery( long, long[], long, String, Query, SearchContext)
has been replaced by SearchPermissionChecker.getPermissionBooleanFilter( long, long[], long, String, BooleanFilter, SearchContext).
Method Indexer.getFacetQuery(String, SearchContext) has been replaced by
Indexer.getFacetBooleanFilter(String, SearchContext).
This affects any code that invokes the affected methods, as well as any code that implements the interface methods.
Any code calling/implementing SearchPermissionChecker.getPermissionQuery(...)
should instead call/implement
SearchPermissionChecker.getPermissionBooleanFilter(...).
Any code calling/implementing Indexer.getFacetQuery(...) should instead
call/implement Indexer.getFacetBooleanFilter(...).
Permission constraints placed on search should not affect the score for returned
search results. Thus, these constraints should be applied as search filters.
SearchPermissionChecker is also a very deep internal interface within the
permission system. Thus, to limit confusion in the logic for maintainability,
the SearchPermissionChecker.getPermissionQuery(...) method was removed as
opposed to deprecated.
Similarly, constraints applied to facets should not affect the scoring or facet
counts. Since Indexer.getFacetQuery(...) was only utilized by the
AssetEntriesFacet, and used to reduce the impact of changes for
SearchPermissionChecker.getPermissionBooleanFilter(...), the method was
removed as opposed to deprecated.
- Date: 2015-Jun-05
- JIRA Ticket: LPS-50939
A new parameter userId has been added to the updateStructure and
updateTemplate methods of the DDMStructureLocalService and
DDMTemplateLocalService classes, respectively.
This affects any code that invokes the affected methods, as well as any code that implements the interface methods.
Any code calling/implementing
DDMStructureLocalServiceUtil.updateStructure(...) or
DDMTemplateLocalServiceUtil.updateTemplate(...) should pass the new userId
parameter.
For the service to keep track of which user is modifying the structure or
template, the userId parameter was required. In order to add support to
structure and template versions, audit columns were also added to such models.
- Date: 2015-Jun-10
- JIRA Ticket: LPS-56247
The method getEntries has been removed from the DL, DLImpl, and DLUtil
classes.
This affects any caller of the getEntries method.
You may use the SearchResultUtil class to process the search results. Note
that this class is not completely equivalent; if you need exactly the same
behavior as the removed method, you will need to add custom code.
The getEntries method was no longer used, and contained hardcoded references
to classes that will be moved into OSGi bundles.
- Date: 2015-Jun-10
- JIRA Ticket: LPS-56242
The method getEntries() has been removed from class WikiUtil.
Any JSP hook or ext plugin that uses this method is affected. As the class was located in portal-impl, regular portlets and other safe extension points won't be affected.
You should review the JSP or ext plugin, updating it to remove any reference to
the new class and mimicking the original JSP code. In case you need equivalent
functionality to the one provided by WikiUtil.getEntries() you may use the
SearchResultUtil class. While not totally equivalent, it offers similar
functionality.
The WikiUtil.getEntries() method was no longer used, and it contained
hardcoded references to classes that will be moved into OSGi modules.
- Date: 2015-Jun-14
- JIRA Ticket: LPS-56300
The method render has been removed from the interface ConfigurationAction.
This affects any Java code calling the method render on a
ConfigurationAction class, or Java classes overriding the render method of a
ConfigurationAction class.
The method render was used to return the path of a JSP, including the
configuration of a portlet. That method is now available for configurations
extending the BaseJSPSettingsConfigurationAction class, and is called
getJspPath.
If any logic was added to override the render method, it can now be added in
the include method.
This change was part of needed modifications to support adding configuration for
portlets based on other technology different than JSP (e.g., FreeMarker). The
method include can now be used to create configuration UIs written in
FreeMarker or any other framework.
- Date: 2015-Jun-16
- JIRA Ticket: LPS-55518
The files ckconfig.jsp, ckconfig-ext.jsp, ckconfig_bbcode.jsp,
ckconfig_bbcode-ext.jsp, ckconfig_creole.jsp, and ckconfig_creole-ext.jsp
have been removed and are no longer used to configure the CKEditor instances
created using the liferay-ui:input-editor tag.
This affects any hook or plugin-ext overriding these files to modify the editor configuration.
Depending on the changes, different extension methods are available:
- For CKEditor configuration options, an implementation of
EditorConfigContributorcan be created to pass or modify the expected parameters. - For CKEditor instance manipulation (setting attributes, adding listeners,
etc.), the
DynamicIncludeextension point#ckeditor[_creole|_bbcode]#onEditorCreatedhas been added to provide the possibility of injecting JavaScript, when needed.
This change is part of a greater effort to provide mechanisms to extend and configure any editor in Liferay Portal in a coherent and extensible way.
- Date: 2015-Jun-16
- JIRA Ticket: LPS-56372
The classes located in the com.liferay.portal.kernel.portlet.bridges.mvc
package have been renamed to include the MVC prefix.
Old Classes:
BaseActionCommandBaseTransactionalActionCommandActionCommandActionCommandCache
New Classes:
BaseMVCActionCommandBaseMVCTransactionalActionCommandMVCActionCommandMVCActionCommandCache
Also, the property action.command.name has been renamed to mvc.command.name.
The code snippet below shows the new property in its context.
@Component(
immediate = true,
property = {
"javax.portlet.name=" + InvitationPortletKeys.INVITATION,
"mvc.command.name=view"
},
service = MVCActionCommand.class
)
This affects any Java code calling the ActionCommand classes used in the
MVCPortlet framework.
You should update the old ActionCommand class names with the new MVC prefix.
This change adds consistency to the MVC framework, and makes it self-explanatory what classes should be used for the MVC portlet.
- Date: 2015-Jun-16
- JIRA Ticket: LPS-56372
Previously, a single ActionCommand was valid for both ActionURL and
ResourceURL. Now you must distinguish both an ActionURL and ResourceURL as
different actions, which means you can register both with the same key.
This affects developers that were using the ActionCommand for actionURLs and
resourceURLs.
You should replace the ActionCommands used for actionURLs and resourceURLs
to use MVCActionCommand and MVCResourceCommand, respectively. For example,
for the new MVCResourceCommand, you'll need to use the resourceID of the
resourceURL instead of using ActionRequest.ACTION_NAME.
Old Code:
<liferay-portlet:resourceURL copyCurrentRenderParameters="<%= false %>" var="exportRecordSetURL">
<portlet:param name="<%= ActionRequest.ACTION_NAME %>" value="exportRecordSet" />
<portlet:param name="recordSetId" value="<%= String.valueOf(recordSet.getRecordSetId()) %>" />
</liferay-portlet:resourceURL>
New Code:
<liferay-portlet:resourceURL copyCurrentRenderParameters="<%= false %>" id="exportRecordSet" var="exportRecordSetURL">
<portlet:param name="recordSetId" value="<%= String.valueOf(recordSet.getRecordSetId()) %>" />
</liferay-portlet:resourceURL>
This change was made to extend the MVC framework to have better support for
actionURLs and resourceURLs.
- Date: 2015-Jun-29
- JIRA Ticket: LPS-56383
The liferay-ui:journal-article tag has been removed.
This affects developers using the liferay-ui:journal-article tag.
You should use the liferay-ui:asset-display tag instead.
Example
Old code:
<liferay-ui:journal-article
articleId="<%= article.getArticleId() %>"
/>
New code:
<liferay-ui:asset-display
className="<%= JournalArticleResource.class.getName() %>"
template="<%= article.getResourcePrimKey() %>"
/>
The liferay-ui:asset-display is a generic way to display any type of asset.
Therefore, the liferay-ui:journal-article tag is no longer necessary.
- Date: 2015-Jun-29
- JIRA Ticket: LPS-56383 and others
The Java package names changed for portlets that were extracted as OSGi modules in 7.0. Here is the complete list:
com.liferay.portlet.bookmarks→com.liferay.bookmarkscom.liferay.portlet.dynamicdatalists→com.liferay.dynamicdatalistscom.liferay.portlet.journal→com.liferay.journalcom.liferay.portlet.polls→com.liferay.pollscom.liferay.portlet.wiki→com.liferay.wiki
This affects developers using the portlets API from their own plugins.
Update the package imports to use the new package names. Any literal usage of
the portlet className should also be updated.
Package names have been adapted to the new condition of Liferay portlets as OSGi services.
- Date: 2015-Jul-01
- JIRA Ticket: LPS-56660
The DLFileEntryTypes_DDMStructures mapping table is no longer available.
This affects developers using the Document Library File Entry Type Local Service API.
Update the calls to addDDMStructureLinks, deleteDDMStructureLinks, and
updateDDMStructureLinks if you want to add, delete, or update references
between DLFileEntryType and DDMStructures.
This change was made to reduce the coupling between the two applications.
- Date: 2015-Jul-03
- JIRA Ticket: LPS-56705
The method render has been removed from the interfaces AssetRenderer and
WorkflowHandler.
This affects any Java code calling the method render on an AssetRenderer or
WorkflowHandler class, or Java classes overriding the render method of these
classes.
The method render was used to return the path of a JSP, including the
configuration of a portlet. That method is now available for the same
AssetRender API extending the BaseJSPAssetRenderer class, and is called
getJspPath.
If any logic was added to override the render method, it can now be added in
the include method.
This change was part of needed modifications to support adding asset renderers
and workflow handlers for portlets based on other technology different than JSP
(e.g., FreeMarker). The method include can now be used to create asset
renderers or workflow handlers with UIs written in FreeMarker or any other
framework.
- Date: 2015-Jul-08
- JIRA Ticket: LPS-56867
The constant PortletKeys.ADMIN_INSTANCE has been renamed as
PortletKeys.PORTAL_INSTANCES.
This affects developers using the old constant in their code; for example, creating a direct link to it. This is not common and usually not a good practice, so this should not affect many people.
You should rename the constant ADMIN_INSTANCE to PORTAL_INSTANCES
everywhere it is used.
This change was part of needed modifications to extract the Portal Instances portlet from the Admin portlet. The constant's old name was not accurate, since it originated from the old Admin portlet. Since the Portal Instances portlet is now extracted to its own module, the old name no longer resembles its usage.
Removed Support for filterFindBy Generation or InlinePermissionUtil Usage for Tables When the Primary Key Type Is Not long
- Date: 2015-Jul-21
- JIRA Ticket: LPS-54590
ServiceBuilder and inline permission filter support has been removed for
non-long primary key types.
This affects code that is using int, float, double, boolean, or short
type primary keys in the service.xml with inline permissions.
You should change the primary key type to long.
Inline permissioning was using the join method between two different data
types and that caused significant performance degradation with filterFindBy
queries.
- Date: 2015-Jul-31
- JIRA Ticket: LPS-57525
The bundled Vaadin 6.x JAR file has been removed from portal core.
This affects developers who are creating Vaadin portlet applications in Liferay Portal.
You should upgrade to Vaadin 7, bundle your vaadin.jar with your plugin, or
deploy Vaadin libraries to Liferay's OSGi container.
Vaadin 6.x is outdated and there are no plans for any new projects to be created with it. Therefore, developers should begin using Vaadin 7.x.
- Date: 2015-Jul-31
- JIRA Ticket: LPS-27113
The custom display styles of the navigation tag added using JSPs no longer work. They have been replaced by Application Display Templates (ADT).
This affects developers that use portlet properties with the following prefix:
navigation.display.style
This also affects developers that use the following attribute in the navigation tag:
displayStyleDefinition
To style the Navigation portlet, you should use ADTs instead of using custom styles in your JSPs. ADTs can be created from the UI of the portal by navigating to Site Settings → Application Display Templates. ADTs can also be created programatically.
Developers should use the ddmTemplateGroupId and ddmTemplateKey attributes
of the navigation tag to set the ADT that defines the style of the navigation.
ADTs allow you to change an application's look and feel without changing its JSP code.
- Date: 2015-Aug-12
- JIRA Ticket: LPS-57809
The URI attribute used to identify the AUI taglib has been renamed.
This affects developers that use the URI http://alloy.liferay.com/tld/aui in
their JSPs, XMLs, etc.
You should use the new AUI URI declaration:
Old:
http://alloy.liferay.com/tld/aui
New:
http://liferay.com/tld/aui
To stay consistent with other taglibs provided by Liferay, the AUI .tld file
was modified to start with the prefix liferay-. Due to this change, the XML
files used to automatically generate the AUI taglib were modified, changing the
AUI URI declaration.
- Date: 2015-Sep-17
- JIRA Ticket: LPS-58736
The tag runtime-portlet is no longer replaced by a portlet if it is found in
the body of a web content article.
This affects any web content in the database (JournalArticle table) that uses
this tag.
Embedding another portlet is only supported from a template. You should embed
the portlet by passing its name in a call to theme.runtime or using the right
tag in FreeMarker.
Example
In Velocity:
$theme.runtime("145")
In FreeMarker:
<@liferay_portlet_ext["runtime"] portletName="145" />
This change improves the performance of web content articles while enforcing a single way to embed portlets into the page for better testing.
- Date: 2015-Sep-23
- JIRA Ticket: LPS-58210
The tag liferay-ui:control-panel-site-selector has been deleted.
This affects developers who use this tag in their code.
You should consider using the tag liferay-ui:my-sites, or create your own
markup using the GroupService API.
This tag is no longer used and will no longer be maintained properly.
- Date: 2015-Sep-23
- JIRA Ticket: LPS-58210
The following methods have been deleted:
getControlPanelCategoriesMapgetControlPanelCategorygetControlPanelPortletsgetFirstMyAccountPortletgetFirstSiteAdministrationPortletgetSiteAdministrationCategoriesMapgetSiteAdministrationURLisCompanyControlPanelVisible
This affects developers that use any of the methods listed above.
In order to work with applications displayed in the Product Menu, developers
should call the PanelCategoryRegistry and PanelAppRegistry classes located
in the application-list-api module. These classes allow developers to interact
with categories and applications in the Control Panel.
These methods are no longer used and they will not work properly since they
cannot call the application-list-api from the portal context.
- Date: 2015-Sep-23
- JIRA Ticket: LPS-58210
The following methods have been deleted:
getControlPanelCategorygetURLSiteAdministration
This affects developers that use either of the methods listed above.
Site Administration is not a site per se; some applications are displayed in
that context. To create a link to an application that is displayed in Site
Administration, developers should use the method
PortalUtil.getControlPanelURL. In order to obtain the first application
displayed in a section of the Product Menu, developers should use the
application-list-api module to call the PanelCategoryRegistry and
PanelAppRegistry classes.
These methods are no longer used and they will not work properly since they
cannot call the application-list-api from the portal context.
Removed Control Panel from List of Sites Returned by Methods Group.getUserSitesGroups and User.getMySiteGroups
- Date: 2015-Sep-23
- JIRA Ticket: LPS-58862
The following methods had a boolean parameter to determine whether to include the Control Panel group:
Group.getUserSitesGroupsUser.getMySiteGroups
This boolean parameter should no longer be used.
This affects developers that use either of the methods listed above passing the
includeControlPanel parameter as true.
If you don't need the Control Panel, remove the false parameter. If you still
want to obtain a link to the Control Panel, you should do it in a different way.
The Control Panel is not a site per se; some applications are displayed in that
context. To create a link to an application that is displayed in the Control
Panel, developers should use the method PortalUtil.getControlPanelURL. In
order to obtain the first application displayed in a section of the Product
Menu, developers should use the application-list-api module to call the
PanelCategoryRegistry and PanelAppRegistry classes.
The Control Panel is no longer a site per se, but just a context in which some applications are displayed. This concept conflicts with the idea of returning a site called Control Panel in the Sites API.
- Date: 2015-Sep-24
- JIRA Ticket: LPS-53819
When a duplicate file entry is found by Documents and Media (D&M) services, a
DuplicateFileEntryException will be thrown. Previously, the exception
DuplicateFileException was used.
The DuplicateFileException is now raised only by Store
implementations.
Any caller of the addFileEntry methods in DLApp and DLFileEntry
local and remote services is affected.
Change the exception type from DuplicateFileException to
DuplicateFileEntryException in try-catch blocks surrounding calls
to D&M services.
The DuplicateFileException exception was used in two different
contexts:
- When creating a new file through D&M and a row in the database already existed for a file entry with the same title.
- When the stores tried to save a file and the underlying storage unit
(a file in the case of
FileSystemStore) already existed.
This made it impossible to detect and recover from store corruption issues, as they were undifferentiable from other errors.
- Date: 2015-Oct-15
- JIRA Ticket: LPS-30883
All references to the msnSn column in the Contacts table have been removed
from portal. All references to Windows Live Messenger have been removed from
properties, tests, classes, and the frontend. Also, the getMsnSn and
setMsnSn methods have been removed from the Contact and LDAPUser models.
The following classes have been removed:
MSNConnectorMSNMessageAdapter
The following constants have been removed:
CalEventConstants.REMIND_BY_MSNContactConverterKeys.MSN_SNPropsKeys.MSN_LOGINPropsKeys.MSN_PASSWORD
The following methods have been removed:
Contact.getMsnSnContact.setMsnSnLDAPUser.getMsnSnLDAPUser.setMsnSn
The following methods have been changed:
AdminUtil.updateUserContactLocalServiceUtil.addContactContactLocalServiceUtil.updateContactUserLocalServiceUtil.addContactUserLocalServiceUtil.updateContactUserLocalServiceUtil.updateUserUserServiceUtil.updateUser
This affects developers who use any of the classes, constants, or methods listed above.
When updating or adding a user or contact using one of the changed methods
above, remove the msnSn argument from the method call. If you are using one of
the removed items above, you should remove all references to them from your code
and look for alternatives, if necessary. Lastly, remove any references to the
msnSN column in the Contacts table from your SQL queries.
Since Microsoft dropped support for Windows Live Messenger, Liferay will no longer continue to support it.
- Date: 2015-Oct-22
- JIRA Ticket: LPS-59716
Liferay no longer supports integration with MySpace and AIM, ICQ, and Yahoo
Messenger instant messaging services. The corresponding aimSn, icqSn,
mySpaceSn, and ymSn columns have been removed from the Contacts table.
The following classes have been removed:
AIMConnectorICQConnectorYMConnector
The following constants have been removed:
CalEventConstants.REMIND_BY_AIMCalEventConstants.REMIND_BY_ICQCalEventConstants.REMIND_BY_YMContactConverterKeys.AIM_SNContactConverterKeys.ICQ_SNContactConverterKeys.MYSPACE_SNContactConverterKeys.YM_SNPropsKeys.AIM_LOGINPropsKeys.AIM_PASSWORDPropsKeys.ICQ_JARPropsKeys.ICQ_LOGINPropsKeys.ICQ_PASSWORDPropsKeys.YM_LOGINPropsKeys.YM_PASSWORD
The following methods have been removed:
getAimSngetIcqSngetMySpaceSngetYmSnsetAimSnsetIcqSnsetMySpaceSnsetYmSn
The following methods have been changed:
updateUseraddContact
The following portal properties have been removed:
aim.loginaim.passwordicq.jaricq.loginicq.passwordym.loginym.password
This affects developers who use any of the classes, constants, methods, or properties listed above.
When updating or adding a user or contact using one of the changed methods
above, remove the aimSn, icqSn, mySpaceSn, and ymSn arguments from the
method call. If you are using one of the removed items above, you should remove
all references to them from your code and look for alternatives, if necessary.
Lastly, remove from your SQL queries any references to former Contacts table
columns aimSn, icqSn, mySpaceSn, and ymSn.
Also, a reference to any one of the removed portal properties above no longer returns a value.
The services removed in this change are no longer popular enough to merit continued support.
Removed All Methods from SchedulerEngineHelper that Explicitly Schedule Jobs Using SchedulerEntry or Specify MessageListener Class Names
- Date: 2015-Oct-29
- JIRA Ticket: LPS-59681
The following methods were removed from SchedulerEngine:
SchedulerEngineHelper.addJob(Trigger, StorageType, String, String, Message, String, String, int)SchedulerEngineHelper.addJob(Trigger, StorageType, String, String, Object, String, String, int)SchedulerEngineHelper.schedule(SchedulerEntry, StorageType, String, int)
This affects developers that use the above methods to schedule jobs into the
SchedulerEngine.
You should update your code to call one of these methods:
SchedulerEngineHelper.schedule(Trigger, StorageType, String, String, Message, int)SchedulerEngineHelper.schedule(Trigger, StorageType, String, String, Object, int)
Instead of simply providing the class name of your scheduled job listener, you should follow these steps:
-
Instantiate your
MessageListener. -
Call
SchedulerEngineHelper.register(MessageListener, SchedulerEntry)to register yourSchedulerEventMessageListener.
The deleted methods provided facilities that aren't compatible with using declarative services in an OSGi container. The new approach allows for proper injection of dependencies into scheduled event message listeners.
- Date: 2015-Nov-03
- JIRA Ticket: LPS-60119
The asset.publisher.query.form.configuration property has been removed
from portal.properties.
This affects any hook that uses the asset.publisher.query.form.configuration
property.
If you are using this property to generate the UI for an Asset Entry Query
Processor, your Asset Entry Query Processor must now implement the include
method to generate the UI.
This change was made as a part of the ongoing strategy to modularize Liferay Portal.
- Date: 2015-Nov-03
- JIRA Ticket: LPS-58854
The following attributes and methods have been removed:
- The attribute
hoverof theliferay-ui:search-containertag. - The method
isHover()of theSearchContainerTagclass. - The attributes
classNameHover,hover,rowClassNameAlternate,rowClassNameAlternateHover,rowClassNameBody,rowClassNameBodyHoverof theliferay-search-containerJavaScript module.
This affects developers that use the hover attribute of the
liferay-ui:search-container tag.
You should update your code changing the CSS selector that defines how rows look
on hover to use the :hover and :nth-of-type CSS pseudo selectors instead.
Browsers support better ways to style content on hover in a way that doesn't penalize performance. Therefore, this change was made to increase the performance of hovering over content in Liferay.
- Date: 2015-Nov-03
- JIRA Ticket: LPS-58854
The JavaScript modules AppViewMove and AppViewSelect have been removed.
This affects developers that use these modules to configure select and move actions inside their applications.
If you are using any of these modules, you can make use of the following
SearchContainer APIs:
- Listen to the
rowToggledevent of the search container to be notified about changes to the search container state. - Configure your search container move options creating a
RowMoverand define the allowed move targets and associated actions. - Use the
registerActionmethod of the search container to execute your move logic when the user completes a move action.
The removed JavaScript modules contained too much logic and were difficult to decipher. It was also difficult to add this to an existing app. With this change, every app using a search container can use this functionality much easier.
- Date: 2015-Nov-20
- JIRA Ticket: LPS-60677
The mergeLayoutTags preference has been removed from the Asset Publisher.
This affects any Asset Publisher portlet that uses this preference.
There is nothing to update since this functionality is no longer used.
In previous versions of Liferay, some applications such as Blogs and Wiki shared the tags of their entries within the page. The Asset Publisher was able to use them to show other assets with the same tags. This functionality has changed, so the preference is no longer used.
- Date: 2015-Nov-20
- JIRA Ticket: LPS-60328
The liferay-ui:navigation tag has been removed and replaced with the
liferay-site-navigation:navigation tag.
Plugins or templates that are using the liferay-ui:navigation tag need to
update their usage of the tag.
You should import the liferay-site-navigation tag library (if necessary) and
update the tag namespace from liferay-ui:navigation to
liferay-site-navigation:navigation.
This change was made as a part of the ongoing strategy to modularize Liferay Portal by means of an OSGi container.
- Date: 2015-Nov-21
- JIRA Ticket: LPS-60705
The Software Catalog portlet and its associated services are no longer part of Liferay's source code or binaries.
This affects portals which were making use of the Software Catalog portlet to manage a catalog of their software. Developers who were making use of the software catalog services from their custom code are also affected.
There is no direct replacement for invocations to the Software Catalog services. In cases where it is really needed, it is possible to obtain the code from a previous release and include it in the custom product (subject to licensing).
The Software Catalog was developed to implement the very first versions of what later become Liferay's Marketplace. It was later replaced and has not been used by Liferay since then. It has also been used minimally outside of Liferay. The decision was made to remove it so Liferay could be more lightweight and free time to focus on other areas of the product that add more value.
Removed the liferay-ui:asset-categories-navigation Tag and Replaced with liferay-asset:asset-categories-navigation
- Date: 2015-Nov-25
- JIRA Ticket: LPS-60753
The liferay-ui:asset-categories-navigation tag has been removed and replaced
with the liferay-asset:asset-categories-navigation tag.
Plugins or templates that are using the liferay-ui:asset-categories-navigation
tag need to update their usage of the tag.
You should import the liferay-asset tag library (if necessary) and update the
tag namespace from liferay-ui:asset-categories-navigation to
liferay-asset:asset-categories-navigation.
This change was made as a part of the ongoing strategy to modularize Liferay Portal by means of an OSGi container.
- Date: 2015-Nov-30
- JIRA Ticket: LPS-60779
The liferay-ui:trash-empty tag has been removed and replaced with the
liferay-trash:empty tag.
Plugins and templates that are using the liferay-ui:trash-empty tag need to
update their usage of the tag.
You should import the liferay-trash tag library (if necessary) and update the
tag namespace from liferay-ui:trash-empty to liferay-trash:empty.
This change was made as a part of the ongoing strategy to modularize Liferay Portal by means of an OSGi container.
- Date: 2015-Nov-30
- JIRA Ticket: LPS-60779
The liferay-ui:trash-undo taglib has been removed and replaced with the
liferay-trash:undo tag.
Plugins and templates that are using the liferay-ui:trash-undo tag need to
update their usage of the tag.
You should import the liferay-trash tag library (if necessary) and update the
tag namespace from liferay-ui:trash-undo to liferay-trash:undo.
This change was made as a part of the ongoing strategy to modularize Liferay Portal by means of an OSGi container.
- Date: 2015-Dec-01
- JIRA Ticket: LPS-60843
The getPageOrderByComparator method has been removed from WikiUtil.
This affects developers that use this method in their code.
You should update your code to invoke
WikiPortletUtil.getPageOrderByComparator(String, String).
As part of the modularization efforts it has been considered that that this logic belongs to wiki-web module.
- Date: 2015-Dec-02
- JIRA Ticket: LPS-60995
The AUI Validator tag no longer forces custom validators (e.g., name="custom")
to be required, and are now optional by default.
This affects developers using custom validators, especially ones who relied on the field being implicitly required via the custom validator.
There are several cases where you should update your code to compensate for this change. First, blank value checking is no longer necessary, so places where blank values are checked should be updated.
Old Code:
return !val || val != A.one('#<portlet:namespace />publicVirtualHost').val();
New Code:
return val != A.one('#<portlet:namespace />publicVirtualHost').val();
Also, instead of using custom validators to determine if a field is required,
you should now use a conditional required validator.
Old Code:
<aui:validator errorMessage="you-must-specify-a-file-or-a-title" name="custom">
function(val, fieldNode, ruleValue) {
return !!val || !!A.one('#<portlet:namespace />file').val();
}
New Code:
<aui:validator errorMessage="you-must-specify-a-file-or-a-title" name="required">
function(fieldNode) {
return !A.one('#<portlet:namespace />file').val();
}
Lastly, custom validators that assumed validation would always run must now
explicitly pass the required validator. This is done by passing in the
<aui:validator name="required" /> element. The <aui:input> tag listed below
is an example of how to explicity pass the required validator:
<aui:input name="vowelsOnly">
<aui:validator errorMessage="must-contain-only-the-following-characters" name="custom">
function(val, fieldNode, ruleValue) {
var allowedCharacters = 'aeiouy';
var regex = new RegExp('[^' + allowedCharacters + ']');
return !regex.test(val);
}
</aui:validator>
<aui:validator name="required" />
</aui:input>
A custom validator caused the field to be implicitly required. This meant that all validators for the field would be evaluated. This created a condition where you could not combine custom validators with another validator for an optional field.
For example, imagine an optional field which has an email validator, plus a
custom validator which checks for email addresses within a specific domain
(e.g., example.com). There was no way for this optional field to pass
validation. Even if you handled blank values in your custom validator, that
blank value would fail the email validator.
This change requires most custom validators to be refactored, but allows greater flexibility for all developers.
- Date: 2015-Dec-02
- JIRA Ticket: LPS-60810
All Recycle Bin logic in Documents and Media services was moved from
DLAppService into the new DLTrashService service interface. All moved
methods have the same name and signatures.
This affects any local or remote caller of DLAppService.
As all methods have been simply moved into the new service, calling the
equivalent method on DLTrashService suffices.
Documents and Media services have complex interdependencies that result in
circular dependencies. Until now, DLAppService was responsible for exposing
the Recycle Bin logic, delegating it to other components. The problem was, the
components depended on DLAppService to implement their logic. Extracting the
services from DLAppService was the only sensible solution to this circularity.
- Date: 2015-Dec-02
- JIRA Ticket: LPS-60967
The liferay-ui:flags tag has been deprecated and replaced with the
liferay-flags:flags tag.
Plugins or templates that are using the liferay-ui:flags tag need to update
their usage of the tag.
You should import the liferay-flags tag library (if necessary) and update the
tag namespace from liferay-ui:flags to liferay-flags:flags.
This change was made as a part of the ongoing strategy to modularize Liferay Portal by means of an OSGi container.
- Date: 2015-Dec-14
- JIRA Ticket: LPS-61326
The liferay-ui:diff tag has been removed and replaced with the
liferay-frontend:diff tag.
Plugins and templates that are using the liferay-ui:diff tag need to update
their usage of the tag.
You should import the liferay-frontend tag library (if necessary) and update
the tag namespace from liferay-ui:diff to liferay-frontend:diff.
This change was made as a part of the ongoing strategy to modularize Liferay Portal by means of an OSGi container.
- Date: 2016-Jan-06
- JIRA Ticket: LPS-61683
The ${theme} variable previously injected in the FreeMarker context providing
access to various tags and utilities is no longer available.
This affects FreeMarker templates that are using the ${theme} variable.
All the tags and utility methods formerly accessed via the ${theme} variable
should now be accessed directly via tags.
Example 1
${theme.runtime("com.liferay.portal.kernel.servlet.taglib.ui.BreadcrumbEntry", portletProviderAction.VIEW, "", default_preferences)}
can be replaced by:
<@liferay_portlet["runtime"]
defaultPreferences=default_preferences
portletProviderAction=portletProviderAction.VIEW
portletProviderClassName="com.liferay.portal.kernel.servlet.taglib.ui.BreadcrumbEntry"
/>
Example 2
${theme.include(content_include)}
can be replaced by:
<@liferay_util["include"] page=content_include />
Example 3
${theme.wrapPortlet("portlet.ftl", content_include)}
can be replaced by:
<@liferay_theme["wrap-portlet"] page="portlet.ftl">
<@liferay_util["include"] page=content_include />
</@>
Example 4
${theme.iconHelp(portlet_description)}
can be replaced by:
<@liferay_ui["icon-help"] message=portlet_description />
Example 5
${nav_item.icon()}
can be replaced by:
<@liferay_theme["layout-icon"] layout=${nav_item.getLayout()} />
Previously, the {$theme} variable was being injected with the
VelocityTaglibImpl class. This created coupling between template engines and
coupling between specific tags and template engines at the same time.
FreeMarker already offers native support for tags which cover all the
functionality originally provided by the {$theme} variable. Removing this
coupling helps future development while still keeping all the existing
functionality.
- Date: 2016-Jan-07
- JIRA Ticket: LPS-54620 and LPS-61820
The portlet configuration options (e.g., configuration, export/import, look and feel, etc.) were always displayed in every view of the portlet and couldn't be customized.
With Lexicon, the configuration options displayed are based on the portlet's context, so not all options will always be displayed.
This affects portlets that should always display all configuration options no matter which view of the portlet is rendered.
If you don't apply any change to your source code, you will experience the following behaviors based on the portlet type:
-
Struts Portlet: If you've defined a
view-actioninit parameter, the configuration options are only displayed for that particular view when invoking a URL with a parameterstruts_actionwith the value indicated in theview-actioninit parameter and also in the default view of the portlet (when there is nostruts_actionparameter in the request). -
Liferay MVC Portlet: If you've defined a
view-templateinit parameter, the configuration options are only displayed when that template is rendered by invoking a URL with a parametermvcPathwith the value indicated in theview-templateinit parameter. and also in the default view of the portlet (when there is nomvcPathparameter in the request). -
If it's a portlet using any other framework, the configuration options are always displayed.
In order to keep the old behavior of adding the configuration options in every
view, you need to add the init parameter
always-display-default-configuration-icons with the value true.
Lexicon patterns require the ability to specify different configuration options
depending on the view of the portlet by adding or removing options. This can be
easily achieved by using the PortletConfigurationIcon classes.
- Date: 2016-Jan-08
- JIRA Ticket: LPS-61853
The AssetRenderer interface's getURLView method has changed and now returns
String instead of PortletURL.
This affects all custom assets that implement the AssetRenderer interface.
You should update the method signature to reflect that it returns a String and
you should adapt your implementation accordingly.
In general, it should be as easy as returning portletURL.toString().
The API was forcing implementations to return a PortletURL, making it
difficult to return another type of link. For example, in the case of Bookmarks,
developers wanted to automatically redirect to other potential URLs.
- Date: 2016-Jan-11
- JIRA Ticket: LPS-61900
The NavItem interface has changed and the method icon that would render the
nav item icon has been removed.
This affects all themes using the nav_item.icon() method.
You should update your code to call the method nav_item.iconURL to return the
image's URL and then use it as you prefer.
Example:
<img alt="Page Icon" class="layout-logo" src="<%= nav_item.iconURL()" />
To keep the previous behavior in Velocity:
$theme.layoutIcon($nav_item.getLayout())
To keep the previous behavior in FreeMarker:
<@liferay_theme["layout-icon"] layout=nav_item_layout />
The API was forcing developers to have a dependency on a taglib, which didn't allow for much flexibility.
- Date: 2016-Jan-19
- JIRA Ticket: LPS-61952
Split packages are caused when two or more bundles export the same package name and version. When the classloader loads a package, exactly one exporter of that package is chosen; so if a package is split across multiple bundles, then an importer only sees a subset of the package.
The portal-kernel and portal-impl folders have many packages with the same
name. Therefore, all of these packages are affected by the split package
problem.
You should rename duplicated package names if they currently exist somewhere else.
Example
-
com.liferay.counter→com.liferay.counter.kernel -
com.liferay.mail.model→com.liferay.mail.kernel.model -
com.liferay.mail.service→com.liferay.mail.kernel.service -
com.liferay.mail.util→com.liferay.mail.kernel.util -
com.liferay.portal.exception→com.liferay.portal.kernel.exception -
com.liferay.portal.jdbc.pool.metrics→com.liferay.portal.kernel.jdbc.pool.metrics -
com.liferay.portal.kernel.mail→com.liferay.mail.kernel.model -
com.liferay.portal.layoutconfiguration.util→com.liferay.portal.kernel.layoutconfiguration.util -
com.liferay.portal.layoutconfiguration.util.xml→com.liferay.portal.kernel.layoutconfiguration.util.xml -
com.liferay.portal.mail→com.liferay.portal.kernel.mail -
com.liferay.portal.model→com.liferay.portal.kernel.model -
com.liferay.portal.model.adapter→com.liferay.portal.kernel.model.adapter -
com.liferay.portal.model.impl→com.liferay.portal.kernel.model.impl -
com.liferay.portal.portletfilerepository→com.liferay.portal.kernel.portletfilerepository -
com.liferay.portal.repository.proxy→com.liferay.portal.kernel.repository.proxy -
com.liferay.portal.security.auth→com.liferay.portal.kernel.security.auth -
com.liferay.portal.security.exportimport→com.liferay.portal.kernel.security.exportimport -
com.liferay.portal.security.ldap→com.liferay.portal.kernel.security.ldap -
com.liferay.portal.security.membershippolicy→com.liferay.portal.kernel.security.membershippolicy -
com.liferay.portal.security.permission→com.liferay.portal.kernel.security.permission -
com.liferay.portal.security.permission.comparator→com.liferay.portal.kernel.security.permission.comparator -
com.liferay.portal.security.pwd→com.liferay.portal.kernel.security.pwd -
com.liferay.portal.security.xml→com.liferay.portal.kernel.security.xml -
com.liferay.portal.service.configuration→com.liferay.portal.kernel.service.configuration -
com.liferay.portal.service.http→com.liferay.portal.kernel.service.http -
com.liferay.portal.service.permission→com.liferay.portal.kernel.service.permission -
com.liferay.portal.service.persistence.impl→com.liferay.portal.kernel.service.persistence.impl -
com.liferay.portal.theme→com.liferay.portal.kernel.theme -
com.liferay.portal.util→com.liferay.portal.kernel.util -
com.liferay.portal.util.comparator→com.liferay.portal.kernel.util.comparator -
com.liferay.portal.verify.model→com.liferay.portal.kernel.verify.model -
com.liferay.portal.webserver→com.liferay.portal.kernel.webserver -
com.liferay.portlet→com.liferay.kernel.portlet -
com.liferay.portlet.admin.util→com.liferay.admin.kernel.util -
com.liferay.portlet.announcements→com.liferay.announcements.kernel -
com.liferay.portlet.asset→com.liferay.asset.kernel -
com.liferay.portlet.backgroundtask.util.comparator→com.liferay.background.task.kernel.util.comparator -
com.liferay.portlet.blogs→com.liferay.blogs.kernel -
com.liferay.portlet.blogs.exception→com.liferay.blogs.kernel.exception -
com.liferay.portlet.blogs.model→com.liferay.blogs.kernel.model -
com.liferay.portlet.blogs.service→com.liferay.blogs.kernel.service -
com.liferay.portlet.blogs.service.persistence→com.liferay.blogs.service.persistence -
com.liferay.portlet.blogs.util.comparator→com.liferay.blogs.kernel.util.comparator -
com.liferay.portlet.documentlibrary→com.liferay.document.library.kernel -
com.liferay.portlet.dynamicdatamapping→com.liferay.dynamic.data.mapping.kernel -
com.liferay.portlet.expando→com.liferay.expando.kernel -
com.liferay.portlet.exportimport→com.liferay.exportimport.kernel -
com.liferay.portlet.imagegallerydisplay.display.context→com.liferay.image.gallery.display.kernel.display.context -
com.liferay.portlet.journal.util→com.liferay.journal.kernel.util -
com.liferay.portlet.layoutsadmin.util→com.liferay.layouts.admin.kernel.util -
com.liferay.portlet.messageboards→com.liferay.message.boards.kernel -
com.liferay.portlet.messageboards.constants→com.liferay.message.boards.kernel.constants -
com.liferay.portlet.messageboards.exception→com.liferay.message.boards.kernel.exception -
com.liferay.portlet.messageboards.model→com.liferay.message.boards.kernel.model -
com.liferay.portlet.messageboards.service→com.liferay.message.boards.kernel.service -
com.liferay.portlet.messageboards.service.persistence→com.liferay.message.boards.kernel.service.persistence -
com.liferay.portlet.messageboards.util→com.liferay.message.boards.kernel.util -
com.liferay.portlet.messageboards.util.comparator→com.liferay.message.boards.kernel.util.comparator -
com.liferay.portlet.mobiledevicerules→com.liferay.mobile.device.rules -
com.liferay.portlet.portletconfiguration.util→com.liferay.portlet.configuration.kernel.util -
com.liferay.portlet.rolesadmin.util→com.liferay.roles.admin.kernel.util -
com.liferay.portlet.sites.util→com.liferay.sites.kernel.util -
com.liferay.portlet.social→com.liferay.social.kernel -
com.liferay.portlet.trash→com.liferay.trash.kernel -
com.liferay.portlet.useradmin.util→com.liferay.users.admin.kernel.util -
com.liferay.portlet.ratings→com.liferay.ratings.kernel -
com.liferay.portlet.ratings.definition→com.liferay.ratings.kernel.definition -
com.liferay.portlet.ratings.display.context→com.liferay.ratings.kernel.display.context -
com.liferay.portlet.ratings.exception→com.liferay.ratings.kernel.exception -
com.liferay.portlet.ratings.model→com.liferay.ratings.kernel.model -
com.liferay.portlet.ratings.service→com.liferay.ratings.kernel.service -
com.liferay.portlet.ratings.service.persistence→com.liferay.ratings.kernel.service.persistence -
com.liferay.portlet.ratings.transformer→com.liferay.ratings.kernel.transformer
This change was necessary to solve the current split package problems and prevent future ones.
- Date: 2016-Jan-19
- JIRA Ticket: LPS-62208
The aui:column tag has been removed and replaced with the aui:col tag.
Plugins or templates that are using the aui:column tag must update their usage
of the tag.
You should import the aui tag library (if necessary) and update the tag
namespace from aui:column to aui:col.
This change was made as a part of the ongoing strategy to modularize Liferay Portal by means of an OSGi container.
- Date: 2016-Jan-25
- JIRA Ticket: LPS-62251
The title field of file entries was optional as long as a source file name was
provided. To avoid confusion, the title is now required by the API and is filled
automatically by the UI when a source file name is present.
This affects any user of the local or remote API. Users of the Web UI are unaffected.
You should pass a non-null, non-empty string for the title parameter of the
addFileEntry and updateFileEntry methods.
The title field was marked as mandatory, but it was possible to create a
document without filling it, as the backend would infer a value from the source
file name automatically. This was considered confusing from a UX perspective.
- Date: 2016-Jan-28
- JIRA Ticket: LPS-62643
The DLUtil.getImagePreviewURL and DLUtil.getThumbnailSrc methods return an
empty string if there are no previews or thumbnails for the specific image,
video, or document.
Previously, if there were no previews or thumbnails, these methods would return a URL to an image based on the document.
This affects any developer invoking DLUtil.getImagePreviewURL or
DLUtil.getThumbnailSrc.
You should be aware that the method could return an empty string and act
accordingly. For example, you could display the documents-and-media Lexicon
icon instead.
In order to display the documents-and-media Lexicon icon in Documents and
Media, this change was necessary.
- Date: 2016-Feb-04
- JIRA Ticket: LPS-62922
The aui:button-item tag has been removed and replaced with the aui:button
tag.
Plugins or templates that are using the aui:button-item tag must update their
usage of the tag.
You should import the aui tag library (if necessary) and update the tag
namespace from aui:button-item to aui:button.
This change was made as a part of the ongoing strategy to remove deprecated code.
- Date: 2016-Feb-05
- JIRA Ticket: LPS-62920
The WAP functionality has been removed.
This affects developers that use the WAP functionality.
If you are using any of the following methods, you need to remove the parameters in those methods related to WAP.
LayoutLocalServiceUtil.updateLookAndFeelLayoutRevisionLocalServiceUtil.addLayoutRevisionLayoutRevisionLocalServiceUtil.updateLayoutRevisionLayoutRevisionServiceUtil.addLayoutRevisionLayoutServiceUtil.updateLookAndFeelLayoutSetLocalServiceUtil.updateLookAndFeelLayoutSetServiceUtil.updateLookAndFeelThemeLocalServiceUtil.getColorSchemeThemeLocalServiceUtil.getControlPanelThemesThemeLocalServiceUtil.getPageThemesThemeLocalServiceUtil.getTheme
This change was made because WAP is an obsolete functionality.
- Date: 2016-Feb-08
- JIRA Ticket: LPS-62935
The aui:layout tag has been removed with no direct replacement.
Plugins or templates that are using the aui:layout tag must remove their usage
of the tag.
There is no direct replacement. You should remove all usages of the aui:layout
tag.
This change was made as a part of the ongoing strategy to remove deprecated tags.
- Date: 2016-Feb-10
- JIRA Ticket: LPS-63101
The liferay-portlet:icon-back tag has been deprecated with no direct
replacement.
Plugins or templates that are using the liferay-portlet:icon-back tag must
remove their usage of the tag.
There is no direct replacement. You should remove all usages of the
liferay-portlet:icon-back tag.
This change was made as a part of the ongoing strategy to deprecate unused tags.
- Date: 2016-Feb-10
- JIRA Ticket: LPS-63106
The liferay-security:encrypt tag has been deprecated with no direct
replacement.
Plugins or templates that are using the liferay-security:encrypt tag must
remove their usage of the tag.
There is no direct replacement. You should remove all usages of the
liferay-security:encrypt tag.
This change was made as a part of the ongoing strategy to deprecate unused tags.
- Date: 2016-Feb-17
- JIRA Ticket: LPS-63180
com.liferay.portal.kernel.scripting.ScriptingExecutorno longer uses the provided class loaders in the eval methods.com.liferay.portal.kernel.scripting.Scriptingno longer uses the provided class loaders and servlet context names in eval and exec methods.
- All implementations of
com.liferay.portal.kernel.scripting.ScriptingExecutorare affected. - All classes that call
com.liferay.portal.kernel.scripting.Scriptingare affected.
You should remove class loader and servlect context parameters from calls to the modified methods.
This change was made since custom class loader management is no longer necessary in the OSGi container.
User Operation and Importer/Exporter Classes and Utilities Have Been Moved or Removed From portal-kernel
- Date: 2016-Feb-17
- JIRA Ticket: LPS-63205
-
com.liferay.portal.kernel.security.exportimport.UserImporter,com.liferay.portal.kernel.security.exportimport.UserExporter, andcom.liferay.portal.kernel.security.exportimport.UserOperationhave been moved from portal-kernel to the portal-security-export-import-api module. -
com.liferay.portal.kernel.security.exportimport.UserImporterUtilandcom.liferay.portal.kernel.security.exportimport.UserExporterUtilhave been removed with no replacement.
-
All implementations of
com.liferay.portal.kernel.security.exportimport.UserImporterorcom.liferay.portal.kernel.security.exportimport.UserExporterare affected. -
All code that uses
com.liferay.portal.kernel.security.exportimport.UserImporterUtil,com.liferay.portal.kernel.security.exportimport.UserExporterUtil,com.liferay.portal.kernel.security.exportimport.UserImporter, orcom.liferay.portal.kernel.security.exportimport.UserExporteris affected.
If you are in an OSGi module, you can simply inject the UserImporter or UserExporter references
@Reference
private UserExporter_userExporter;
@Reference
private UserImporter _userImporter;
If you are in a legacy WAR or WAB, you will need a snippet like:
Bundle bundle = FrameworkUtil.getBundle(getClass());
BundleContext bundleContext = bundle.getBundleContext();
ServiceReference<UserImporter> serviceReference =
bundleContext.getServiceReference(UserImporter.class);
UserImporter userImporter = bundleContext.getService(serviceReference);
The change was made to improve modularity of the user import/export subsystem in the product.
- Date: 2016-Feb-22
- JIRA Ticket: LPS-63466
The category entry for Site Administration → Users has been deprecated in favor of Site Administration → Members.
All developers who specified a control-panel-entry-category to be visible in
Site Administration → Users are affected.
You should change the entry from site_administration.users to
site_administration.members to make it visible in the category.
This change standardizes naming conventions and separates concepts between Users in the Control Panel and Site Members.
- Date: 2016-Feb-25
- JIRA Ticket: LPS-63667
The category entry for Site Administration → Pages has been deprecated in favor of Site Administration → Navigation.
All developers who specified a control-panel-entry-category to be visible in
Site Administration → Pages are affected.
You should change the entry from site_administration.pages to
site_administration.navigation to make it visible in the category.
This change standardizes naming conventions and separates concepts in the Product Menu.
- Date: 2016-Mar-03
- JIRA Ticket: LPS-63928
The class com.liferay.dynamic.data.mapping.util.DDMXMLUtil has been removed
with no replacement.
All code that uses com.liferay.dynamic.data.mapping.util.DDMXMLUtil is
affected.
In an OSGi module, simply inject the DDMXML reference:
@Reference
private DDMXML _ddmXML;
In a legacy WAR or WAB, you need to get a DDMXML service reference from the bundle context:
Bundle bundle = FrameworkUtil.getBundle(getClass());
BundleContext bundleContext = bundle.getBundleContext();
ServiceReference<UserImporter> serviceReference =
bundleContext.getServiceReference(DDMXML.class);
DDMXML ddmXML = bundleContext.getService(serviceReference);
This change was made to improve modularity of the dynamic data mapping subsystem.
- Date: 2016-Mar-04
- JIRA Ticket: LPS-63109
The method FlagsEntryService.addEntry now throws a PortalException if the
reporterEmailAddress is not a valid email address.
Any caller of the method FlagsEntryService.addEntry is affected.
You should consider checking for the PortalException in try-catch blocks and
adapt your code accordingly.
This change prevents providing an incorrect email address when adding flag entries.
- Date: 2016-Mar-10
- JIRA Ticket: LPS-64052
PHP portlets are no longer supported.
This affects any portlet using the class
com.liferay.util.bridges.php.PHPPortlet.
You should port your PHP portlet to a different technology.
This change simplifies future maintenance of the portal. This support could be added back in the future as an independent module.
- Date: 2016-Mar-16
- JIRA Ticket: LPS-48334
The following things have been changed:
- Removed the
com.liferay.frontend.editor.bbcode.webOSGi bundle - Removed all hardcoded references/logic for the editor
- Added a log warning and logic to upgrade the editor property to
ckeditor_bbcodeif the oldbbcodeis being used. This log warning and logic will be removed in the future, along with LPS-64099.
This affects anyone who has the property
editor.wysiwyg.portal-web.docroot.html.portlet.message_boards.edit_message.bb_code.jsp
set to bbcode in portal properties (e.g., portal-ext.properties).
You should modify your portal-ext.properties file to remove the property
editor.wysiwyg.portal-web.docroot.html.portlet.message_boards.edit_message.bb_code.jsp.
Since Liferay Frontend Editor BBCode Web has been deprecated since 6.1, it was time to remove it completely. This frees up development and support resources to focus on supported features.
- Date: 2016-Mar-17
- JIRA Ticket: LPS-64370
The property asset.entry.validator has been removed from portal.properties.
This affects any installation with a customized asset validator.
You should create a new OSGi component that implements AssetEntryValidator and
define for which models it will be applicable by using the model.class.name
OSGi property, or an asterisk if it applies to any model.
If you were using the MinimalAssetEntryValidator, this functionality can still
be added by deploying the module asset-tags-validator.
This change has been made as part of the modularization efforts to decouple different parts of the portal.
- Date: 2016-May-13
- JIRA Ticket: LPS-54111
The utilities swfupload and video_player have been removed.
This affects anyone who is using the swfupload AlloyUI module or any of the
associated swfupload_f*.swf and mpw_player.swf flash movies.
There are better, more standard ways to achieve upload currently. For instance, you can use A.Uploader to manage your uploads consistently across browsers.
For audio/video reproduction, you should update your code to use A.Audio and A.Video.
This change removes outdated code no longer being used in the platform. In addition, this change avoids future security issues from outdated flash movies.
- Date: 2016-Jul-29
- JIRA Ticket: LPS-58672
All Journal portlet properties have been moved to an OSGI configuration.
This affects anyone who is overriding the Journal portlet's portlet.properties
file.
Instead of overriding the Journal portlet's portlet.properties file, you can
manage the properties from Portal's configuration administrator. This can be
accessed by navigating to Liferay's Control Panel → System Settings
→ Web Experience and selecting the appropriate Web Content category.
This change was made as part of modularization efforts to ease portlet configuration changes.