001: /**
002: * $Id: PortalMBean.java,v 1.16 2006/10/25 21:22:24 cathywu Exp $
003: * Copyright 2004 Sun Microsystems, Inc. All
004: * rights reserved. Use of this product is subject
005: * to license terms. Federal Acquisitions:
006: * Commercial Software -- Government Users
007: * Subject to Standard License Terms and
008: * Conditions.
009: *
010: * Sun, Sun Microsystems, the Sun logo, and Sun ONE
011: * are trademarks or registered trademarks of Sun Microsystems,
012: * Inc. in the United States and other countries.
013: */package com.sun.portal.fabric.mbeans;
014:
015: import java.util.List;
016: import java.util.Map;
017: import java.util.Properties;
018:
019: import com.sun.portal.admin.common.util.AdminUtil;
020: import com.sun.portal.admin.common.PSMBeanException;
021: import com.sun.portal.admin.server.mbeans.PSMBean;
022:
023: public interface PortalMBean extends PSMBean {
024:
025: public static final String TYPE = AdminUtil.PORTAL_MBEAN_TYPE;
026:
027: public String getID();
028:
029: public List getInstances() throws PSMBeanException;
030:
031: public Boolean hasLocalInstance();
032:
033: public String createPortalWebApp() throws PSMBeanException;
034:
035: public String zipFilesystem() throws PSMBeanException;
036:
037: public void createInstance(String instanceID, Properties wcProp)
038: throws PSMBeanException;
039:
040: public void createAndFinalizeInstance(String instanceID,
041: Properties wcProp) throws PSMBeanException;
042:
043: public void deleteInstance(String instanceID)
044: throws PSMBeanException;
045:
046: public Boolean configureInstances(String confDir)
047: throws PSMBeanException;
048:
049: public void deployAllWebApps(String instanceID)
050: throws PSMBeanException;
051:
052: public void undeployAllWebApps(String instanceID)
053: throws PSMBeanException;
054:
055: public void deployPortalWebApp() throws PSMBeanException;
056:
057: public void undeployPortalWebApp() throws PSMBeanException;
058:
059: public List getAttribute(Map optionsMap) throws PSMBeanException;
060:
061: /**
062: * The cli handles only one attr at a time. So this method
063: * will only be consumed by console which needs many attrs to be
064: * displayed on one screen.
065: *
066: * Returns attributes at the specific dn or at top level
067: * If global, then dn should not be specified
068: * If org and dn is not specified, then its org default
069: * If neither global nor org, then its dynamic
070: * If neither global nor org and no dn, then its dynamic default
071: * If neither global nor org and dn is user dn, then its user attrs
072: *
073: * The optionsMap contains these in addition to component
074: * specific options:
075: * OPT_COMPONENT = "component";
076: * OPT_ATTR_NAMES = "attribute-names";
077: * OPT_DN = "dn";
078: * OPT_GLOBAL = "global";
079: * OPT_ORG = "org";
080: * These constants are defined in
081: * com.sun.portal.admin.common.AttrOptionConstants
082: *
083: * The names passed and returned are friendly names
084: *
085: * @param optionsMap a map containing key-value pairs for options
086: * @return map of name-values for the attribute where values is a List
087: * @throws PSMBeanException if there was error in retrieving the value
088: */
089: public Map getAttributes(Map optionsMap) throws PSMBeanException;
090:
091: public void setAttribute(List values, Map optionsMap)
092: throws PSMBeanException;
093:
094: /**
095: * Sets the value(s) for multiple attributes passed in the map
096: * This method does not support add/remove/inherit. It is only
097: * to set the values. Consumed by console. Not used by clis.
098: *
099: * The optionsMap contains these in addition to component
100: * specific options
101: * operation = set
102: * //common basic options
103: * OPT_COMPONENT = "component";
104: * OPT_DN = "dn";
105: * OPT_GLOBAL = "global";
106: * OPT_ORG = "org";
107: *
108: * OPT_COMPONENT is the friendly service name
109: * The nameValues map consists of mapping between friendly attr name
110: * and its value which is a List
111: *
112: * @param nameValues map of name-ListValues
113: * @param optionsMap a map containing key-value pairs for options
114: * @throws PSMBeanException if there was an error in setting the value
115: */
116: public void setAttributes(Map nameValues, Map optionsMap)
117: throws PSMBeanException;
118:
119: public Map listAttributes(Map optionsMap) throws PSMBeanException;
120:
121: }
|