com.vaadin.osgi.liferay.VaadinLiferayPortletConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vaadin-liferay-integration Show documentation

Liferay 7+ OSGi portlet support

There is a newer version: 8.27.3

Show newest version

/*
 * Copyright (C) 2000-2024 Vaadin Ltd
 *
 * This program is available under Vaadin Commercial License and Service Terms.
 *
 * See  for the full
 * license.
 */
package com.vaadin.osgi.liferay;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.portlet.Portlet;

/**
 * This annotation is used to inform the
 * {@link PortletUIServiceTrackerCustomizer} that this UI should be wrapped in a
 * {@link Portlet} and provides the necessary configuration for that.
 * 
 * This only applies to Liferay Portal 7+ with OSGi support.
 *
 * @author Vaadin Ltd.
 *
 * @since 8.1
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
public @interface VaadinLiferayPortletConfiguration {
    /**
     * Category of the portlet in Liferay menus. By default
     * category.vaadin.
     */
    String category() default "category.vaadin";

    /**
     * Portlet name, must conform to the portlet specification and is used as
     * the key for the portlet.
     */
    String name() default "";

    /**
     * Display name of the portlet.
     */
    String displayName() default "";

    /**
     * Array of allowed security roles. By default, power-user and
     * user.
     */
    String[] securityRole() default { "power-user", "user" };
}