java.lang.management

インタフェース PlatformLoggingMXBean

すべてのスーパーインタフェース:

PlatformManagedObject

public interface PlatformLoggingMXBean
extends PlatformManagedObject

ロギング機能の管理インタフェースです。

PlatformLoggingMXBean にはグローバルインスタンスが 1 つ存在します。PlatformLoggingMXBean オブジェクトは、次のように ManagementFactory.getPlatformMXBean メソッドを使用して取得できます。

     PlatformLoggingMXBean logging = ManagementFactory.getPlatformMXBean(PlatformLoggingMXBean.class);
 

PlatformLoggingMXBean オブジェクトは、プラットフォーム MBeanServer にも登録されます。MBeanServer 内で PlatformLoggingMXBean を一意に識別するための ObjectName は、次のとおりです。

      java.util.logging:type=Logging
 

この ObjectName を使ってプラットフォーム MBeanServer に登録されたインスタンスは、LoggingMXBean で定義されているすべての属性を実装します。

導入されたバージョン:

1.7

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getLoggerLevel(String loggerName) 指定されたロガーに関連付けられているログレベルの名前を取得します。
List<String>	getLoggerNames() 現在登録されている ロガーの名前のリストを返します。
String	getParentLoggerName(String loggerName) 指定されたロガーの親の名前を返します。
void	setLoggerLevel(String loggerName, String levelName) 指定されたロガーを指定された新しいレベルに設定します。

インタフェース java.lang.management.PlatformManagedObject から継承されたメソッド

getObjectName

メソッドの詳細

getLoggerNames

List<String> getLoggerNames()

現在登録されている ロガーの名前のリストを返します。このメソッドは、LogManager.getLoggerNames() を呼び出し、ロガー名のリストを返します。

戻り値:

現在登録されている Logger の名前を含む String のリスト。

getLoggerLevel

String getLoggerLevel(String loggerName)

指定されたロガーに関連付けられているログレベルの名前を取得します。指定されたロガーが存在しない場合は null が返されます。このメソッドはまず、指定された名前のロガーを検索し、次に、次の呼び出しを行ってログレベルの名前を返します。

Logger.getLevel().getName();

指定されたロガーの Level が null の場合、それはこのロガーの実効レベルが親から継承されることを意味しますが、その場合は空文字列が返されます。

パラメータ:

loggerName - 取り出される Logger の名前。

戻り値:

指定されたロガーのログレベルの名前。指定されたロガーのログレベルが null の場合は空文字列。指定されたロガーが存在しない場合は null が返されます。

関連項目:

Logger.getLevel()

setLoggerLevel

void setLoggerLevel(String loggerName,
                  String levelName)

指定されたロガーを指定された新しいレベルに設定します。levelName が null でない場合は、指定されたロガーのレベルが、levelName に一致する解析済みの Level に設定されます。levelName が null の場合は、指定されたロガーのレベルが null に設定され、このロガーの実効レベルが、特定の (null でない) レベル値を持つもっとも近い上位ノードから継承されます。

パラメータ:

loggerName - 設定する Logger の名前。null 以外。

levelName - 指定されたロガーに設定するレベルの名前。もっとも近い上位ノードからレベルが継承されるように設定する場合は null。

例外:

IllegalArgumentException - 指定されたロガーが存在しないか、levelName が有効なレベル名ではない場合。

SecurityException - セキュリティーマネージャーが存在する場合で、呼び出し元が LoggingPermission("control") を持っていない場合。

関連項目:

Logger.setLevel(java.util.logging.Level)

getParentLoggerName

String getParentLoggerName(String loggerName)

指定されたロガーの親の名前を返します。指定されたロガーが存在しない場合は null が返されます。指定されたロガーが名前空間内のルート Logger である場合、結果は空文字列になります。

パラメータ:

loggerName - Logger の名前。

戻り値:

もっとも近い既存の親ロガー。指定されたロガーがルートロガーの場合は空文字列。指定されたロガーが存在しない場合は null が返されます。