mx4j.tools.adaptor.http

Class HttpAdaptorMBeanDescription

Implemented Interfaces:
MBeanDescription

public class HttpAdaptorMBeanDescription
extends MBeanDescriptionAdapter

Management interface descriptions for the HttpAdaptor MBean.
Version:
$Revision: 1.3 $

Method Summary

String
getAttributeDescription(String attribute)
Should return the description for the specified attribute.
String
getConstructorDescription(Constructor ctor)
Should return the description for the given constructor of the MBean.
String
getConstructorParameterDescription(Constructor ctor, int index)
Should return the description for the constructor's parameter for the given constructor and parameter index.
String
getConstructorParameterName(Constructor ctor, int index)
Should return the name of the constructor's parameter for the given constructor and parameter index.
String
getMBeanDescription()
Should return the description of the MBean.
String
getOperationDescription(Method operation)
Should return the description for the specified operation.
String
getOperationParameterDescription(Method method, int index)
Should return the description for the operations's parameter for the given operation and parameter index.
String
getOperationParameterName(Method method, int index)
Should return the name of the operation's parameter for the given operation and parameter index.

Methods inherited from class mx4j.MBeanDescriptionAdapter

getAttributeDescription, getConstructorDescription, getConstructorParameterDescription, getConstructorParameterName, getMBeanDescription, getOperationDescription, getOperationParameterDescription, getOperationParameterName

Method Details

getAttributeDescription

public String getAttributeDescription(String attribute)
Should return the description for the specified attribute. For example: "The port on which the rmiregistry will wait on for client requests"
Specified by:
getAttributeDescription in interface MBeanDescription
Overrides:
getAttributeDescription in interface MBeanDescriptionAdapter

getConstructorDescription

public String getConstructorDescription(Constructor ctor)
Should return the description for the given constructor of the MBean. For example: "Creates an rmiregistry instance on the specified port"
Specified by:
getConstructorDescription in interface MBeanDescription
Overrides:
getConstructorDescription in interface MBeanDescriptionAdapter

getConstructorParameterDescription

public String getConstructorParameterDescription(Constructor ctor,
                                                 int index)
Should return the description for the constructor's parameter for the given constructor and parameter index. For example: "The port on which the rmiregistry will wait on for client requests"
Specified by:
getConstructorParameterDescription in interface MBeanDescription
Overrides:
getConstructorParameterDescription in interface MBeanDescriptionAdapter

getConstructorParameterName

public String getConstructorParameterName(Constructor ctor,
                                          int index)
Should return the name of the constructor's parameter for the given constructor and parameter index. For example: "port"
Specified by:
getConstructorParameterName in interface MBeanDescription
Overrides:
getConstructorParameterName in interface MBeanDescriptionAdapter

getMBeanDescription

public String getMBeanDescription()
Should return the description of the MBean. For example: "This MBean is the rmiregistry service"
Specified by:
getMBeanDescription in interface MBeanDescription
Overrides:
getMBeanDescription in interface MBeanDescriptionAdapter

getOperationDescription

public String getOperationDescription(Method operation)
Should return the description for the specified operation. For example: "Binds the given object to the given name"
Specified by:
getOperationDescription in interface MBeanDescription
Overrides:
getOperationDescription in interface MBeanDescriptionAdapter

getOperationParameterDescription

public String getOperationParameterDescription(Method method,
                                               int index)
Should return the description for the operations's parameter for the given operation and parameter index. For example: "The name to which the object will be bound to"
Specified by:
getOperationParameterDescription in interface MBeanDescription
Overrides:
getOperationParameterDescription in interface MBeanDescriptionAdapter

getOperationParameterName

public String getOperationParameterName(Method method,
                                        int index)
Should return the name of the operation's parameter for the given operation and parameter index. For example: "bindName"
Specified by:
getOperationParameterName in interface MBeanDescription
Overrides:
getOperationParameterName in interface MBeanDescriptionAdapter

Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.