Package org.jboss.weld.probe

Interface JsonDataProvider

All Known Implementing Classes:

DefaultJsonDataProvider

@MXBean
public interface JsonDataProvider

A component which loads JSON data for a specific Resource. This interface also represents a MXBean which allows to access Probe JSON data via JMX.

Author:

Martin Kouba

Method Summary

Modifier and Type	Method	Description
String	clearEvents()
String	clearInvocations()
String	receiveAvailableBeans(int pageIndex, int pageSize, String filters, String representation)
String	receiveBean(String id, boolean transientDependencies, boolean transientDependents)
String	receiveBeanInstance(String id)
String	receiveBeans(int pageIndex, int pageSize, String filters, String representation)
String	receiveContext(String id)
String	receiveContexts()
String	receiveDeployment()
String	receiveEvents(int pageIndex, int pageSize, String filters)
String	receiveInvocation(String id)
String	receiveInvocations(int pageIndex, int pageSize, String filters)
String	receiveMonitoringStats()
String	receiveObserver(String id)
String	receiveObservers(int pageIndex, int pageSize, String filters)

Method Detail

receiveDeployment

@Description("Receives a deployment info.")
String receiveDeployment()

Returns:

the JSON data

See Also:

Resource.DEPLOYMENT

receiveBeans

@Description("Receives a collection of beans.")
String receiveBeans(@ParamName("pageIndex")
                    int pageIndex,
                    @ParamName("pageSize")
                    int pageSize,
                    @ParamName("filters") @Description("A blank-separated list of key-value pairs. Keys and values are separated by a colon. E.g beanClass:\"Foo\" scope:\"myScope\".")
                    String filters,
                    @ParamName("representation")
                    String representation)

Parameters:

pageIndex -

pageSize -

filters -

representation -

Returns:

the JSON data

See Also:

Resource.BEANS

receiveBean

@Description("Receives a bean detail.")
String receiveBean(@ParamName("id")
                   String id,
                   @ParamName("transientDependencies")
                   boolean transientDependencies,
                   @ParamName("transientDependents")
                   boolean transientDependents)

Parameters:

id -

Returns:

the JSON data

See Also:

Resource.BEAN

receiveBeanInstance

@Description("Receives a contextual instance of a bean. This is only supported for a limited set of scopes.")
String receiveBeanInstance(@ParamName("id")
                           String id)

Parameters:

id -

Returns:

the JSON data

See Also:

Resource.BEAN_INSTANCE

receiveObservers

@Description("Receives a collection of observer methods.")
String receiveObservers(@ParamName("pageIndex")
                        int pageIndex,
                        @ParamName("pageSize")
                        int pageSize,
                        @ParamName("filters") @Description("A blank-separated list of key-value pairs. Keys and values are separated by a colon. E.g beanClass:\"Foo\" qualifier:\"any\".")
                        String filters)

Parameters:

pageIndex -

pageSize -

filters -

Returns:

the JSON data

See Also:

Resource.OBSERVERS

receiveObserver

@Description("Receives an observer method detail.")
String receiveObserver(@ParamName("id")
                       String id)

Parameters:

id -

Returns:

the JSON data

See Also:

Resource.OBSERVER

receiveContexts

@Description("Receives a collection of inspectable contexts.")
String receiveContexts()

Returns:

the JSON data

See Also:

Resource.CONTEXTS

receiveContext

@Description("Receives a collection of contextual instances for the given inspectable context.")
String receiveContext(@ParamName("id")
                      String id)

Parameters:

id -

Returns:

the JSON data

See Also:

Resource.CONTEXT

receiveInvocations

@Description("Receives a collection of invocation trees.")
String receiveInvocations(@ParamName("pageIndex")
                          int pageIndex,
                          @ParamName("pageSize")
                          int pageSize,
                          @ParamName("filters") @Description("A blank-separated list of key-value pairs. Keys and values are separated by a colon. E.g beanClass:\"Foo\" description:\"bar\".")
                          String filters)

Parameters:

pageIndex -

pageSize -

filters -

Returns:

the JSON data

See Also:

Resource.INVOCATIONS

clearInvocations

@Description("Removes all monitoring data - invocation trees.")
String clearInvocations()

Returns:

the JSON result

See Also:

Resource.INVOCATIONS

receiveInvocation

@Description("Receives an invocation tree detail.")
String receiveInvocation(@ParamName("id")
                         String id)

Parameters:

id -

Returns:

the JSON data

See Also:

Resource.INVOCATION

receiveEvents

@Description("Receives a collection of fired events.")
String receiveEvents(@ParamName("pageIndex")
                     int pageIndex,
                     @ParamName("pageSize")
                     int pageSize,
                     @ParamName("filters") @Description("A blank-separated list of key-value pairs. Keys and values are separated by a colon. E.g beanClass:\"Foo\" description:\"bar\".")
                     String filters)

Parameters:

pageIndex -

pageSize -

filters -

Returns:

the JSON data

See Also:

Resource.EVENTS

clearEvents

@Description("Removes all monitoring data - fired events.")
String clearEvents()

Returns:

the JSON result

See Also:

Resource.EVENTS

receiveMonitoringStats

@Description("Receives monitoring stats.")
String receiveMonitoringStats()

Returns:

the JSON result

See Also:

Resource.MONITORING_STATS

receiveAvailableBeans

@Description("Receives a collection of beans availabe in a specific bean deployment archive.")
String receiveAvailableBeans(@ParamName("pageIndex")
                             int pageIndex,
                             @ParamName("pageSize")
                             int pageSize,
                             @ParamName("filters") @Description("A blank-separated list of key-value pairs. Keys and values are separated by a colon. E.g requiredType:\"com.foo.Bar\" resolve:false.")
                             String filters,
                             @ParamName("representation")
                             String representation)

Parameters:

pageIndex -

pageSize -

filters -

representation -

Returns:

the JSON data

See Also:

Resource.AVAILABLE_BEANS