|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.management.ObjectName | +--weblogic.management.WebLogicObjectName
The WebLogic Server Management API distinguishes between three types of MBeans:
Administration, Configuration and Runtime MBeans. For details on different MBean types @link WebLogicMBeanAll MBeans have a name, a type and a domain. These attributes are reflected in the MBean's Object Name. The Object Name is the unique identifier for a given MBean across all domains, and has the following structure:
mydomain:Name=name,Type=type[,attr=value]...Name is a name that is unique for a given domain and a given type. Examples of type include Server, WebComponent or JDBCConnectionPoolRuntime. Type is also used to distinguish between an administration and config MBean of a given type for example, the value of Type for a Server MBean is:
'Server' for an Administration MBean 'ServerConfig' for a Configuration MBean 'ServerRuntime' for a Runtime MBeanNOTE
1. "MBean" suffix is removed from the MBean interface name to get the base type of an MBean. Config or Runtime suffices are added to the base name (Server) to distinguish configuration and runtime MBeans from administration MBeans.
2. Specific MBean types have additional components. All runtime and configuration MBeans have a Location component that contains the name of the server on which that MBean is instantiated as its value.
For example: mydomain:Name=myServlet,Type=ServletRuntime,Location=myserverAny MBean which has a child relationship with another MBean, has an extra attribute in its object name in the following format: TypeOfParentMBean=NameOfParentMBean. The following example objectname shows an administration LogMBean whose parent is a ServerMBean. Server is the type of Parent MBean, and myserver is the name of the Parent MBean:
mydomain:Name=mylog,Type=Log,Server=myserver
In otherwords anything that is not Name=,Type=,Location= indicates the parent relatinship.
WebLogicMBean
, Serialized FormField Summary | |
static java.lang.String |
LOCATION
The key for the location component of a WebLogic ObjectName. |
static java.lang.String |
NAME
The key for the simple name component of a WebLogic ObjectName |
static java.lang.String |
TYPE
The key for the type component of a WebLogic ObjectName |
static java.lang.String |
WEBLOGIC
The weblogic domain |
Constructor Summary | |
WebLogicObjectName(javax.management.ObjectName objectName,
java.lang.String locationName)
Deprecated. In WLS 6.1 |
|
WebLogicObjectName(java.lang.String fullObjectName)
Deprecated. In WLS 6.1 |
|
WebLogicObjectName(java.lang.String domain,
java.util.Hashtable properties)
Deprecated. In WLS 6.1 |
|
WebLogicObjectName(java.lang.String name,
java.lang.String type,
java.lang.String domain)
For Admin MBeans |
|
WebLogicObjectName(java.lang.String name,
java.lang.String type,
java.lang.String domain,
java.lang.String location)
For non-Admin MBeans |
|
WebLogicObjectName(java.lang.String nameArg,
java.lang.String typeArg,
java.lang.String domainArg,
java.lang.String locationArg,
WebLogicObjectName parentArg)
For non-Admin MBeans |
|
WebLogicObjectName(java.lang.String name,
java.lang.String type,
java.lang.String domain,
WebLogicObjectName parent)
For Admin MBeans |
|
WebLogicObjectName(java.lang.String nameArg,
java.lang.String typeArg,
WebLogicObjectName parentArg)
Deprecated. In WLS 6.1 |
|
WebLogicObjectName(WebLogicObjectName objectNameArg,
WebLogicObjectName parentArg)
Deprecated. In WLS 6.1 |
Method Summary | |
static java.lang.String |
extractDomain(java.lang.String fullWebLogicObjectName)
Strip out the name component of a stringified WeblogicObjectName |
java.lang.String |
getLocation()
Gets the location attribute of the WebLogicObjectName object |
java.lang.String |
getName()
Gets the name attribute of the WebLogicObjectName object |
WebLogicObjectName |
getParent()
Gets the parent attribute of the WebLogicObjectName object |
java.lang.String |
getType()
Gets the type attribute of the WebLogicObjectName object |
int |
hashCode()
Calculate the has code for the Name. |
boolean |
isAdmin()
Gets the admin attribute of the WebLogicObjectName object |
static boolean |
isAdmin(javax.management.ObjectName objectName)
Gets the admin attribute of the WebLogicObjectName class |
boolean |
isConfig()
Gets the config attribute of the WebLogicObjectName object |
static boolean |
isConfig(javax.management.ObjectName objectName)
Gets the config attribute of the WebLogicObjectName class |
boolean |
isRuntime()
Gets the runtime attribute of the WebLogicObjectName object |
static boolean |
isRuntime(javax.management.ObjectName objectName)
Gets the runtime attribute of the WebLogicObjectName class |
Methods inherited from class javax.management.ObjectName |
equals,
getCanonicalKeyPropertyListString,
getCanonicalName,
getDomain,
getKeyProperty,
getKeyPropertyList,
getKeyPropertyListString,
isPattern,
isPropertyPattern,
toString |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final java.lang.String WEBLOGIC
public static final java.lang.String NAME
public static final java.lang.String TYPE
public static final java.lang.String LOCATION
Constructor Detail |
public WebLogicObjectName(java.lang.String fullObjectName) throws javax.management.MalformedObjectNameException
fullObjectName
- Description of the Parameterpublic WebLogicObjectName(java.lang.String name, java.lang.String type, java.lang.String domain) throws javax.management.MalformedObjectNameException
For Admin MBeans
Builds an ObjectName for Admin MBean.
name
- Unique with in type, and domain.type
- Base type.domain
- The WLS/JMX domain name for the MBean.public WebLogicObjectName(java.lang.String name, java.lang.String type, java.lang.String domain, java.lang.String location) throws javax.management.MalformedObjectNameException
For non-Admin MBeans
Builds an ObjectName for a non-Admin MBean.
name
- Unique with in type, and domain.type
- Type of the MBean must include Config or Runtime.domain
- The WLS/JMX domain name for the MBean.location
- The server on which the MBean is instantiated.public WebLogicObjectName(java.lang.String name, java.lang.String type, java.lang.String domain, WebLogicObjectName parent) throws javax.management.MalformedObjectNameException
For Admin MBeans
Builds an ObjectName for admin MBean with a parent.
name
- Unique with in type, and domain.type
- Type of the MBean must include Config or Runtime.domain
- The WLS/JMX domain name for the MBean.parent
- The name of the parent for this MBeanpublic WebLogicObjectName(WebLogicObjectName objectNameArg, WebLogicObjectName parentArg) throws javax.management.MalformedObjectNameException
objectNameArg
- Description of the ParameterparentArg
- Description of the Parameterpublic WebLogicObjectName(java.lang.String nameArg, java.lang.String typeArg, java.lang.String domainArg, java.lang.String locationArg, WebLogicObjectName parentArg) throws javax.management.MalformedObjectNameException
For non-Admin MBeans
Builds an ObjectName for a non-Admin MBean with a parent.
name
- Unique with in type, and domain.type
- Type of the MBean must include Config or Runtime.domain
- The WLS/JMX domain name for the MBean.parent
- The name of the parent for this MBeanpublic WebLogicObjectName(java.lang.String nameArg, java.lang.String typeArg, WebLogicObjectName parentArg) throws javax.management.MalformedObjectNameException
nameArg
- Description of the ParametertypeArg
- Description of the ParameterparentArg
- Description of the Parameterpublic WebLogicObjectName(java.lang.String domain, java.util.Hashtable properties) throws javax.management.MalformedObjectNameException
domain
- Description of the Parameterproperties
- Description of the Parameterpublic WebLogicObjectName(javax.management.ObjectName objectName, java.lang.String locationName) throws javax.management.MalformedObjectNameException
objectName
- Description of the ParameterlocationName
- Description of the ParameterMethod Detail |
public static boolean isAdmin(javax.management.ObjectName objectName)
objectName
- Description of the Parameterpublic static boolean isConfig(javax.management.ObjectName objectName)
objectName
- Description of the Parameterpublic static boolean isRuntime(javax.management.ObjectName objectName)
objectName
- Description of the Parameterpublic static java.lang.String extractDomain(java.lang.String fullWebLogicObjectName) throws javax.management.MalformedObjectNameException
fullWebLogicObjectName
- Description of the Parameterpublic java.lang.String getName()
public java.lang.String getType()
public java.lang.String getLocation()
public WebLogicObjectName getParent()
public boolean isAdmin()
public boolean isConfig()
public boolean isRuntime()
public int hashCode()
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs81b |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |