Package com.sun.portal.portletcontainer.admin.mbeans

Class PortletAdmin

java.lang.Object

com.sun.portal.portletcontainer.admin.mbeans.PortletAdmin

All Implemented Interfaces:

PortletAdminMBean

public class PortletAdmin
extends Object
implements PortletAdminMBean

PortletAdmin class is a concrete implementation of PortletAdminMBean

Field Summary

Fields inherited from interface com.sun.portal.portletcontainer.admin.mbeans.PortletAdminMBean

TYPE

Constructor Summary

Constructors

Constructor	Description
PortletAdmin()

Method Summary

Modifier and Type	Method	Description
void	copyFile(String sourceFile, String destFile)
boolean	deletePortlet(String warNameOnly, String warFileLocation)	Deletes the portlet application from the stored location
Boolean	deploy(String warFileName, Properties roles, Properties userinfo, boolean deployToContainer)	Performs the following three operations.. 1.
Boolean	undeploy(String warFileName, boolean undeployFromContainer)	Performs the following two operations.. 1.
Boolean	unregisterPortlet(String warFileName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletAdmin

public PortletAdmin()

Method Detail

deploy

public Boolean deploy(String warFileName,
                      Properties roles,
                      Properties userinfo,
                      boolean deployToContainer)
               throws Exception

Description copied from interface: PortletAdminMBean

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

Specified by:

deploy in interface PortletAdminMBean

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

unregisterPortlet

public Boolean unregisterPortlet(String warFileName)
                          throws Exception

Throws:

Exception

undeploy

public Boolean undeploy(String warFileName,
                        boolean undeployFromContainer)
                 throws Exception

Description copied from interface: PortletAdminMBean

Performs the following two operations.. 1. Unregistering the portlet from the portlet driver 2. Undeploying the portlet webapplication from the webcontainer

Specified by:

undeploy in interface PortletAdminMBean

Parameters:

warFileName - 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

copyFile

public void copyFile(String sourceFile,
                     String destFile)
              throws Exception

Throws:

Exception

deletePortlet

public boolean deletePortlet(String warNameOnly,
                             String warFileLocation)

Deletes the portlet application from the stored location

Parameters:

warNameOnly - name of the portlet application (without extension)

warFileLocation - deployed location of the portlet

Returns:

true if the deletion is successful.