API java : MLetMBean

javax.management.loading
Interface MLetMBean

All Known Implementing Classes:

MLet, PrivateMLet

public interface MLetMBean

Exposes the remote management interface of the MLet MBean.

Since:

1.5

Method Summary
void	addURL(String url)           Appends the specified URL to the list of URLs to search for classes and resources.
void	addURL(URL url)           Appends the specified URL to the list of URLs to search for classes and resources.
String	getLibraryDirectory()           Gets the current directory used by the library loader for storing native libraries before they are loaded into memory.
Set	getMBeansFromURL(String url)           Loads a text file containing MLET tags that define the MBeans to be added to the agent.
Set	getMBeansFromURL(URL url)           Loads a text file containing MLET tags that define the MBeans to be added to the agent.
URL	getResource(String name)           Finds the resource with the given name.
InputStream	getResourceAsStream(String name)           Returns an input stream for reading the specified resource.
Enumeration	getResources(String name)           Finds all the resources with the given name.
URL[]	getURLs()           Returns the search path of URLs for loading classes and resources.
void	setLibraryDirectory(String libdir)           Sets the directory used by the library loader for storing native libraries before they are loaded into memory.

 

Method Detail

getMBeansFromURL

Set getMBeansFromURL(String url)
                     throws ServiceNotFoundException

Loads a text file containing MLET tags that define the MBeans to be added to the agent. The location of the text file is specified by a URL. The text file is read using the UTF-8 encoding. The MBeans specified in the MLET file will be instantiated and registered by the MBeanServer.

Parameters:

url - The URL of the text file to be loaded as String object.

Returns:

A set containing one entry per MLET tag in the m-let text file loaded. Each entry specifies either the ObjectInstance for the created MBean, or a throwable object (that is, an error or an exception) if the MBean could not be created.

Throws:

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 malformed.

getMBeansFromURL

Set getMBeansFromURL(URL url)
                     throws ServiceNotFoundException

Loads a text file containing MLET tags that define the MBeans to be added to the agent. The location of the text file is specified by a URL. The text file is read using the UTF-8 encoding. The MBeans specified in the MLET file will be instantiated and registered by the MBeanServer.

Parameters:

url - The URL of the text file to be loaded as URL object.

Returns:

A set containing one entry per MLET tag in the m-let text file loaded. Each entry specifies either the ObjectInstance for the created MBean, or a throwable object (that is, an error or an exception) if the MBean could not be created.

Throws:

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.

addURL

void addURL(URL url)

Appends the specified URL to the list of URLs to search for classes and resources.

Parameters:

url - the URL to add.

addURL

void addURL(String url)
            throws ServiceNotFoundException

Appends the specified URL to the list of URLs to search for classes and resources.

Parameters:

url - the URL to add.

Throws:

ServiceNotFoundException - The specified URL is malformed.

getURLs

URL[] getURLs()

Returns the search path of URLs for loading classes and resources. This includes the original list of URLs specified to the constructor, along with any URLs subsequently appended by the addURL() method.

Returns:

the list of URLs.

getResource

URL getResource(String name)

Finds the resource with the given name. A resource is some data (images, audio, text, etc) that can be accessed by class code in a way that is independent of the location of the code. The name of a resource is a "/"-separated path name that identifies the resource.

Parameters:

name - The resource name

Returns:

An URL for reading the resource, or null if the resource could not be found or the caller doesn't have adequate privileges to get the resource.

getResourceAsStream

InputStream getResourceAsStream(String name)

Returns an input stream for reading the specified resource. The search order is described in the documentation for getResource(String).

Parameters:

name - The resource name

Returns:

An input stream for reading the resource, or null if the resource could not be found

getResources

Enumeration getResources(String name)
                         throws IOException

Finds all the resources with the given name. A resource is some data (images, audio, text, etc) that can be accessed by class code in a way that is independent of the location of the code. The name of a resource is a "/"-separated path name that identifies the resource.

Parameters:

name - The resource name.

Returns:

An enumeration of URL to the resource. If no resources could be found, the enumeration will be empty. Resources that cannot be accessed will not be in the enumeration.

Throws:

IOException - if an I/O exception occurs when searching for resources.

getLibraryDirectory

String getLibraryDirectory()

Gets the current directory used by the library loader for storing native libraries before they are loaded into memory.

Returns:

The current directory used by the library loader.

See Also:

setLibraryDirectory(java.lang.String)

setLibraryDirectory

void setLibraryDirectory(String libdir)

Sets the directory used by the library loader for storing native libraries before they are loaded into memory.

Parameters:

libdir - The directory used by the library loader.

See Also:

getLibraryDirectory()