Skip navigation links

weblogic.management.runtime
Interface JaxRsApplicationRuntimeMBean

All Superinterfaces:

DynamicMBean, JaxRsMonitoringInfoRuntimeMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface JaxRsApplicationRuntimeMBean

extends JaxRsMonitoringInfoRuntimeMBean

This the runtime server MBean for a JAX-RS application. There can be more than one JAX-RS application per Web Application. The list of available JAX-RS applications can be got through the method public JaxRsApplicationMBean[] getJaxRsApplications() at weblogic.management.runtime.WebAppComponentRuntimeMBean The lookup method to find a specific JAX-RS application with given name is public JaxRsApplicationMBean lookupJaxRsApplication(String name)

getApplicationName

String getApplicationName()

Get the application name.

Returns:

Application name.

getApplicationClass

String getApplicationClass()

Get the application class used for configuration of Jersey application.

Returns:

Application class name.

getProperties

Map<String,String> getProperties()

Get the map of configuration properties converted to strings.

Returns:

Map property keys to property string values.

getStartTime

long getStartTime()

Get the start time of the application (when application was initialized).

Specified by:

getStartTime in interface JaxRsMonitoringInfoRuntimeMBean

Returns:

Application start time.

getRegisteredClasses

Set<String> getRegisteredClasses()

Get a set of string names of resource classes registered by the user.

Returns:

Set of classes full names (with package names).

getRegisteredInstances

Set<String> getRegisteredInstances()

Get a set of string names of classes of user registered instances.

Returns:

Set of user registered instances converted to their class full names (with package names).

getAllRegisteredClasses

Set<String> getAllRegisteredClasses()

Get all JAX-RS/Jersey component and provider classes registered either explicitly or via discovery (e.g. class-path scanning, from META-INF/services entries)

Returns:

Set of all registered class full names (with packages names).

getRequestStatistics

JaxRsExecutionStatisticsRuntimeMBean getRequestStatistics()

Get the global application statistics of request execution. The statistics are not bound any specific resource or resource method and contains information about all requests that application handles.

Returns:

Application request execution statistics.

getResponseStatistics

JaxRsResponseStatisticsRuntimeMBean getResponseStatistics()

Get global application response statistics. The statistics are not bound any specific resource or resource method and contains information about all responses that application creates.

Returns:

Application response statistics.

getExceptionMapperStatistics

JaxRsExceptionMapperStatisticsRuntimeMBean getExceptionMapperStatistics()

Get statistics about registered exception mappers.

Returns:

Exception mapper statistics.

getRootResourcesByClass

JaxRsResourceRuntimeMBean[] getRootResourcesByClass()

Get the statistics for each resource Class that is deployed in the application. Note that one resource class can serve request matched to different URIs. The array contains resource classes which are registered in the resource model plus resource classes of sub resources returned from sub resource locators.

Returns:

The array of resources available in the JAX-RS application.

lookupRootResourcesByClass

JaxRsResourceRuntimeMBean lookupRootResourcesByClass(String className)

Provides the root resource MBean identified by the class name of the resource.

Parameters:

className - The name of the resource MBean.

Returns:

The resource bean identified by the given name.

getRootResourcesByUri

JaxRsUriRuntimeMBean[] getRootResourcesByUri()

Get the statistics for each URI that is exposed in the application. The array URIs that are available in application without URIs available in sub resource locators and URIs that are available trough sub resource locators and were already matched by any request.

Returns:

The array of resources (URI) available in the JAX-RS application.

lookupRootResourcesByUri

JaxRsUriRuntimeMBean lookupRootResourcesByUri(String uri)

Provides the root resource MBean identified by the uri path of the resource.

Parameters:

uri - uri (path) of the resource MBean.

Returns:

The resource bean identified by the given uri.

getServlet

ServletRuntimeMBean getServlet()

Provides the MBean of the servlet that handles the corresponding JAX-RS application.

Users can get the servlet related metrics from the returned ServletRuntimeMBean

Returns:

The corresponding servlet MBean.

isWadlGenerationEnabled

boolean isWadlGenerationEnabled()

Indicates whether this JAX-RS application currently has WADL generation enabled.

