モジュール java.naming

パッケージ javax.naming

クラスNamingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.naming.NamingException

すべての実装されたインタフェース:

Serializable

直系の既知のサブクラス:

AttributeInUseException, AttributeModificationException, CannotProceedException, CommunicationException, ConfigurationException, ContextNotEmptyException, InsufficientResourcesException, InterruptedNamingException, InvalidAttributeIdentifierException, InvalidAttributesException, InvalidAttributeValueException, InvalidNameException, InvalidSearchControlsException, InvalidSearchFilterException, LimitExceededException, LinkException, NameAlreadyBoundException, NameNotFoundException, NamingSecurityException, NoInitialContextException, NoSuchAttributeException, NotContextException, OperationNotSupportedException, PartialResultException, ReferralException, SchemaViolationException, ServiceUnavailableException

public class NamingException extends Exception

ContextおよびDirContextインタフェースでの操作によってスローされるすべての例外のスーパー・クラスです。 失敗の種類は、サブクラスの名前で示されます。 この例外は、操作が失敗した位置、解決が最後に行われた位置を正確に示す情報を取得します。

• 解決名。 解決された名前の一部分。
• 解決オブジェクト。 名前の解決が行われたオブジェクト。
• 残存ネーム。 解決されていない名前の一部分。
• 説明 名前解決が失敗した理由の詳細情報。
• ルート例外。 このネーミング例外のスローの原因となった例外。

nullはこれらのどのフィールドにも受け入れられます。 nullは、上記のような情報がフィールドに対して記録されないことを意味します。

NamingExceptionインスタンスは、並行マルチスレッド・アクセスに対して同期化されません。 単一のNamingExceptionインスタンスにアクセスして変更しようとする複数のスレッドによって、オブジェクトはロックされます。

この例外は汎用的な例外チェーン・メカニズムに適合するように改良されています。 ルート例外 (または根本原因)はThrowable.getCause()メソッドによって返される原因と同じオブジェクトです。

導入されたバージョン:

1.3

関連項目:

• 直列化された形式

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
protected Name	remainingName	未解決の残りの名前を含みます。
protected Name	resolvedName	正常に解決された名前の部分を含みます。
protected Object	resolvedObj	名前の部分が正常に解決されたオブジェクトを含みます。
protected Throwable	rootException	このNamingExceptionがスローされる原因となった元の例外を含みます。

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
NamingException()	NamingExceptionを新しく構築します。
NamingException(String explanation)	NamingExceptionを説明付きで新しく構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
void	appendRemainingComponent(String name)	残りの名前の最後のコンポーネントとして名前を追加します。
void	appendRemainingName(Name name)	残りの名前の最後のコンポーネントとして「名前」からコンポーネントを追加します。
Throwable	getCause()	この例外の原因を返します。
String	getExplanation()	この例外に関連した説明を取得します。
Name	getRemainingName()	名前の残りの未解決部分を取得します。
Name	getResolvedName()	正常に解決された名前の先頭部分を取得します。
Object	getResolvedObj()	正常に解決されたオブジェクトを取得します。
Throwable	getRootCause()	このNamingExceptionの根本原因がある場合は、その根本原因を取得します。
Throwable	initCause(Throwable cause)	この例外の原因を、指定された値に初期化します。
void	setRemainingName(Name name)	この例外の残りの名前フィールドを設定します。
void	setResolvedName(Name name)	この例外の「resolvedName」フィールドを設定します。
void	setResolvedObj(Object obj)	この例外の「解決されたオブジェクト」フィールドを設定します。
void	setRootCause(Throwable e)	このNamingExceptionの根本原因を記録します。
String	toString()	この例外の文字列表現が生成されます。
String	toString(boolean detail)	より詳細な文字列表現が生成されます。

クラスjava.lang.Throwableで宣言されたメソッド

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace

クラスjava.lang.Objectで宣言されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールド詳細

resolvedName

protected Name resolvedName

正常に解決された名前の部分を含みます。 これは合成名で、nullを指定できます。 このフィールドはコンストラクタによって初期化されます。 getメソッドおよびsetメソッドによってこのフィールドにアクセスし、処理します。

関連項目:

• getResolvedName()
• setResolvedName(javax.naming.Name)

resolvedObj

protected Object resolvedObj

名前の部分が正常に解決されたオブジェクトを含みます。 nullも可。 このフィールドはコンストラクタによって初期化されます。 getメソッドおよびsetメソッドによってこのフィールドにアクセスし、処理します。

関連項目:

• getResolvedObj()
• setResolvedObj(java.lang.Object)

