|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.lang.ClassLoader | +--java.security.SecureClassLoader | +--java.net.URLClassLoader | +--javax.management.loading.MLet
This MLet service allows to instantiate and register one or several MBeans in the MBean server coming from a remote URL. M-let is a shortcut for management applet. The m-let service does this by loading an m-let text file, which specifies information on the MBeans to be obtained. The information on each MBean is specified in a single instance of a tag, called the MLET tag. The location of the m-let text file is specified by a URL.
The MLET
tag has the following syntax:
<MLET
CODE =
class | OBJECT =
serfile
ARCHIVE = "
archiveList"
[CODEBASE =
codebaseURL]
[NAME =
mbeanname]
[VERSION =
version]
>
[
arglist]
</MLET
>
where:
CODE =
class.class
file of the
MBean must be contained in one of the .jar
files specified by
the ARCHIVE
attribute. Either CODE
or
OBJECT
must be present.
OBJECT =
serfile.ser
file that contains a
serialized representation of the MBean to be obtained. This file must be
contained in one of the .jar
files specified by the
ARCHIVE
attribute. If the .jar
file contains a
directory hierarchy, specify the path of the file within this hierarchy.
Otherwise a match will not be found. Either CODE
or
OBJECT
must be present.
ARCHIVE = "
archiveList"
.jar
files
containing MBeans or other resources used by the MBean to be obtained.
One of the .jar
files must contain the file specified by
the CODE
or OBJECT
attribute.
If archivelist contains more than one file:
.jar
files in archivelist must be stored in
the directory specified by the code base URL.
CODEBASE =
codebaseURL.jar
files specified by the ARCHIVE
attribute. Specify this
attribute only if the .jar
files are not in the same
directory as the m-let text file. If this attribute is not specified,
the base URL of the m-let text file is used.
NAME =
mbeannamegetDomain()
method of the Framework class to
obtain this information.
VERSION =
version.jar
files to be obtained. This version number can
be used to specify that the .jar
files are loaded from the
server to update those stored locally in the cache the next time the m-let
text file is loaded. version must be a series of non-negative
decimal integers each separated by a period from the one that precedes it.
ARG TYPE=
argumentType VALUE=
value>
The arguments' type in the argument list should be a Java primitive type
or a Java basic type (java.lang.Boolean, java.lang.Byte,
java.lang.Short, java.lang.Long, java.lang.Integer, java.lang.Float,
java.lang.Double, java.lang.String
).
The m-let Service extends the java.net.URLClassLoader
and can
be used to load remote classes and jar files in the VM of the agent.
Note - The MLet
class loader uses the
DefaultLoaderRepository
to load classes that could not be found in the loaded jar files.
Field Summary | |
protected java.util.Vector |
mletList
|
protected MBeanServer |
server
|
Constructor Summary | |
MLet()
Constructs a new MLet using the default delegation parent ClassLoader. |
|
MLet(java.net.URL[] urls)
Constructs a new MLet for the specified URLs using the default delegation parent ClassLoader. |
|
MLet(java.net.URL[] urls,
java.lang.ClassLoader parent)
Constructs a new MLet for the given URLs. |
|
MLet(java.net.URL[] urls,
java.lang.ClassLoader parent,
java.net.URLStreamHandlerFactory factory)
Constructs a new MLet for the specified URLs, parent class loader, and URLStreamHandlerFactory. |
Method Summary | |
void |
addURL(java.lang.String url)
Appends the specified URL to the list of URLs to search for classes and resources. |
void |
addURL(java.net.URL url)
Appends the specified URL to the list of URLs to search for classes and resources. |
protected java.lang.Class |
findClass(java.lang.String name)
This is the main method for class loaders that is being redefined. |
protected java.lang.String |
findLibrary(java.lang.String libname)
Returns the absolute path name of a native library. |
java.lang.String |
getLibraryDirectory()
Gets the current directory used by the library loader for storing native libraries before they are loaded into memory. |
java.util.Set |
getMBeansFromURL(java.lang.String url)
Loads a text file containing MLET tags that define the MBeans to be added to the agent. |
java.util.Set |
getMBeansFromURL(java.net.URL url)
Loads a text file containing MLET tags that define the MBeans to be added to the agent. |
java.net.URL[] |
getURLs()
Returns the search path of URLs for loading classes and resources. |
void |
postDeregister()
Allows the m-let to perform any operations needed after having been de-registered in the MBeanServer. |
void |
postRegister(java.lang.Boolean registrationDone)
Allows the m-let to perform any operations needed after having been registered in the MBeanServer or after the registration has failed. |
void |
preDeregister()
Allows the m-let to perform any operations it needs before being de-registered by the MBeanServer. |
ObjectName |
preRegister(MBeanServer server,
ObjectName name)
This method allows the m-let to perform any operations it needs before being registered in the MBeanServer. |
void |
readExternal(java.io.ObjectInput in)
This method reads the objects contents during Object Serialization. |
void |
setLibraryDirectory(java.lang.String libDir)
Sets the directory used by the library loader for storing native libraries before they are loaded into memory. |
void |
writeExternal(java.io.ObjectOutput out)
This method saves the objects contents during Object Serialization. |
Methods inherited from class java.net.URLClassLoader |
definePackage, findResource, findResources, getPermissions, newInstance, newInstance |
Methods inherited from class java.security.SecureClassLoader |
defineClass |
Methods inherited from class java.lang.ClassLoader |
defineClass, defineClass, defineClass, definePackage, findLoadedClass, findSystemClass, getPackage, getPackages, getParent, getResource, getResourceAsStream, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, loadClass, resolveClass, setSigners |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.management.loading.MLetMBean |
getResource, getResourceAsStream, getResources |
Field Detail |
protected java.util.Vector mletList
protected MBeanServer server
Constructor Detail |
public MLet()
public MLet(java.net.URL[] urls)
urls
- the URLs from which to load classes and resourcespublic MLet(java.net.URL[] urls, java.lang.ClassLoader parent)
urls
- the URLs from which to load classes and resourcesparent
- the parent class loader for delegationpublic MLet(java.net.URL[] urls, java.lang.ClassLoader parent, java.net.URLStreamHandlerFactory factory)
urls
- - the URLs from which to load classes and resourcesparent
- - the parent class loader for delegationfactory
- - the URLStreamHandlerFactory to use when creating URLsMethod Detail |
public void addURL(java.lang.String url) throws ServiceNotFoundException
addURL
in interface MLetMBean
url
- The url from which to load the MBeans in a string format.ServiceNotFoundException
- - The specified
URL is malformed.public void addURL(java.net.URL url)
addURL
in interface MLetMBean
addURL
in class java.net.URLClassLoader
url
- The url from which to load the MBeans in a string format.public java.lang.String getLibraryDirectory()
getLibraryDirectory
in interface MLetMBean
public void setLibraryDirectory(java.lang.String libDir)
setLibraryDirectory
in interface MLetMBean
libDir
- The directory used by the library loader.public java.util.Set getMBeansFromURL(java.lang.String url) throws ServiceNotFoundException
getMBeansFromURL
in interface MLetMBean
url
- - The URL of the text file to be loaded as String object.ServiceNotFoundException
- - One of the
following errors has occurred:
The m-let text file does not contain an MLET tag,
the m-let text file is not found,
a mandatory attribute of the MLET tag is not specified,
the url is malformed.MLetMBean.getMBeansFromURL(String)
public java.util.Set getMBeansFromURL(java.net.URL url) throws ServiceNotFoundException
getMBeansFromURL
in interface MLetMBean
url
- - The URL of the text file to be loaded as URL object.ServiceNotFoundException
- - One of the
following errors has occurred:
The m-let text file does not contain an MLET tag,
the m-let text file is not found,
a mandatory attribute of the MLET tag is not specified,
the value of url is null.MLetMBean.getMBeansFromURL(URL)
public java.net.URL[] getURLs()
getURLs
in interface MLetMBean
getURLs
in class java.net.URLClassLoader
MLetMBean.getURLs()
public ObjectName preRegister(MBeanServer server, ObjectName name) throws java.lang.Exception
preRegister
in interface MBeanRegistration
server
- - The MBeanServer in which the m-let will be registered.name
- - The object name of the m-let.java.lang.Exception
- - This exception should be caught by the
MBeanServer and re-thrown as an MBeanRegistrationException.MBeanRegistration.preRegister(MBeanServer, ObjectName)
public void postRegister(java.lang.Boolean registrationDone)
postRegister
in interface MBeanRegistration
registrationDone
- - Indicates whether or not the m-let has been
successfully registered in the MBeanServer. The value
false means that either the registration phase has failed.MBeanRegistration.postRegister(Boolean)
public void preDeregister() throws java.lang.Exception
preDeregister
in interface MBeanRegistration
java.langException
- - This exception should be caught by the
MBeanServer and re-thrown as an MBeanRegistrationException.MBeanRegistration.preDeregister()
public void postDeregister()
postDeregister
in interface MBeanRegistration
MBeanRegistration.postDeregister()
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- The serialization input stream.java.io.IOException
- Signals that an I/O exception of some
sort has occurred.java.lang.ClassNotFoundException
- The class for an object
being restored cannot be found.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
out
- The serialization output stream.java.io.IOException
- Signals that an I/O exception of some
sort has occurred.protected java.lang.Class findClass(java.lang.String name) throws java.lang.ClassNotFoundException
findClass
in class java.net.URLClassLoader
name
- The name of the class.java.lang.ClassNotFoundException
- The specified class
could not be found.protected java.lang.String findLibrary(java.lang.String libname)
the library stat on Solaris SPARC 5.7 will be searched in the JAR file as:
findLibrary
in class java.lang.ClassLoader
libname
- the library name.
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |