PortletAdminMBean (Silverpeas Core 6.3 API)

All Known Implementing Classes:

PortletAdmin
```
public interface PortletAdminMBean
```
PortletAdminMBean provides methods for deploying and undeploying the portlet.

Field Summary

Fields
Modifier and Type Field Description

static String TYPE

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Boolean`	`deploy(String warFileName, Properties roles, Properties userinfo, boolean deployToContainer)`	Performs the following three operations.. 1.
`Boolean`	`undeploy(String warName, boolean undeployFromContainer)`	Performs the following two operations.. 1.

- Field Detail
  - TYPE
```
static final String TYPE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - deploy
```
Boolean deploy(String warFileName,
               Properties roles,
               Properties userinfo,
               boolean deployToContainer)
        throws Exception
```
    Performs the following three operations.. 1. Preparing the portlet webapplication 2. Registering the portlet with the portlet driver 3. Deploying the portlet webapplication in the webcontainer
    
    Parameters:
    
    warFileName - the portlet webapplication
    
    roles - the roles the user is in
    
    userinfo - the user information for the user
    
    deployToContainer - true if the application is to be deployed to the webcontainer
    
    Returns:
    
    true if the deployment is successful.
    
    Throws:
    
    Exception
  - undeploy
```
Boolean undeploy(String warName,
                 boolean undeployFromContainer)
          throws Exception
```
    Performs the following two operations.. 1. Unregistering the portlet from the portlet driver 2. Undeploying the portlet webapplication from the webcontainer
    
    Parameters:
    
    warName - the portlet web application
    
    undeployFromContainer - true if the application is to be undeployed from the webcontainer
    
    Returns:
    
    true if the undeployment is successful.
    
    Throws:
    
    Exception