ログ実装のラッパを生成するため、次のアルゴリズムで動的にログ実装を選択する、 * {@link LogFactory} の具象サブクラスです。 * {@primary Concrete subclass of {@link LogFactory} that implements the * following algorithm to dynamically select a logging implementation * class to instantiate a wrapper for.}
*org.apache.commons.logging.Log
* を使用して要求された実装クラスを判別します。org.apache.commons.logging.Log
* を使用して要求された実装クラスを判別します。org.apache.commons.logging.impl.Log4JLogger インスタンスを返します。org.apache.commons.logging.impl.Jdk14Logger インスタンスを返します。org.apache.commons.logging.impl.SimpleLog インスタンスを返します。org.apache.commons.logging.Log to identify the
* requested implementation class.org.apache.commons.logging.Log system property
* to identify the requested implementation class.org.apache.commons.logging.impl.Log4JLogger.org.apache.commons.logging.impl.Jdk14Logger.org.apache.commons.logging.impl.SimpleLog.もし選択した {@link Log} 実装クラスが {@link LogFactory} を引数に取る
* setLogFactory() メソッドを持つ場合は、ファクトリと関連付けるために
* 新たに生成したインスタンスのこのメソッドを実行します。
* これにより、 Log インスタンスはファクトリに設定された属性を利用可能になります。
* {@primary If the selected {@link Log} implementation class has a
* setLogFactory() method that accepts a {@link LogFactory}
* parameter, this method will be called on each newly created instance
* to identify the associated factory. This makes factory configuration
* attributes available to the Log instance, if it so desires.}
このファクトリは前に作成した Log インスタンスを記憶し、同じ名前で
* 再度 getInstance() メソッドが呼ばれた場合に(同じインスタンスを)返します。
* この実装はいかなる設定された属性も無視します。
* {@primary This factory will remember previously created Log instances
* for the same name, and will return them on repeated requests to the
* getInstance() method. This implementation ignores any
* configured attributes.}
getLogConstructor() で初期化され、繰り返し使用されます。
* {@primary The one-argument constructor of the
* {@link org.apache.commons.logging.Log}
* implementation class that will be used to create new instances.
* This value is initialized by getLogConstructor(),
* and then returned repeatedly.}
*/
protected Constructor logConstructor = null;
/**
* コンストラクタで使用される引数。
* {@primary The signature of the Constructor to be used.}
*/
protected Class logConstructorSignature[] =
{ java.lang.String.class };
/**
* 選択された {@link org.apache.commons.logging.Log}
* クラスの引数が 1 つの setLogFactory メソッド(もしあれば)。
* {@primary The one-argument setLogFactory method of the selected
* {@link org.apache.commons.logging.Log} method, if it exists.}
*/
protected Method logMethod = null;
/**
* setLogFactory メソッドで使用される引数。
* {@primary The signature of the setLogFactory method to be used.}
*/
protected Class logMethodSignature[] =
{ LogFactory.class };
// --------------------------------------------------------- Public Methods
/**
* 指定された名称の設定属性を返します(もしあれば)。
* 指定された属性がない場合には null を返します。
* {@primary Return the configuration attribute with the specified name (if any),
* or null if there is no such attribute.}
*
* @param name 取得する属性の名称
* {@primary Name of the attribute to return}
*/
public Object getAttribute(String name) {
return (attributes.get(name));
}
/**
* 現在設定されている全属性の名称を配列で返します。
* 属性が 1 つも設定されていない場合は、サイズ 0 の配列を返します。
* {@primary Return an array containing the names of all currently defined
* configuration attributes. If there are no such attributes, a zero
* length array is returned.}
*/
public String[] getAttributeNames() {
Vector names = new Vector();
Enumeration keys = attributes.keys();
while (keys.hasMoreElements()) {
names.addElement((String) keys.nextElement());
}
String results[] = new String[names.size()];
for (int i = 0; i < results.length; i++) {
results[i] = (String) names.elementAt(i);
}
return (results);
}
/**
* 指定クラスから取得した名称を引数に getInstance(String)
* を呼ぶ、手順簡略化のためのメソッドです。
* {@primary Convenience method to derive a name from the specified class and
* call getInstance(String) with it.}
*
* @param clazz 適切な Log 名称の取得元クラス
* {@primary Class for which a suitable Log name will be derived}
*
* @exception LogConfigurationException 適切な Log
* インスタンスを返せなかった場合
* {@primary if a suitable Log instance cannot be returned}
*/
public Log getInstance(Class clazz) throws LogConfigurationException {
return (getInstance(clazz.getName()));
}
/**
* 現在ファクトリに設定されている属性を使用して
* Log インスタンスを(必要であれば)生成し返します。
* {@primary Construct (if necessary) and return a Log instance,
* using the factory's current set of configuration attributes.}
注 - 返される Log
* インスタンスが現在のアプリケーション固有のものであるかどうか、
* また複数回同じ名称でこのメソッドを呼んだ場合に同じインスタンスが返されるかどうかは、
* 使用している LogFactory の実装に依存します。
* {@primary NOTE - Depending upon the implementation of
* the LogFactory you are using, the Log
* instance you are returned may or may not be local to the current
* application, and may or may not be returned again on a subsequent
* call with the same name argument.}
Log インスタンスの論理名
* (名称の意味はラップされ内部で動作するログ処理の実装のみが知っています)
* {@primary Logical name of the Log instance to be
* returned (the meaning of this name is only known to the underlying
* logging implementation that is being wrapped)}
*
* @exception LogConfigurationException 適切な Log
* インスタンスを返せなかった場合
* {@primary if a suitable Log instance cannot be returned}
*/
public Log getInstance(String name) throws LogConfigurationException {
Log instance = (Log) instances.get(name);
if (instance == null) {
instance = newInstance(name);
instances.put(name, instance);
}
return (instance);
}
/**
* このファクトリがこれまで生成・返却した全ての
* {@link org.apache.commons.logging.Log} インスタンスへの内部参照を解放します。
* これはサーブレットコンテナのような環境で、実装されたアプリケーションに対して
* クラスローダからリロードが指示された場合に有用です。
* そのクラスローダの配下で参照され続けるオブジェクトはガベージコレクションを妨げます。
* {@primary Release any internal references to previously created
* {@link org.apache.commons.logging.Log}
* instances returned by this factory. This is useful environments
* like servlet containers, which implement application reloading by
* throwing away a ClassLoader. Dangling references to objects in that
* class loader would prevent garbage collection.}
*/
public void release() {
instances.clear();
}
/**
* 指定された名称の設定属性を削除します。
* 該当する属性がない場合には何も行いません。
* {@primary Remove any configuration attribute associated with the specified name.
* If there is no such attribute, no action is taken.}
*
* @param name 削除する属性の名称
* {@primary Name of the attribute to remove}
*/
public void removeAttribute(String name) {
attributes.remove(name);
}
/**
* 指定された名称の設定属性を設定します。
* 引数 value への null 指定は
* removeAttribute(name) と同等です。
* {@primary Set the configuration attribute with the specified name. Calling
* this with a null value is equivalent to calling
* removeAttribute(name).}
*
* @param name 設定する属性の名称
* {@primary Name of the attribute to set}
* @param value 設定する属性の値。 null の場合にはこの属性を削除
* {@primary Value of the attribute to set, or null
* to remove any setting for this attribute}
*/
public void setAttribute(String name, Object value) {
if (value == null) {
attributes.remove(name);
} else {
attributes.put(name, value);
}
}
// ------------------------------------------------------ Protected Methods
/**
* 使用する {@link Log} 実装クラスの完全修飾クラス名を返します。
* {@primary Return the fully qualified Java classname of the {@link Log}
* implementation we will be using.}
*/
protected String getLogClassName() {
// Return the previously identified class name (if any)
if (logClassName != null) {
return logClassName;
}
logClassName = (String) getAttribute(LOG_PROPERTY);
if (logClassName == null) { // @deprecated
logClassName = (String) getAttribute(LOG_PROPERTY_OLD);
}
if (logClassName == null) {
try {
logClassName = System.getProperty(LOG_PROPERTY);
} catch (SecurityException e) {
;
}
}
if (logClassName == null) { // @deprecated
try {
logClassName = System.getProperty(LOG_PROPERTY_OLD);
} catch (SecurityException e) {
;
}
}
if ((logClassName == null) && isLog4JAvailable()) {
logClassName = "org.apache.commons.logging.impl.Log4JLogger";
}
if ((logClassName == null) && isJdk14Available()) {
logClassName = "org.apache.commons.logging.impl.Jdk14Logger";
}
if (logClassName == null) {
logClassName = "org.apache.commons.logging.impl.SimpleLog";
}
return (logClassName);
}
/**
* 新規 {@link org.apache.commons.logging.Log} * インスタンスの生成に使用するコンストラクタを返します。 * {@primary
Return the Constructor that can be called to instantiate
* new {@link org.apache.commons.logging.Log} instances.}
実装の注 - 結局いかなる状況でも同じ
* Constructor インスタンスが取得されるため、
* 複数のスレッドがこのメソッドを呼ぶことにより起こる競合状況は無視されます。
* {@primary IMPLEMENTATION NOTE - Race conditions caused by
* calling this method from more than one thread are ignored, because
* the same Constructor instance will ultimately be derived
* in all circumstances.}
setLogFactory method (if there is one)
try {
logMethod = logClass.getMethod("setLogFactory",
logMethodSignature);
} catch (Throwable t) {
logMethod = null;
}
// Identify the corresponding constructor to be used
try {
logConstructor = logClass.getConstructor(logConstructorSignature);
return (logConstructor);
} catch (Throwable t) {
throw new LogConfigurationException
("No suitable Log constructor " +
logConstructorSignature+ " for " + logClassName, t);
}
}
/**
* このメソッドは PRIVATE のままでなくてはなりません。
* {@primary MUST KEEP THIS METHOD PRIVATE.}
*
* このメソッドは AccessController.doPrivileged() を使用しているため、
* org.apache.commons.logging.LogFactoryImpl の外部へ公開すると
* セキュリティ侵害につながります。
* {@primary Exposing this method outside of
* org.apache.commons.logging.LogFactoryImpl
* will create a security violation:
* This method uses AccessController.doPrivileged().
* }