/**
 * This file is part of the Meeds project (https://meeds.io/).
 *
 * Copyright (C) 2020 - 2025 Meeds Association contact@meeds.io
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.gatein.pc.portlet.container;

import org.gatein.pc.api.PortletInvokerException;
import org.gatein.pc.api.info.PortletInfo;
import org.gatein.pc.api.invocation.InvocationException;
import org.gatein.pc.api.invocation.PortletInvocation;
import org.gatein.pc.api.invocation.response.PortletInvocationResponse;

public interface PortletContainer
{

   /**
    * Return the portlet container id, unique within the context of the parent application.
    *
    * @return the id
    */
   String getId();

   /**
    * Returns the runtime meta data of the container.
    *
    * @return the info
    */
   PortletInfo getInfo();

   /**
    * Invoke the portlet container.
    *
    * @param invocation the portlet invocation
    * @return the portlet invocation response
    * @throws org.gatein.pc.api.PortletInvokerException
    *                             a portlet invoker exception
    * @throws InvocationException an invocation exception
    */
   PortletInvocationResponse dispatch(PortletInvocation invocation) throws PortletInvokerException, InvocationException;

   /**
    * Returns the wired application.
    *
    * @return the application
    */
   PortletApplication getPortletApplication();

   /**
    * Returns the context of the portlet container.
    *
    * @return the context
    */
   PortletContainerContext getContext();
}