remainingName

protected Name remainingName

未解決の残りの名前を含みます。 これは合成名で、nullを指定できます。 このフィールドはコンストラクタによって初期化されます。 get、set、および「append」メソッドによってこのフィールドにアクセスし、処理します。

関連項目:

• getRemainingName()
• setRemainingName(javax.naming.Name)
• appendRemainingName(javax.naming.Name)
• appendRemainingComponent(java.lang.String)

rootException

protected Throwable rootException

このNamingExceptionがスローされる原因となった元の例外を含みます。 このフィールドは、元の例外から取得可能な追加情報がある場合や、NamingExceptionのサブクラスにマップできない元の例外がある場合に設定されます。 nullも可。

このフィールドは、汎用的な例外チェーン機能以前から使用されています。 initCause(Throwable)およびgetCause()メソッドが、この情報にアクセスするために現在推奨されている方法です。

関連項目:

• getRootCause()
• setRootCause(Throwable)
• initCause(Throwable)
• getCause()

コンストラクタの詳細

NamingException

public NamingException(String explanation)

NamingExceptionを説明付きで新しく構築します。 指定されていないフィールドはすべてnullに設定されます。

パラメータ:

explanation - この例外に関する追加の詳細情報を含むnullの可能性がある文字列。

関連項目:

• Throwable.getMessage()

NamingException

public NamingException()

NamingExceptionを新しく構築します。 フィールドはすべてnullに設定されます。

メソッドの詳細

getResolvedName

public Name getResolvedName()

正常に解決された名前の先頭部分を取得します。

戻り値:

正常に解決された名前の部分。 合成名である。 nullの場合はresolvedNameフィールドが設定されていないことを示す。

関連項目:

• getResolvedObj()
• setResolvedName(javax.naming.Name)

getRemainingName

public Name getRemainingName()

名前の残りの未解決部分を取得します。

戻り値:

解決されていない名前の部分。 合成名である。 nullの場合は、残りの名前フィールドが設定されていないことを示す。

関連項目:

• setRemainingName(javax.naming.Name)
• appendRemainingName(javax.naming.Name)
• appendRemainingComponent(java.lang.String)

getResolvedObj

public Object getResolvedObj()

正常に解決されたオブジェクトを取得します。 これは、解決された名前がバインドされているオブジェクトです。

戻り値:

これまでに解決されたnullの可能性があるオブジェクト。nullは、解決されたオブジェクト・フィールドが設定されていないことを示す。

関連項目:

• getResolvedName()
• setResolvedObj(java.lang.Object)

getExplanation

public String getExplanation()

この例外に関連した説明を取得します。

戻り値:

nullの可能性がある、この例外について説明する詳細文字列。 nullの場合、この例外には詳細メッセージはない。

関連項目:

• Throwable.getMessage()

setResolvedName

public void setResolvedName(Name name)

この例外の「resolvedName」フィールドを設定します。

nameはコンポジット名です。 複合名または文字列を使用してこのフィールドを設定する場合は、複合名を文字列化してから、その文字列を使用して単一のコンポーネントを含む合成名を作成する必要があります。 その結果示された合成名を使用して、このメソッドを呼び出すことができます。

nameのコピーが作成され、格納されます。 nameへの後続の変更は、このNamingException内のコピーには影響せず、その逆も同様です。

パラメータ:

name - nullの可能性がある、解決名を設定する名前。 nullの場合、resolvedNameフィールドはnullに設定される。

関連項目:

• getResolvedName()

setRemainingName

public void setRemainingName(Name name)

この例外の残りの名前フィールドを設定します。

nameはコンポジット名です。 複合名または文字列を使用してこのフィールドを設定する場合は、複合名を文字列化してから、その文字列を使用して単一のコンポーネントを含む合成名を作成する必要があります。 その結果示された合成名を使用して、このメソッドを呼び出すことができます。

nameのコピーが作成され、格納されます。 nameへの後続の変更は、このNamingException内のコピーには影響せず、その逆も同様です。

パラメータ:

name - nullの可能性がある、残存名に設定する名前。 nullの場合、残りの名前フィールドはnullに設定される。

関連項目:

• getRemainingName()
• appendRemainingName(javax.naming.Name)
• appendRemainingComponent(java.lang.String)

setResolvedObj

public void setResolvedObj(Object obj)

この例外の「解決されたオブジェクト」フィールドを設定します。

パラメータ:

obj - nullの可能性がある、解決オブジェクトに設定するオブジェクト。 nullの場合、解決されたオブジェクト・フィールドはnullに設定される。

