/** Marker interface which indicates that this MBean is a utility object. Utilities objects are usually singletons, but are not required to be so. */ @Taxonomy(stability = Stability.UNCOMMITTED) public interface Utility { }
/** A marker interface which indicates that this MBean is one-of-a-kind *within its scope*. */ @Taxonomy(stability = Stability.UNCOMMITTED) public interface Singleton extends AMXProxy { }
/** A marker interface which indicates that this MBean is one-of-a-kind *within its scope*. */ @Taxonomy(stability = Stability.UNCOMMITTED) public interface Singleton extends AMXProxy { }
/** Marker interface which indicates that this MBean is a utility object. Utilities objects are usually singletons, but are not required to be so. */ @Taxonomy(stability = Stability.UNCOMMITTED) public interface Utility { }
/** Runtime exception used in proxying code and similar situations on the client side. */ @Taxonomy(stability = Stability.UNCOMMITTED) public final class AMXException extends RuntimeException { public AMXException( final String msg, final Throwable t ) { super(msg, t); } public AMXException( final String msg ) { super(msg); } }
/** Runtime exception used in proxying code and similar situations on the client side. */ @Taxonomy(stability = Stability.UNCOMMITTED) public final class AMXException extends RuntimeException { public AMXException( final String msg, final Throwable t ) { super(msg, t); } public AMXException( final String msg ) { super(msg); } }
/** @since AS 9.0 */ @Taxonomy(stability = Stability.EXPERIMENTAL) public final class LogUtil { private LogUtil() {} /** Instantiate a {@link LogQueryResult} using a CompositeData as returned from {@link LogQuery#queryServerLog}. */ public static final LogQueryResult createLogQueryResult( final CompositeData data ) { return null; } }
/** @since AS 9.0 */ @Taxonomy(stability = Stability.EXPERIMENTAL) public final class LogUtil { private LogUtil() {} /** Instantiate a {@link LogQueryResult} using a CompositeData as returned from {@link LogQuery#queryServerLog}. */ public static final LogQueryResult createLogQueryResult( final CompositeData data ) { return null; } }
/** Provide information about who's listening. */ @Taxonomy(stability = Stability.UNCOMMITTED) public interface ListenerInfo { /** Get the number of listeners which are listening for the specified type of Notification. If there are anonymous listeners (those that have no filter or a non-standard filter) then this routine will return the value 1. @param notificationType any Notification type, should usually be one advertised via MBeanInfo @return count of listeners */ public int getNotificationTypeListenerCount(final String notificationType); /** Get the total number of listeners listening for anything. @return count of listeners */ public int getListenerCount(); }
/** Interface which can be applied over the CompositeData returned from {@link LogQuery#queryServerLog}. @since AS 9.0 @see LogQueryEntry @see LogQuery */ @Taxonomy(stability = Stability.EXPERIMENTAL) public interface LogQueryResult { /** Get field names for each field of a {@link LogQueryEntry}. Log entries in the server <i>log file</i> are of the form:<br> <code><pre>[#|DATE|LEVEL|PRODUCT_NAME|MODULE|NAME_VALUE_PAIRS|MESSAGE|#]</pre></code><br> The metadata contains most of these fields, but does <b not> contain the PRODUCT_NAME or '#' columns. */ public String[] getFieldNames(); /** Return all log entries found by the query <b>not including the field headers</b>. */ public LogQueryEntry[] getEntries(); }
/** Provide information about who's listening. */ @Taxonomy(stability = Stability.UNCOMMITTED) public interface ListenerInfo { /** Get the number of listeners which are listening for the specified type of Notification. If there are anonymous listeners (those that have no filter or a non-standard filter) then this routine will return the value 1. @param notificationType any Notification type, should usually be one advertised via MBeanInfo @return count of listeners */ public int getNotificationTypeListenerCount(final String notificationType); /** Get the total number of listeners listening for anything. @return count of listeners */ public int getListenerCount(); }
/** Interface which can be applied over the CompositeData returned from {@link LogQuery#queryServerLog}. @since AS 9.0 @see LogQueryEntry @see LogQuery */ @Taxonomy(stability = Stability.EXPERIMENTAL) public interface LogQueryResult { /** Get field names for each field of a {@link LogQueryEntry}. Log entries in the server <i>log file</i> are of the form:<br> <code><pre>[#|DATE|LEVEL|PRODUCT_NAME|MODULE|NAME_VALUE_PAIRS|MESSAGE|#]</pre></code><br> The metadata contains most of these fields, but does <b not> contain the PRODUCT_NAME or '#' columns. */ public String[] getFieldNames(); /** Return all log entries found by the query <b>not including the field headers</b>. */ public LogQueryEntry[] getEntries(); }
@Taxonomy(stability = Stability.EXPERIMENTAL) public final class LogRecordFields
@Taxonomy(stability = Stability.EXPERIMENTAL) public final class LogRecordFields
/** @deprecated Extra information available about each {@link AMXProxy}. Most of these fields are for advanced use and/or direct use of JMX. */ @Taxonomy(stability = Stability.UNCOMMITTED) @Deprecated public interface Extra extends StdAttributesAccess, MetaGetters, AMXProxy { /** Get the MBeanServerConnection. */ public MBeanServerConnection mbeanServerConnection(); /** @return the {@link ProxyFactory} that created this proxy. */ public ProxyFactory proxyFactory(); /** return a compilable Java interface representing this MBean */ public String java(); }
/** @deprecated Extra information available about each {@link AMXProxy}. Most of these fields are for advanced use and/or direct use of JMX. */ @Taxonomy(stability = Stability.UNCOMMITTED) @Deprecated public interface Extra extends StdAttributesAccess, MetaGetters, AMXProxy { /** Get the MBeanServerConnection. */ public MBeanServerConnection mbeanServerConnection(); /** @return the {@link ProxyFactory} that created this proxy. */ public ProxyFactory proxyFactory(); /** return a compilable Java interface representing this MBean */ public String java(); }
/** @deprecated MBean implementations can 'implements AMX_SPI', though it is only behavior via MBeanInfo and attributes that is actually required. */ @Taxonomy(stability = Stability.COMMITTED) @Deprecated public interface AMX_SPI { /** the unencoded name, which could differ from the value of the 'name' property in the ObjectName */ @ManagedAttribute @Description("Name of this MBean, can differ from name in ObjectName") public String getName(); /** Return the ObjectName of the parent. Must not be null (except for DomainRoot) */ @ManagedAttribute @Description("Parent of this MBean, non-null except for DomainRoot") public ObjectName getParent(); /** If no children are possible (a leaf node), an AttributeNotFoundException should be thrown. */ @ManagedAttribute @Description("Children of this MBean, in no particular order") public ObjectName[] getChildren(); }
/** @deprecated MBean implementations can 'implements AMX_SPI', though it is only behavior via MBeanInfo and attributes that is actually required. */ @Taxonomy(stability = Stability.COMMITTED) @Deprecated public interface AMX_SPI { /** the unencoded name, which could differ from the value of the 'name' property in the ObjectName */ @ManagedAttribute @Description("Name of this MBean, can differ from name in ObjectName") public String getName(); /** Return the ObjectName of the parent. Must not be null (except for DomainRoot) */ @ManagedAttribute @Description("Parent of this MBean, non-null except for DomainRoot") public ObjectName getParent(); /** If no children are possible (a leaf node), an AttributeNotFoundException should be thrown. */ @ManagedAttribute @Description("Children of this MBean, in no particular order") public ObjectName[] getChildren(); }
/** "Ex" = extensions: any additional MBeans, especially those that are derivative and/or have other dependencies than amx-core. */ @Taxonomy(stability = Stability.UNCOMMITTED) @AMXMBeanMetadata(singleton = true, globalSingleton = true, leaf = true) public interface Ext extends AMXProxy, Singleton, Utility { @ManagedAttribute public Realms getRealms(); }
/** <em>Note: this API is highly volatile and subject to change<em>. <p> Query configuration changes that require restart. <p> Changes are listed oldest first. The system may drop older changes in order to limit the size of the list and/or merge related changes to the most recent. <p> Over the wire transmission of 'UnprocessedConfigChange' would require the client to have its class; as delivered the Object[] contains only standard JDK types. Actual over-the-wire type is List<Object[]. See the Javadoc for {@link UnprocessedConfigChange} for the order of values in the Object[]. */ @ManagedAttribute @Taxonomy(stability = Stability.UNCOMMITTED) public List<Object[]> getRestartRequiredChanges();