Returns:

true if the WADL generation is enabled, false otherwise.

setWadlGenerationEnabled

void setWadlGenerationEnabled(boolean wadlGenEnabled)

Enable/Disable WADL generation for this JAX-RS application.

getWadlUrl

String getWadlUrl()

Retrieve the WADL URI for this JAX-RS Application.

Returns:

Absolute URI of WADL resource.

getRootPath

String getRootPath()

Retrieve the root path for this JAX-RS Application. The path consists of (servlet) context path + application (servlet or filter) path.

Returns:

Application root path.

getResourcePattern

String getResourcePattern()

Gets the WSM resource pattern for this JAX-RS application.

Returns:

resource pattern as a String, if available, null otherwise.

getResourceConfig

JaxRsResourceConfigTypeRuntimeMBean getResourceConfig()

Deprecated. 12.2.1.0 Use JaxRsApplicationRuntimeMBean.getProperties() / JaxRsApplicationRuntimeMBean.getApplicationClass() instead.

Provides the resource config MBean of the JAX-RS application.

Every JAX-RS application is configured through a resource config. There are several types of resource configs available in Jersey. This method gets the details of the corresponding resource config created by Jersey for this JAX-RS application.

Returns:

The resource config MBean of the JAX-RS application.

getRootResources

JaxRsResourceRuntimeMBean[] getRootResources()

Deprecated. 12.2.1.0 Use JaxRsApplicationRuntimeMBean.getRootResourcesByClass() instead.

Provides the array of root resources MBean

Every JAX-RS application contains 1 or more root resources.

Returns:

The array of resources available in the JAX-RS application

lookupRootResource

JaxRsResourceRuntimeMBean lookupRootResource(String name)

Deprecated. 12.2.1.0 Use JaxRsApplicationRuntimeMBean.lookupRootResourcesByClass(String) instead.

Provides the root resource MBean identified by the name

Parameters:

name - The name of the resource MBean

Returns:

The resource bean identified by the given name.

getErrorCount

long getErrorCount()

Deprecated. 12.2.1.0 Use JaxRsExceptionMapperStatisticsRuntimeMBean.getUnsuccessfulMappings() instead.

Provides the errors count, the number of un-handled exceptions from the JAX-RS application

Returns:

The number of un-handled exceptions from a JAX-RS application

getLastErrorDetails

String[] getLastErrorDetails()

Deprecated. 12.2.1.0

Provides details of the last error. It returns null if there is not exception yet

Returns:

The details about the last error. Returns null if there is no exception yet.

getLastErrorMapper

String getLastErrorMapper()

Deprecated. 12.2.1.0

Provides the exception mapper class used against the last error (if any) occurred. It returns null if no error has been mapped yet.

Returns:

the class of the exception mapper for the raised exception. Returns null if there is no exception.

getLastErrorTime

long getLastErrorTime()

Deprecated. 12.2.1.0

Provides the date-time at which the last error(if any) occurred

Returns:

The date-time at which the last error occurred. If it is 0, then it means no error has occurred.

getLastHttpMethod

String getLastHttpMethod()

Deprecated. 12.2.1.0

Provides the http method name of the last request

Returns:

the last http method of the request Return null if there is not any request yet.

getLastResponseCode

int getLastResponseCode()

Deprecated. 12.2.1.0 Use JaxRsResponseStatisticsRuntimeMBean.getLastResponseCode() instead.

Provides the response code of the last response. Returns -1 if there is no response yet.

Returns:

The last response code. Returns -1 if there is no response yet.

getResponseCodeCounts

HashMap getResponseCodeCounts()

Deprecated. 12.2.1.0 Use JaxRsResponseStatisticsRuntimeMBean.getResponseCodes() instead.

Provides map with all response codes(int) as keys and their count(long) as values

Returns:

The response codes and their counts.

Key - integer the http response code Value - long the number of times the key is returned

getHttpMethodCounts

HashMap getHttpMethodCounts()

Deprecated. 12.2.1.0

Provides map with all method names(String) as keys and their count(long) as values

Returns:

The request methods and their counts

Key - String representing the http method of the request Value - long the number of times such requests processed

Skip navigation links