Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-02

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)

Access limited to the following security roles:
Operator

Method Summary
 long getErrorCount()
          Provides the errors count, the number of un-handled exceptions from the JAX-RS application
 HashMap getHttpMethodCounts()
          Provides map with all method names(String) as keys and their count(long) as values
 String[] getLastErrorDetails()
          Provides details of the last error.
 String getLastErrorMapper()
          Provides the exception mapper class used against the last error(if any) occurred.
 long getLastErrorTime()
          Provides the date-time at which the last error(if any) occurred
 String getLastHttpMethod()
          Provides the http method name of the last request
 int getLastResponseCode()
          Provides the response code of the last response.
 JaxRsResourceConfigTypeRuntimeMBean getResourceConfig()
          Provides the resource config MBean of the JAX-RS application.
 String getResourcePattern()
          Gets the WSM resource pattern for this JAX-RS application
 HashMap getResponseCodeCounts()
          Provides map with all response codes(int) as keys and their count(long) as values
 JaxRsResourceRuntimeMBean[] getRootResources()
          Provides the array of root resources MBean
 ServletRuntimeMBean getServlet()
          Provides the MBean of the servlet that handles the corresponding JAX-RS application.
 String getWadlUrl()
          Retrieve the WADL URL for this JAX-RS Application
 boolean isApplicationEnabled()
          Indicates whether this JAX-RS application is currently enabled
 boolean isWadlGenerationEnabled()
          Indicates whether this JAX-RS application currently has WADL generation enabled
 JaxRsResourceRuntimeMBean lookupRootResource(String name)
          Provides the root resource MBean identified by the name
 void setApplicationEnabled(boolean applicationEnabled)
          Enable/Disable this JAX-RS application - if disabled, requests to the application will return 503 - Service Unavailable
 void setWadlGenerationEnabled(boolean wadlGenEnabled)
          Enable/Disable WADL generation for this JAX-RS application
 
Methods inherited from interface weblogic.management.runtime.JaxRsMonitoringInfoRuntimeMBean
getExecutionTimeAverage, getExecutionTimeHigh, getExecutionTimeLow, getExecutionTimeTotal, getInvocationCount, getLastInvocationTime, getStartTime
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 

Method Detail

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.

getResourceConfig

JaxRsResourceConfigTypeRuntimeMBean getResourceConfig()

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()

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)

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()

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()

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

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

getLastErrorMapper

String getLastErrorMapper()

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()

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()

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()

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()

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()

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

getResourcePattern

String getResourcePattern()

Gets the WSM resource pattern for this JAX-RS application

Returns:
resource pattern as a String, if available, null otherwise

isApplicationEnabled

boolean isApplicationEnabled()

Indicates whether this JAX-RS application is currently enabled


setApplicationEnabled

void setApplicationEnabled(boolean applicationEnabled)

Enable/Disable this JAX-RS application - if disabled, requests to the application will return 503 - Service Unavailable


isWadlGenerationEnabled

boolean isWadlGenerationEnabled()

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


setWadlGenerationEnabled

void setWadlGenerationEnabled(boolean wadlGenEnabled)

Enable/Disable WADL generation for this JAX-RS application


getWadlUrl

String getWadlUrl()

Retrieve the WADL URL for this JAX-RS Application


Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-02