org.jboss.wise.lms.httpForward.mbean
Interface Admin

All Known Implementing Classes:

AdminMBean

public interface Admin

This is the Admin interface used both by the LoggingServlet and the LmsSFActionBean when looking up the administration MBean.

Author:

Stefano Maestri, stefano.maestri@javalinux.it, Alessio Soldano, alessio.soldano@javalinux.it

Method Summary

void	addLoggingServletMapping(java.lang.String name, java.lang.String url) Creates a new Lms mapping: requests coming to http://host:port/Lms/log/name are processed (recorded) and forwarded to the specified url.
void	cleanAllCommunications() Cleans up all the recorded communications
void	cleanCommunications(java.lang.String name) Cleans up the communications for the given mapping name.
void	create()
void	destroy()
LogData	getLogData(java.lang.String name) Gets the recorder data for a given mapping.
void	logCommunication(java.lang.String name, Request request, Response response) Requires the provided Request and Response to be recorder under the given mapping name.
void	removeLoggingServletMapping(java.lang.String name) Remove a mapping from the current list of Lms mapping
java.util.List<LogData>	showAllLogData() Returns the full list of recorded data.
java.util.Map<java.lang.String,java.lang.String>	showAllLogMappings() Returns a map whose keys are the mapping's short name and whose values are the corresponding specified urls.
java.lang.String	startLogRecording(java.lang.String name) Enable recording on the given mapping
void	stopAllLogRecording() Disable recording on all the mappings currently in place.
java.lang.String	stopLogRecording(java.lang.String name) Disable recording on the given mapping

Method Detail

addLoggingServletMapping

void addLoggingServletMapping(java.lang.String name,
                              java.lang.String url)

Creates a new Lms mapping: requests coming to http://host:port/Lms/log/name are processed (recorded) and forwarded to the specified url. Responses also pass through Lms and are recorded too.

Parameters:

name - The short name to be used for the mapping

url - The actual address requests should be forwarded to when using this mapping

removeLoggingServletMapping

void removeLoggingServletMapping(java.lang.String name)

Remove a mapping from the current list of Lms mapping

Parameters:

name - The name of the mapping to be removed.

showAllLogMappings

java.util.Map<java.lang.String,java.lang.String> showAllLogMappings()

Returns a map whose keys are the mapping's short name and whose values are the corresponding specified urls.

Returns:

The mappings' map.

showAllLogData

java.util.List<LogData> showAllLogData()

Returns the full list of recorded data.

Returns:

The full list of recorded data.

getLogData

LogData getLogData(java.lang.String name)

Gets the recorder data for a given mapping.

Parameters:

name - The mapping name of the required data

Returns:

The recorder data for a given mapping

startLogRecording

java.lang.String startLogRecording(java.lang.String name)

Enable recording on the given mapping

Parameters:

name - The name of the mapping on which the recording has to be enabled.

Returns:

A confirmation/error string

stopLogRecording

java.lang.String stopLogRecording(java.lang.String name)

Disable recording on the given mapping

Parameters:

name - The name of the mapping on which the recording has to be disabled.

Returns:

A confirmation/error string

stopAllLogRecording

void stopAllLogRecording()

Disable recording on all the mappings currently in place.

logCommunication

void logCommunication(java.lang.String name,
                      Request request,
                      Response response)

Requires the provided Request and Response to be recorder under the given mapping name.

Parameters:

name - The mapping name

request - The request object

response - The response object

cleanAllCommunications

void cleanAllCommunications()

Cleans up all the recorded communications

cleanCommunications

void cleanCommunications(java.lang.String name)

Cleans up the communications for the given mapping name.

Parameters:

name -

create

void create()
            throws java.lang.Exception

Throws:

java.lang.Exception

destroy

void destroy()
             throws java.lang.Exception

Throws:

java.lang.Exception