| com.sun.portal.admin.server.mbeans.PSMBean
All known Subclasses: com.sun.portal.admin.server.mbeans.PSResource,
| PSMBean | | public interface PSMBean (Code) | | This interface is a generic Portal Server MBean that represents a
manageable/configurable Portal Server resource.
Portal Server resources are organized in a hierarchical fashion.
At the top is the Portal Domain object. Each portal domain
consists of one or more portal (site) objects and other portal
server resources that are independent of portals. Each portal
consists of one or more portal server instance objects and other
portal server resources that are independent of portal server
instances but are associated with a portal.
The information about the presence of a particular instance of a
portal server resource is stored in the portal domain repository.
Each such instance is uniquely identified in the portal domain
repository by a path, similar to the full path of a file in a file
system or the DN of a LDAP entry in a LDAP directory. For example,
the path to identify a particular portal server instance object is
{instanceID, portalID, domainID}, where the first element of the
path is the ID of that resource instance within its parent resource
instance, and the last element is (almost) always the ID of the
portal domain where this resource instance belongs to.
|
| Method Summary | |
| public String | getAttributeValue(String type, String name)
Returns the value of the resource attribute with the given
name. | | public Set | getAttributeValues(String type, String name)
Returns the set of values of the resource attribute with the
given name. | | public String | getDomainID()
Returns the ID of the portal domain this portal server resource
instance belongs to. | | public String | getID()
Returns the ID of this portal server resource instance. | | public Map | getMultipleAttributeValues(String type, Set names)
Returns the sets of values of the resource attributes with the
given names. | | public List | getPath()
Returns the path to identify this portal server resource
instance in the portal domain context. | | public Object | invokeRemoteOperation(String host, ObjectName on, String operationName, Object[] params, String[] signature)
Invokes a method on a remote host be connecting to the Cacao MBean
server on the host sepecified in the params. | | public void | setAttributeValue(String type, String name, String value)
Sets the value of the resource attribute with the given name to
the given value, replacing the old values if there were any. | | public void | setAttributeValues(String type, String name, Set values)
Sets the values of the resource attribute with the given name
to the given values, replacing the old values if there were any. | | public void | setMultipleAttributeValues(String type, Map attributes)
Sets the resource attributes with the given names to the given
values, replacing the old values if there were any. |
| getAttributeValue | | public String getAttributeValue(String type, String name) throws PSMBeanException(Code) | | Returns the value of the resource attribute with the given
name. If the attribute has more than one values, the first one
is returned. If the attribute has no value, null
is returned.
Parameters:
type - the type of the Portal Server resource.
Parameters:
name - name of the attribute. the first value if more than one; null if no value.
exception:
PSMBeanException - if an error occurs when getting theattribute value. |
| getAttributeValues | | public Set getAttributeValues(String type, String name) throws PSMBeanException(Code) | | Returns the set of values of the resource attribute with the
given name. If the attribute has no value, an empty Set is returned.
Parameters:
type - the type of the Portal Server resource.
Parameters:
name - name of the attribute. a Set of Strings.
exception:
PSMBeanException - if an error occurs when getting theattribute values. |
| getDomainID | | public String getDomainID()(Code) | | Returns the ID of the portal domain this portal server resource
instance belongs to.
the portal domain ID. |
| getID | | public String getID()(Code) | | Returns the ID of this portal server resource instance.
the ID of this portal server resource instance. |
| getMultipleAttributeValues | | public Map getMultipleAttributeValues(String type, Set names) throws PSMBeanException(Code) | | Returns the sets of values of the resource attributes with the
given names. The returned value is a map whose keySet is the
set of attribute names given and each value of the map is a set
of values of the corresponding attribute name as key. If any
attribute has no value, the corresponding map value is an empty
Set.
Parameters:
type - the type of the Portal Server resource.
Parameters:
names - the set of attribute names. a Map whose keySet is the Set of attribute names givenand whose values are the Sets of attribute values.
exception:
PSMBeanException - if an error occurs when getting thesets of attribute values. |
| getPath | | public List getPath()(Code) | | Returns the path to identify this portal server resource
instance in the portal domain context.
the path of this portal server resource instance. |
| invokeRemoteOperation | | public Object invokeRemoteOperation(String host, ObjectName on, String operationName, Object[] params, String[] signature) throws PSMBeanException(Code) | | Invokes a method on a remote host be connecting to the Cacao MBean
server on the host sepecified in the params.
Parameters:
host - FQDN hostname of the target host
Parameters:
on - MBean Object Name
Parameters:
operationName - The method name to be invoked
Parameters:
params - method params as an Object array
Parameters:
signature - method signature definined in a String array
throws:
com.sun.portal.admin.common.PSMBeanException - exceptions an Object resulting in the method invocation |
| setAttributeValue | | public void setAttributeValue(String type, String name, String value) throws PSMBeanException(Code) | | Sets the value of the resource attribute with the given name to
the given value, replacing the old values if there were any.
Parameters:
type - the type of the Portal Server resource.
Parameters:
name - name of the attribute.
Parameters:
value - value of the attribute to be set to.
exception:
PSMBeanException - if an error occurs when setting theattribute value. |
| setAttributeValues | | public void setAttributeValues(String type, String name, Set values) throws PSMBeanException(Code) | | Sets the values of the resource attribute with the given name
to the given values, replacing the old values if there were any.
Parameters:
type - the type of the Portal Server resource.
Parameters:
name - name of the attribute.
Parameters:
values - values of the attribute to be set to.
exception:
PSMBeanException - if an error occurs when setting theattribute values. |
| setMultipleAttributeValues | | public void setMultipleAttributeValues(String type, Map attributes) throws PSMBeanException(Code) | | Sets the resource attributes with the given names to the given
values, replacing the old values if there were any. The keys
of the given attributes map are the attribute names and the
values are Sets of String values.
Parameters:
type - the type of the Portal Server resource.
Parameters:
attributes - a map of name-values pairs where each keyis an attribute name and the correspondingvalue is a Set of String values.
exception:
PSMBeanException - if an error occurs when setting theattribute values. |
|
|