001: /**
002: * $Id: PortalDomainMBean.java,v 1.19 2006/09/22 00:43:47 paulho 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: import com.sun.portal.admin.server.mbeans.PSMBean;
019: import com.sun.portal.admin.common.PSMBeanException;
020:
021: import com.sun.portal.admin.common.util.AdminUtil;
022:
023: public interface PortalDomainMBean extends PSMBean {
024:
025: public static final String TYPE = AdminUtil.PORTAL_DOMAIN_MBEAN_TYPE;
026:
027: public String getID();
028:
029: public void setDomainRepositoryPassword(String password)
030: throws PSMBeanException;
031:
032: public List getPortals() throws PSMBeanException;
033:
034: public void createPortal(String portalID, String host, String uri)
035: throws PSMBeanException;
036:
037: public void deletePortal(String portalID) throws PSMBeanException;
038:
039: public void createSearchServer(String searchServerID,
040: Properties webContainerProperties) throws PSMBeanException;
041:
042: public void createSearchServerBackground(String searchServerID,
043: Properties webContainerProperties) throws PSMBeanException;
044:
045: public Integer retrieveCreateSearchServerStatus()
046: throws PSMBeanException;
047:
048: public void deleteSearchServer(String searchServerID)
049: throws PSMBeanException;
050:
051: public void redeploySearchServerWarfile(String searchServerID)
052: throws PSMBeanException;
053:
054: public String getPortalVersion(Boolean display, String jarpath,
055: Boolean patch, Boolean patchVerbose)
056: throws PSMBeanException;
057:
058: /**
059: * Returns a list of values for an attribute (service attribute)
060: */
061: public List getAttribute(Map optionsMap) throws PSMBeanException;
062:
063: /**
064: * The cli handles only one attr at a time. So this method
065: * will only be consumed by console which needs many attrs to be
066: * displayed on one screen.
067: *
068: * Returns attributes at the specific dn or at top level
069: * If global, then dn should not be specified
070: * If org and dn is not specified, then its org default
071: * If neither global nor org, then its dynamic
072: * If neither global nor org and no dn, then its dynamic default
073: * If neither global nor org and dn is user dn, then its user attrs
074: *
075: * The optionsMap contains these in addition to component
076: * specific options:
077: * OPT_COMPONENT = "component";
078: * OPT_ATTR_NAMES = "attribute-names";
079: * OPT_DN = "dn";
080: * OPT_GLOBAL = "global";
081: * OPT_ORG = "org";
082: * These constants are defined in
083: * com.sun.portal.admin.common.AttrOptionConstants
084: *
085: * The names passed and returned are friendly names
086: *
087: * @param optionsMap a map containing key-value pairs for options
088: * @return map of name-values for the attribute where values is a List
089: * @throws PSMBeanException if there was error in retrieving the value
090: */
091: Map getAttributes(Map optionsMap) throws PSMBeanException;
092:
093: public void setAttribute(List values, Map optionsMap)
094: throws PSMBeanException;
095:
096: /**
097: * Sets the value(s) for multiple attributes passed in the map
098: * This method does not support add/remove/inherit. It is only
099: * to set the values. Consumed by console. Not used by clis.
100: *
101: * The optionsMap contains these in addition to component
102: * specific options
103: * operation = set
104: * //common basic options
105: * OPT_COMPONENT = "component";
106: * OPT_DN = "dn";
107: * OPT_GLOBAL = "global";
108: * OPT_ORG = "org";
109: *
110: * OPT_COMPONENT is the friendly service name
111: * The nameValues map consists of mapping between friendly attr name
112: * and its value which is a List
113: *
114: * @param nameValues map of name-ListValues
115: * @param optionsMap a map containing key-value pairs for options
116: * @throws PSMBeanException if there was an error in setting the value
117: */
118: public void setAttributes(Map nameValues, Map optionsMap)
119: throws PSMBeanException;
120:
121: public Map listAttributes(Map optionsMap) throws PSMBeanException;
122:
123: public void validateWebContainer(Map attributes)
124: throws PSMBeanException;
125:
126: }
|