関連項目:

• getResolvedObj()

appendRemainingComponent

public void appendRemainingComponent(String name)

残りの名前の最後のコンポーネントとして名前を追加します。

パラメータ:

name - 追加するコンポーネント。 名前がnullの場合、このメソッドは機能しない。

関連項目:

• setRemainingName(javax.naming.Name)
• getRemainingName()
• appendRemainingName(javax.naming.Name)

appendRemainingName

public void appendRemainingName(Name name)

残りの名前の最後のコンポーネントとして「名前」からコンポーネントを追加します。

nameはコンポジット名です。 複合名を追加する場合は、複合名を文字列化してから、Stringパラメータを受け入れるオーバーロードされた形式を呼び出します。

後続のnameの変更は、このNamingExceptionの残りの名前フィールドには影響せず、その逆も同様です。

パラメータ:

name - nullの可能性がある、追加する順序付きコンポーネントを含んだ文字列。 名前がnullの場合、このメソッドは機能しない。

関連項目:

• setRemainingName(javax.naming.Name)
• getRemainingName()
• appendRemainingComponent(java.lang.String)

getRootCause

public Throwable getRootCause()

このNamingExceptionの根本原因がある場合は、その根本原因を取得します。 ネーミング例外の根本原因は、サービス・プロバイダが呼出し側に対して名前以外に関連する例外を示すときに使用されますが、同時にNamingException構造を使用してネーミング操作処理の完了状況を示す場合にも使用されます。

このメソッドは汎用的な例外チェーン機能に先行します。 getCause()メソッドが、この情報を取得するために現在推奨されている手段です。

戻り値:

nullの可能性がある、このネーミング例外の原因となった例外。 nullの場合は、このネーミング例外に対して根本原因が設定されていないことを示す。

関連項目:

• setRootCause(java.lang.Throwable)
• rootException
• getCause()

setRootCause

public void setRootCause(Throwable e)

このNamingExceptionの根本原因を記録します。 eがthisの場合、このメソッドは何も行いません。

このメソッドは汎用的な例外チェーン機能に先行します。 initCause(Throwable)メソッドが、この情報を記録するために現在推奨されている手段です。

パラメータ:

e - nullの可能性がある、失敗するネーミング操作の原因となった例外。 nullの場合は、このネーミング例外に対して根本原因がないことを示す。

関連項目:

• getRootCause()
• rootException
• initCause(java.lang.Throwable)

getCause

public Throwable getCause()

この例外の原因を返します。 原因は、このネーミング例外がスローされる原因となったThrowableです。 原因が存在しない場合や不明な場合は、nullを返します。

オーバーライド:

getCause、クラスThrowable

戻り値:

この例外の原因。原因が存在しないか不明な場合はnull。

導入されたバージョン:

1.4

関連項目:

• initCause(Throwable)

initCause

public Throwable initCause(Throwable cause)

この例外の原因を、指定された値に初期化します。 原因は、このネーミング例外がスローされる原因となったThrowableです。

このメソッドは最大で1回呼び出すことができます。

オーバーライド:

initCause、クラスThrowable

パラメータ:

cause - 原因(あとでgetCause()メソッドで取得できるように保存される)。 null値は、原因が存在しないか不明であることを示します。

戻り値:

このNamingExceptionインスタンスへの参照。

例外:

IllegalArgumentException - causeがこの例外の場合。 (Throwableはそれ自身の原因にはなれない)

IllegalStateException - このメソッドが、この例外に対してすでに呼び出されていた場合。

導入されたバージョン:

1.4

関連項目:

• getCause()

toString

public String toString()

この例外の文字列表現が生成されます。 文字列表現は、この例外のクラス名、その詳細メッセージで構成されます。根本原因がある場合は、根本原因を持つ例外の文字列表現と、その後に続く残りの名前(nullでない場合)で構成されます。 この文字列はデバッグに使用され、プログラムによって解釈されることはありません。

オーバーライド:

toString、クラスThrowable

戻り値:

この例外の文字列表現が格納されるnull以外の文字列。

toString

public String toString(boolean detail)

より詳細な文字列表現が生成されます。 この文字列表現は、パラメータをとらないtoString()によって返される情報と、解決されたオブジェクトの文字列表現(nullでない場合)で構成されます。 この文字列はデバッグに使用され、プログラムによって解釈されることはありません。

パラメータ:

detail - trueの場合、ほかの情報以外に解決されたオブジェクトに関する詳細を含む。

戻り値:

文字列表現が格納されるnull以外の文字列。