Liferay's Blade samples provides bootstrap project environments for all major build tools in common use for Java projects so that Liferay development can start quickly and easily. These templates can be copied freely and contributions are welcome. See the Contribution Guidelines for more information on how to contribute new sample projects and/or documentation.

The template projects are categorized under three build tools:

• gradle - A set of Liferay projects that can be bootstrapped onto the com.liferay.plugin (a Gradle plugin) based development environment.
• liferay-workspace - A set of Liferay projects configured to work in a Liferay Workspace environment.
• maven - A set of Liferay projects that can be bootstrapped onto the Maven development environment.

When contributing a new sample, you must include accompanying documentation.

You can contribute additional template samples by creating the project for one of the three build tools and sending a pull request to liferay/liferay-blade-samples. A repository admin will review the submission and replicate the project for the other three build tools, once the submission is approved.

You can contribute documentation by adding a README.markdown file to the root folder of a sample project. This article should include the following sections:

• What does this sample do when it's deployed?
• What API(s) and/or code components does this sample highlight?
• How does this sample leverage the API(s) and/or code component?

For example, the Resource Bundle Override article explains the resource-bundle-override sample using the aforementioned sections.

You can send a pull request to codyhoag/liferay-blade-samples for documentation-only submissions, or tag @codyhoag in a new sample contributed to liferay/liferay-blade-samples that includes documentation.

The template projects also demonstrate how to use various frameworks:

• Blueprint
• Declarative Services (DS)
• OSGi API

Liferay does not provide a Blueprint implementation out of the box. To use the Blueprint modules provided in Blade, you must deploy a Blueprint implementation such as Apache Aries - Blueprint. Three bundles are needed:

• Apache Aries Blueprint Bundle
• Apache Aries Blueprint Annotation API
• Apache Aries Proxy Bundle

Simply download the bundles from mvnrepository and drop them in your osgi/modules folder before deploying Blueprint bundles.

Template project description: Demonstrates the MVCActionCommand extension point. It integrates the action command named greet with portlet greeter. To see how this example works, a portlet plugin with a portlet named greeter (javax.portlet.name='greeter') should be deployed. The command adds a key greeting_message to Liferay SessionMessages, along with a session attribute GREETER_MESSAGE. You can independently deploy the bundle blade.portlet.actioncommand (i.e., refresh the bundle without the need to redeploy the Portlet plugin).

Template project description: Demonstrates how to use the Blueprint framework for registering a Liferay MVC portlet.

Template project description: Demonstrates the ConfigurationAction integration point.

Template project description: Demonstrates how to use the DS (Declarative Services) framework for registering a Liferay MVC portlet.

Template project description: Demonstrates how to apply PortletFilters.

Template project description: Demonstrates a simple FreeMarker portlet.

Refer to this sample's Readmes for more information.

Template project description: Demonstrates a simple JSP portlet.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Template project description: Demonstrates how to use the raw OSGI APIs for registering a Liferay MVC portlet.

Extension point description: Lets developers create custom JAX-RS standard based RESTful services.

Template project description: Demonstrates how to create a JAX-RS service that lists Liferay users.

NOTE: Before this service is accessible, the developer needs to configure endpoints for it. To do so, go to the Control Panel → System → System Settings → Foundation and then

• Search for CXF Endpoints
• Create a new CXFEndpoint publisher configuration providing a context path (e.g., /rest-test).
• Go back to System Settings → Foundation and select REST Extender.
• Create a new REST extender configuration (i.e., search with rest) providing context paths (e.g., /rest-test) and jaxrs.applications.filters set to (jaxrs.application=true).

Then you can access the service via http://localhost:8080/o/rest-test/blade.users/list/.

Refer to this sample's Readme for more information.

Template project description: Demonstrates how to create a Service Builder project separated into three bundles:

• api bundle is for interfaces
• service bundle is for implementations
• web bundle is a portlet calling the generated services

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Template project description: Demonstrates a hook for auth.failure and auth.max.failures.

Template project description: Uses Apache Shiro for hooking auth.pipeline.pre.

Template project description: Demonstrates the AutoLogin integration point.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Extension point description: Lets a developer provide (or overwrite) friendly URL mapping for portlets.

Template project description: Demonstrates how to create a FriendlyURLMapper for the standard NetworkUtilities portlet.

The NetworkUtilities portlet does not provide friendly URLs out of the box. To test this plugin, put a NetworkUtilities portlet on the home page. After deploying this plugin, you can access its tabs directly using the following URLs:

• http://localhost:8080/web/guest/home/-/NetworkUtilities/dns-lookup
• http://localhost:8080/web/guest/home/-/NetworkUtilities/whois

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Extension point description: Demonstrates how to implement a Liferay com.liferay.portal.kernel.events.LifecycleAction. This API replaces all the legacy lifecycle events such as com.liferay.portal.kernel.events.Action, com.liferay.portal.kernel.events.SessionAction, and com.liferay.portal.kernel.events.SimpleAction. Connecting a LifecycleAction to a particular event is determined by the OSGi service property key. The following keys are supported:

