PortletAdminMBean.java :  » Portal » Open-Portal » com » sun » portal » portlet » admin » mbeans » Java Open Source

package com.sun.portal.portlet.admin.mbeans;

import com.sun.portal.admin.common.PSMBeanException;
import com.sun.portal.admin.common.util.AdminUtil;

import java.io.File;
import java.util.Properties;
import java.util.Set;
import java.util.List;
import java.util.Map;

/**
 * $Id: PortletAdminMBean.java,v 1.8 2006/05/08 10:21:30 rg149970 Exp $
 * Copyright 2004 Sun Microsystems, Inc. All
 * rights reserved. Use of this product is subject
 * to license terms. Federal Acquisitions:
 * Commercial Software -- Government Users
 * Subject to Standard License Terms and
 * Conditions.
 *
 * Sun, Sun Microsystems, the Sun logo, and Sun ONE
 * are trademarks or registered trademarks of Sun Microsystems,
 * Inc. in the United States and other countries.
 */

//This interface is a  mbean for deploying and undeploying portlets.
public interface PortletAdminMBean {
       public static final String TYPE = AdminUtil.PORTLET_ADMIN_MBEAN_TYPE;

       public Boolean deployAll(String dn,Boolean global, String  warFile, Properties roles , Properties userinfo ,
               Boolean verbose, List instanceList, Boolean toContinue, Boolean nodeploy) throws PSMBeanException;

       public Boolean undeployAll(String dn,Boolean global, String  warName, Boolean verbose, List instances, Boolean toContinue ) throws PSMBeanException;

       public Boolean deploy(String dn,Boolean global, String  warFile, Properties roles ,
                        Properties userinfo , Boolean verbose, List instances, Boolean toContinue, Boolean nodeploy) throws PSMBeanException;

       public Boolean undeploy(String dn,Boolean global, String  warName, Boolean verbose, List instances, Boolean toContinue )
         throws PSMBeanException;

       public  void copyFile(String sourceFile, String destFile )
        throws PSMBeanException ;

    //below methods are only for accessing portlet specific dp
       public void createPortletChannel(String baseDN,String channelName, String portletName) throws PSMBeanException;

       public Set getExistingPortlets(String baseDN) throws PSMBeanException;

       public Set getPortletPreferenceNames(String baseDN,String portletName) throws PSMBeanException;

       public String getPortletPreference(String baseDN,String portletName, String prefName) throws PSMBeanException;

       public List getPortletPreferenceValues(String baseDN,String portletName, String prefName) throws PSMBeanException;

       public void setPortletPreference(String baseDN, String portletName, String prefName, String value ) throws PSMBeanException;

       public void setPortletPreferenceValues(String baseDN, String portletName, String prefName, String[] values ) throws PSMBeanException;

       public Boolean isPortletChannel(String baseDN, String channelName) throws PSMBeanException;

       public Map getPortletPreferenceMap(String baseDN, String portletName) throws PSMBeanException;

       public void registerPortletApp(String dn, Boolean global, String earFile, 
                                   Properties roles ,Properties userinfo, Boolean verbose) throws PSMBeanException;
       
       public void unregisterPortletApp(String dn,Boolean global, String earName,
                                     Boolean verbose) throws PSMBeanException;
       
   }