• application.shutdown.events - fired during destruction of company instances at portal shutdown.
• application.startup.events - fired during initialization of company instances at portal start, or when a new instance is created.
• global.shutdown.events - fired during destruction of the portal's main servlet.
• global.startup.events - fire during initialization of the portal's main servlet.
• layout.configuration.action.delete - fired during destruction of a page (Layout).
• layout.configuration.action.update - fired during initialization of a page (Layout).
• login.events.post - fired immediately following login.
• login.events.pre - fired immediately prior to login.
• logout.events.post - fired immediately following logout.
• logout.events.pre - fired immediately prior to logout.
• servlet.service.events.post - fired following requests to the portal (including all portlet container requests).
• servlet.service.events.pre - fired prior to requests to the portal (including all portlet container requests & post login).
• servlet.session.create.events - fired during creation of a portal's HTTP session.
• servlet.session.destroy.events - fired during destruction of a portal's HTTP session.

Template project description: Demonstrates a hook for login.events.pre.

Refer to this sample's Readme for more information.

Template project description: Demonstrates how to make a hook for a PollerProcessor.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Template project description: Demonstrates how to write a StrutsAction.

Template project description: Demonstrates how to write a StrutsPortletAction.

Template project description: Demonstrates how to wrap the UserLocalService with custom a UserLocalServiceWrapper.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

Refer to this sample's Readme for more information.

This project does not yet have template projects for the following extension points. We encourage you to contribute some!

• com.liferay.mail.util.Hook
• com.liferay.portal.kernel.atom.AtomCollectionAdapter
• com.liferay.portal.kernel.format.PhoneNumberFormat
• com.liferay.portal.kernel.lar.PortletDataHandler
• com.liferay.portal.kernel.lar.StagedModelDataHandler
• com.liferay.portal.kernel.lock.LockListener
• com.liferay.portal.kernel.notifications.UserNotificationHandler
• com.liferay.portal.kernel.pop.MessageListener
• com.liferay.portal.kernel.portlet.FriendlyURLMapper
• com.liferay.portal.kernel.portlet.PortletLayoutListener
• com.liferay.portal.kernel.sanitizer.Sanitizer
• com.liferay.portal.kernel.scheduler.SchedulerEntry
• com.liferay.portal.kernel.search.Indexer
• com.liferay.portal.kernel.search.OpenSearch
• com.liferay.portal.kernel.servlet.URLEncoder
• com.liferay.portal.kernel.template.TemplateHandler
• com.liferay.portal.kernel.template.TemplateManager
• com.liferay.portal.kernel.trash.TrashHandler
• com.liferay.portal.kernel.upgrade.UpgradeProcess (call the Release service)
• com.liferay.portal.kernel.webdav.WebDAVStorage
• com.liferay.portal.kernel.workflow.WorkflowHandler
• com.liferay.portal.kernel.xmlrpc.Method
• com.liferay.portal.model.ModelListener
• com.liferay.portal.security.auth.AuthToken
• com.liferay.portal.security.auth.AuthVerifierConfiguration
• com.liferay.portal.security.auth.AutoLogin
• com.liferay.portal.security.auth.EmailAddressGenerator
• com.liferay.portal.security.auth.EmailAddressValidator
• com.liferay.portal.security.auth.FullNameGenerator
• com.liferay.portal.security.auth.FullNameValidator
• com.liferay.portal.security.auth.ScreenNameGenerator
• com.liferay.portal.security.auth.ScreenNameValidator
• com.liferay.portal.security.ldap.AttributesTransformer
• com.liferay.portal.security.membershippolicy.OrganizationMembershipPolicy
• com.liferay.portal.security.membershippolicy.RoleMembershipPolicy
• com.liferay.portal.security.membershippolicy.SiteMembershipPolicy
• com.liferay.portal.security.membershippolicy.UserGroupMembershipPolicy
• com.liferay.portal.security.permission.BaseModelPermissionChecker
• com.liferay.portal.security.permission.PermissionPropagator
• com.liferay.portal.security.pwd.Toolkit
• com.liferay.portal.verify.VerifyProcess
• com.liferay.portlet.asset.model.AssetRendererFactory
• com.liferay.portlet.ControlPanelEntry
• com.liferay.portlet.DefaultControlPanelEntryFactory
• com.liferay.portlet.dynamicdatamapping.render.DDMFormFieldRenderer
• com.liferay.portlet.dynamicdatamapping.util.DDMDisplay
• com.liferay.portlet.expando.model.CustomAttributesDisplay
• com.liferay.portlet.social.model.SocialActivityInterpreter
• com.liferay.portlet.social.model.SocialRequestInterpreter
• java.util.ResourceBundle
• javax.portlet.filter.ActionFilter
• javax.portlet.filter.EventFilter
• javax.portlet.filter.RenderFilter
• javax.portlet.filter.ResourceFilter
• javax.portlet.PreferencesValidator
• javax.servlet.Filter (Liferay InvokerFilterChain Filters)

License

OSGI R5

OSGI Compendium R5

Blueprint