Cisco Unified JTAPI 開発者ガイド for Cisco Unified Communications Manager リリース 7.1(2)

宣言

（注） 複数のパラメータの送信は、ParameterList を指定すれば可能です。

コンストラクタ

AlarmManager(String, AlarmWriter, Trace, UnconditionalTrace)

ファシリティに対して AlarmManager のインスタンスを作成します。アプリケーションで、AlarmService に Alarm を送信するための、この AlarmManager により使用される AlarmWriter を指定します。

メソッド

createAlarm(String, int)

subFacility に要求された重大度の Alarm を作成します。

戻り値：

アラーム インターフェイスを実装するオブジェクト。

getAlarmWriter()

戻り値：

AlarmWriter オブジェクト。

setAlarmWriter(AlarmWriter)

アプリケーションが、この AlarmManager によって使用される AlarmWriter を、ユーザ定義の AlarmWriter でオーバーライドすることを可能にします。

宣言

既知の実装クラスの一覧

DefaultAlarmWriter

メンバの概要

メソッド

close()

AlarmWriter をクローズします。

getDescription()

戻り値：

AlarmWriter の説明。

getEnabled()

戻り値：

AlarmWriter の現在の有効または無効の状態。

getName()

戻り値：

AlarmWriter の名前。

send(String)

アラーム メッセージを AlarmService に送信します。

パラメータ：

the ：送信する Alarm。

setEnabled(boolean)

AlarmWriter を有効または無効にします。

パラメータ：

enable ：AlarmWriter を有効または無効にします。

宣言

実装インターフェイスの一覧

Alarm

メンバの概要

コンストラクタ

DefaultAlarm(String, String, int, AlarmWriter)

メソッド

getFacility()

定義：

インターフェイス Alarm の getFacility

getSeverity()

定義：

インターフェイス Alarm の getSeverity

getSubFacility()

定義：

インターフェイス Alarm の getSubFacility

send(String)

指定されたニーモニック付きでアラームを送信します。

定義：

インターフェイス Alarm の send

send(String, ParameterList)

指定された名前とパラメータ リスト付きでアラームを送信します。

定義：

インターフェイス Alarm の send

send(String, String, String)

指定された名前とパラメータ付きでアラームを送信します。

定義：

インターフェイス Alarm の send

宣言

実装インターフェイスの一覧

AlarmWriter

メンバの概要

コンストラクタ

DefaultAlarmWriter(int, String)

AlarmService のホスト名、ポートを指定できる、DefaultAlarmWriter のコンストラクタ。キューサイズは 50 になります。AlarmService は、このポートで Alarm メッセージを受信します。

パラメータ：

port ：アラーム サービスがアラームを受信するポート。

alarmServiceName ：アラーム サービスを所有するマシンのホスト名。

例外：

java.net.UnknownHostException

DefaultAlarmWriter(int, String, int)

AlarmService のホスト名、ポート、キュー サイズ、デバッグ トレース レベル、エラー トレース レベルを指定できる、DefaultAlarmWriter のコンストラクタ。AlarmService は、このポートで Alarm メッセージを受信します。

パラメータ：

port ：アラーム サービスがアラームを受信するポート。

alarmServiceName ：アラーム サービスを所有するマシンのホスト名。

queueSize ：アラーム ライターで保持されるキューのサイズ。

debugTrace ：デバッグ トレース レベル。

errorTrace ：エラー トレース レベル。

例外：

java.net.UnknownHostException

DefaultAlarmWriter(int, String, int, ConditionalTrace, UnconditionalTrace)

AlarmService のホスト名、ポートおよびキュー サイズを指定できる、DefaultAlarmWriter のコンストラクタ。AlarmService は、このポートで Alarm メッセージを受信します。

パラメータ：

port ：アラーム サービスがアラームを受信するポート。

alarmServiceName ：アラーム サービスを所有するマシンのホスト名。

queueSize ：アラーム ライターで保持されるキューのサイズ。

例外：

java.net.UnknownHostException

メソッド

close()

送信スレッドをシャットダウンし、ソケットをクローズします。

定義：

インターフェイス AlarmWriter の close

getDescription()

定義：

インターフェイス AlarmWriter の getDescription

戻り値：

AlarmWriter の簡単な説明。

getEnabled()

定義：

インターフェイス AlarmWriter の getEnabled

戻り値：

AlarmWriter の有効状態。

getName()

定義：

インターフェイス AlarmWriter の getName

戻り値：

AlarmWriter の名前。

main(String[])

send(String)

Alarm をアラーム サービスに送信します。

定義：

インターフェイス AlarmWriter の send

setEnabled(boolean)

アプリケーションは、AlarmWriter を動的に有効または無効にできます。

定義：

インターフェイス AlarmWriter の setEnabled

宣言

メンバの概要

コンストラクタ

ParameterList()

ParameterList のデフォルト コンストラクタ。

ParameterList(String, String)

名前と値のペアを持つコンストラクタ。

メソッド

addParameter(String, String)

名前と値のペア（パラメータ）をリストに追加するメソッド。

getParameterNames()

リストのパラメータ名を取得します。

戻り値：

パラメータの配列。

getParameterValue(String)

パラメータの値を取得します。

戻り値：

パラメータの値。

removeAllParameters()

リストにあるすべてのパラメータを除去します。

removeParameter(String)

特定のパラメータを除去します（リストにある場合）。

toString()

オーバーライド：

クラス Object 内の toString

宣言

既知の実装クラスの一覧

DefaultAlarm

メンバの概要

フィールド

ALERTS

アプリケーションはタスクの作業を継続できるが、すべての機能が動作可能なわけではない（リストの 1 つ以上のデバイスがアクセス不能であるが、他はアクセス可能）。
Syslog 重大度 = 1

CRITICAL

重大な障害であり、アプリケーションはこの障害が原因で要求されたタスクを達成できない。たとえば、アプリケーションが、データベースを開いてデバイス リストを読むことができない。
Syslog 重大度 = 2

DEBUGGING

エラーまたはプロセスの状態に関する詳細な情報で、DEBUG モードが有効になっているときだけに生成される。

Syslog 重大度 = 7

EMERGENCIES

緊急状態であり、システムのシャットダウンが必要。
Syslog 重大度 = 0

ERROR

何らかのエラーの状態が発生し、ユーザは、この障害の性質を理解する必要がある。
Syslog 重大度 = 3

HIGHEST_LEVEL

最高位のトレース レベルであり、現在は、トレース レベル 7 の DEBUGGING。

INFORMATIONAL

エラー、警告、監査、またはデバッグに関係しない形式の情報。
Syslog 重大度 = 6

LOWEST_LEVEL

最低位のトレース レベルであり、現在は、トレース レベル 0 の EMERGENCIES。

NO_SEVERITY

重大度のない Alarm の生成には、アプリケーションでこのレベルを設定できる。注意：これは、アプリケーションで、カタログにあるアラームに関連する重大度を AlarmService に使用させる場合だけを想定しています。

NOTIFICATION

NOTIFICATION は正常であるが、重大な状態を示す。

Syslog 重大度 = 5

UNKNOWN_MNEMONIC

Alarm の送信の際、ニーモニックが設定されていない場合に使用される文字列。

WARNING

なんらかの問題が存在するが、アプリケーションのタスクの実行が妨げられてはいないという警告。

Syslog 重大度 = 4

メソッド

getFacility()

戻り値：

この Alarm のファシリティ名。

getSeverity()

戻り値：

アラームの重大度。[0-7] の範囲の整数。

getSubFacility()

戻り値：

この Alarm のサブファシリティ。

send(String)

指定されたニーモニック付きで Alarm を送信します。null または空文字列が渡された場合、ニーモニック UNK が送信されます。

send(String, ParameterList)

指定されたニーモニックとパラメータ リスト付きで Alarm を送信します。

send(String, String, String)

指定されたニーモニックと 1 つのパラメータ付きでアラームを送信します。

宣言

既知の実装クラスの一覧

DefaultAlarmWriter

メンバの概要

メソッド

close()

AlarmWriter をクローズします。

getDescription()

戻り値：

AlarmWriter の説明。

getEnabled()

戻り値：

AlarmWriter の現在の有効または無効の状態。

getName()

戻り値：

AlarmWriter の名前。

send(String)

アラーム メッセージを AlarmService に送信します。

パラメータ：

the ：送信する Alarm。

setEnabled(boolean)

AlarmWriter を有効または無効にします。

パラメータ：

enable ：AlarmWriter を有効または無効にします。

宣言

実装インターフェイスの一覧

TraceWriter

直系の既知のサブクラス

ConsoleTraceWriter, LogFileTraceWriter, OutputStreamTraceWriter, SyslogTraceWriter

メンバの概要

コンストラクタ

BaseTraceWriter(int[], String, String)

Trace.LOWEST_LEVEL および Trace.HIGHEST_LEVEL の範囲を超えた traceLevels 配列に渡された、トレース レベル付き BaseTraceWriter は、無視されます。

パラメータ：

traceLevels ：トレース レベルの配列。

関連項目：

Trace

BaseTraceWriter(int, String, String)

maxTraceLevel までのすべてのレベルをトレースする BaseTraceWriter。トレース レベルは、[Trace.HIGHEST_LEVEL, Trace.LOWEST_LEVEL] の範囲に維持されます。

関連項目：

Trace

BaseTraceWriter(String, String)

重大度レベルが Trace.LOWEST_LEVEL である最低レベルのメッセージだけをトレースする BaseTraceWriter。

関連項目：

Trace

メソッド

close()

次のインターフェイスからコピーされた記述：

com.cisco.services.tracing.TraceWriter

この TraceWriter によって関連付けられたすべてのリソースを解放します。

定義：

インターフェイス TraceWriter の close

doClose()

doFlush()

doPrintln(String, int)

特定のトレース機能を実現するために、BaseTraceWriter を拡張するさまざまな TraceWriter に実装する必要があります。

flush()

次のインターフェイスからコピーされた記述： com.cisco.services.tracing.TraceWriter

println メソッドを使用して、出力されたすべてのメッセージを強制出力します。

定義：

インターフェイス TraceWriter の flush

getDescription()

定義：

インターフェイス TraceWriter の getDescription

getEnabled()

次のインターフェイスからコピーされた記述： com.cisco.services.tracing.TraceWriter

println メソッドによって出力されるものがあるかどうかを返します。クローズされた TraceWriter のこのメソッドは、常に false を返します。

定義：

インターフェイス TraceWriter の getEnabled

getName()

定義：

インターフェイス TraceWriter の getName

getTraceLevels()

定義：

インターフェイス TraceWriter の getTraceLevels

println(String, int)

次のインターフェイスからコピーされた記述： com.cisco.services.tracing.TraceWriter

指定された文字列とそれに続く改行を出力します。具象 TraceWriter クラスでは、重大度を使用して、特定のストリームからのメッセージをブロックします。各 TraceWriter は、実行する必要のある最高位レベルのトレースを認知しています。

定義：

インターフェイス TraceWriter の println

setTraceLevels(int[])

次のインターフェイスからコピーされた記述： com.cisco.services.tracing.TraceWriter

この TraceWriter によりトレースされるトレース レベルを設定します。

定義：

インターフェイス TraceWriter の setTraceLevels

toString()

オーバーライド：

クラス Object 内の toString

宣言

実装インターフェイスの一覧

TraceWriter

メンバの概要

コンストラクタ

ConsoleTraceWriter()

デフォルトのコンストラクタ。すべての重大度レベルをトレースします。

ConsoleTraceWriter(int)

トレースする最大レベルを設定するコンストラクタ。

関連項目：

Trace

ConsoleTraceWriter(int[])

トレース レベルの配列を使用して ConsoleTraceWriter を構築します。トレース レベル配列に重大度のあるトレースだけが、トレースされます。

パラメータ：

int ：[] traceLevels

関連項目：

Trace

メソッド

doFlush()

オーバーライド：

クラス BaseTraceWriter 内の doFlush

doPrintln(String, int)

次のクラスからコピーされた記述： com.cisco.services.tracing.BaseTraceWriter

特定のトレース機能を実現するために、BaseTraceWriter を拡張するさまざまな TraceWriter に実装する必要があります。

オーバーライド：

クラス BaseTraceWriter 内の doPrintln

main(String[])

宣言

実装インターフェイスの一覧

TraceWriter

メンバの概要

フィールド

DEFAULT_FILE_NAME_BASE

DEFAULT_FILE_NAME_EXTENSION

DIR_BASE_NAME_NUM_SEPERATOR

MIN_FILE_SIZE

MIN_FILES

ROLLOVER_THRESHOLD

コンストラクタ

LogFileTraceWriter(String, String, int, int)

すべてのレベルのトレースに、任意の数のファイルを順に処理する LogFileTraceWriter のデフォルトのコンストラクタ。path および Directory Base 名を指定しないので、ファイルは、サブディレクトリを作成せずに現行ディレクトリに書き込まれます。

例外：

java.io.IOException

LogFileTraceWriter(String, String, String, String, int, int, boolean)

すべてのレベルのトレースに、任意の数のファイルを順に処理する LogFileTraceWriter のデフォルトのコンストラクタ。

例外：

java.io.IOException

LogFileTraceWriter(String, String, String, String, int, int, int, boolean)

任意の数のファイルを順に処理し、指定のディレクトリに保存する LogFileTraceWriter を構築します。

例外：

java.io.IOException

メソッド

doClose()

この OutputStream をクローズします。現在オープンされているすべてのログ ファイルも、同様にクローズされます。

オーバーライド：

クラス BaseTraceWriter 内の doClose

doFlush()

オーバーライド：

クラス BaseTraceWriter 内の doFlush

doPrintln(String, int)

次のクラスからコピーされた記述： com.cisco.services.tracing.BaseTraceWriter

特定のトレース機能を実現するために、BaseTraceWriter を拡張するさまざまな TraceWriter に実装する必要があります。

オーバーライド：

クラス BaseTraceWriter 内の doPrintln

getCurrentFile()

戻り値：

CurrentFile プロパティ。

getFileExtension()

戻り値：

FileExtension プロパティ。

getFileNameBase()

戻り値：

FileNameBase プロパティ。

getHeader()

各ログ ファイルの先頭に書き込まれるヘッダー文字列を取得します。

戻り値：

Header プロパティ。

getMaxFiles()

戻り値：

MaxFiles プロパティ。

getMaxFileSize()

戻り値：

MaxFileSize プロパティ。

setHeader(String)

各ファイルの先頭に書き込まれるヘッダー定数を設定します。トレースの書き込みは、ヘッダーが書き込まれた次の行から継続されます。 setHeader がファイル出力の開始後に呼び出された場合、次に書き込まれるファイルから有効になります。

使用法：

宣言

実装インターフェイスの一覧

TraceWriter

メンバの概要

コンストラクタ

OutputStreamTraceWriter(int, OutputStream)

オートフラッシュするデフォルトのコンストラクタ。

関連項目：

Trace

OutputStreamTraceWriter(int, OutputStream, boolean)

OutputStreamTraceWriter を作成します。

関連項目：

Trace

メソッド

doClose()

オーバーライド：

クラス BaseTraceWriter 内の doClose

doFlush()

オーバーライド：

クラス BaseTraceWriter 内の doFlush

doPrintln(String, int)

次のクラスからコピーされた記述： com.cisco.services.tracing.BaseTraceWriter

特定のトレース機能を実現するために、BaseTraceWriter を拡張するさまざまな TraceWriter に実装する必要があります。

オーバーライド：

クラス BaseTraceWriter 内の doPrintln

getOutputStream()

戻り値：

TraceWriter に関連付けられた出力ストリーム。

宣言

実装インターフェイスの一覧

TraceWriter

メンバの概要

コンストラクタ

SyslogTraceWriter(int, String)

最大トレース レベル INFORMATIONAL の付けられたデフォルトの SyslogTraceWriter。

関連項目：

Trace

SyslogTraceWriter(int, String, int)

最大トレース レベルの指定された SyslogTraceWriter。

関連項目：

Trace

SyslogTraceWriter(int, String, int[])

トレース レベルの配列を指定できる SyslogTraceWriter。

関連項目：

Trace

メソッド

doClose()

ソケットをクローズします。

オーバーライド：

クラス BaseTraceWriter 内の doClose

doPrintln(String, int)

SyslogTraceWriter には、println() メソッドに対して、システムで規定されているメッセージ パケット末尾の行区切りの代わりに、「¥0」を使用する点で例外があります。メッセージの、「¥r」または「¥n」より後の部分は無視されます。

オーバーライド：

クラス BaseTraceWriter 内の doPrintln

main(String[])

public static void main ( java.lang.String[] args)

宣言

メンバの概要

メソッド

getModules()

このファクトリに登録されている TraceModules の列挙を返します。

registerModule(TraceModule)

TraceManager オブジェクトのインスタンスを返します。包含される TraceWriterManager には、デフォルトの TraceWriter がありません。

registerModule(TraceModule, String[], TraceWriterManager)

TraceManager オブジェクトのインスタンスを返します。Trace 出力は、指定された TraceWriterManager オブジェクトへリダイレクトされます。

registerModule(TraceModule, TraceWriterManager)

TraceManager オブジェクトのインスタンスを返します。Trace 出力は、指定された TraceWriterManager オブジェクトへリダイレクトされます。

宣言

すべての既知のサブインターフェイス

ConditionalTrace, UnconditionalTrace

メンバの概要

フィールド

ALERTS

アプリケーションはタスクの作業を継続できるが、すべての機能が動作可能なわけではない（リストの 1 つ以上のデバイスがアクセス不能であるが、他はアクセス可能）。
Syslog 重大度 = 1

ALERTS_TRACE_NAME

ALERTS トレース レベルの文字列記述子。

CRITICAL

重大な障害であり、アプリケーションはこの障害が原因で要求されたタスクを達成できない。たとえば、アプリケーションが、データベースを開いてデバイス リストを読むことができない。
Syslog 重大度 = 2

CRITICAL_TRACE_NAME

CRITICAL トレース レベルの文字列記述子。

DEBUGGING

エラーまたはプロセスの状態に関する詳細な情報で、DEBUG モードが有効になっているときだけに生成される。
Syslog 重大度 = 7

DEBUGGING_TRACE_NAME

DEBUGGING トレース レベルの文字列記述子。

EMERGENCIES

緊急状態であり、システムのシャットダウンが必要。
Syslog 重大度 = 0

EMERGENCIES_TRACE_NAME

EMERGENCIES トレース レベルの文字列記述子。

ERROR

何らかのエラーの状態が発生し、ユーザは、この障害の性質を理解する必要がある。
Syslog 重大度 = 3

ERROR_TRACE_NAME

ERROR トレース レベルの文字列記述子。

HIGHEST_LEVEL

最高位のトレース レベルであり、現在は、トレース レベル 7 の DEBUGGING。

INFORMATIONAL

エラー、警告、監査、またはデバッグに関係しない形式の情報。
Syslog 重大度 = 6

INFORMATIONAL_TRACE_NAME

INFORMATIONAL トレース レベルの文字列記述子。

LOWEST_LEVEL

最低位のトレース レベルであり、現在は、トレース レベル 0 の EMERGENCIES。

NOTIFICATION

NOTIFICATION は正常であるが、重大な状態を示す。
Syslog 重大度 = 5

NOTIFICATION_TRACE_NAME

NOTIFICATION トレース レベルの文字列記述子。

WARNING

なんらかの問題が存在するが、アプリケーションのタスクの実行が妨げられてはいないという警告。
Syslog 重大度 = 4

WARNING_TRACE_NAME

WARNING トレース レベルの文字列記述子。

メソッド

getName()

戻り値：

この Trace オブジェクトの名前を返します。

getSubFacility()

戻り値：

トレースの subFacility のタイプ。

getType()

戻り値：

Syslog に指定されているトレースのタイプ。DEBUGGING、INFORMATIONAL、WARNING など。

isEnabled()

この Trace オブジェクトの状態を返します。デフォルトでは、Trace オブジェクトは有効になっています。つまり、常に println() メソッドのトレースを実行します。このインターフェイスでは状態を変更できませんが、このオブジェクトに、状態を変更可能な追加のインターフェイスを実装することができます。

戻り値：

トレースが有効の場合に true、そうでない場合に false。

関連項目：

ConditionalTrace

println(Object)

Object.toString() メソッドによって返された文字列を出力し、システムでの定義に従って行を終了します。

パラメータ：

object ：出力されるオブジェクト。

println(String)

Trace.print() と同じフォーマットでメッセージを出力し、システムでの定義に従って行を終了します。

パラメータ：

message ：出力されるメッセージ。

println(String, Object)

Object.toString() メソッドによって返された文字列を出力し、システムでの定義に従って行を終了します。

パラメータ：

object ：出力されるオブジェクト。

mnemonic ：出力されるメッセージにマップされるニーモニック。

println(String, String)

Trace.print() と同じフォーマットでメッセージを出力し、システムでの定義に従って行を終了します。

パラメータ：

message ：出力されるメッセージ。

mnemonic ：出力されるメッセージにマップされるニーモニック。

setDefaultMnemonic(String)

このトレースに出力されるすべてのメッセージにデフォルトのニーモニックを設定します。

パラメータ：

mnemonic ：ニーモニック文字列。

宣言

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

Trace

メンバの概要

メソッド

disable()

このトレース条件を無効にします。

enable()

このトレース条件を有効にします。

宣言

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

Trace

メンバの概要

宣言

メンバの概要

メソッド

addSubFacilities(String[])

この TraceManager/Facility の sub-Facility のセットを設定します。

addSubFacility(String)

この TraceManager/Facility の単一の subFacility を追加します。

disableAll()

この TraceManager により管理されるすべての Trace オブジェクトのトレースを無効にします。

disableTimeStamp()

この TraceManager によって出力されるすべてのメッセージについて、タイムスタンプにプレフィクスを付けることを無効にします。

enableAll()

この TraceManager によって管理されるすべての Trace オブジェクトのトレースを有効にします。

enableTimeStamp()

この TraceManager によって出力されるすべてのメッセージについて、タイムスタンプにプレフィクスを付けることを有効にします。

getConditionalTrace(int)

この条件について、新規の ConditionalTrace オブジェクトを作成する、または既存の ConditionalTrace オブジェクトを取得します。

getConditionalTrace(String, int)

この条件および subFacility について、新規の ConditionalTrace オブジェクトを作成する、または既存の ConditionalTrace オブジェクトを取得します。

getName()

この TraceManager の Facility 名を返します。

getSubFacilities()

この TraceManager/Facility の subFacility 名を返します。

getTraces()

この TraceManager により管理される Trace オブジェクトの列挙を返します。

getTraceWriterManager()

この TraceManager により使用される TraceWriter を返します。

getUnconditionalTrace(int)

この条件について、新規の UnconditionalTrace オブジェクトを作成するか、または既存の UnconditionalTrace オブジェクトを取得します。

getUnconditionalTrace(String, int)

この条件および subFacility について、新規の UnconditionalTrace オブジェクトを作成するか、または既存の UnconditionalTrace オブジェクトを取得します。

removeTrace(Trace)

Trace オブジェクトを削除します（オブジェクトがある場合）。

setSubFacilities(String[])

推奨されません。

TraceManager.addSubFacilities メソッドに置き換えられました。

この TraceManager/Facility の sub-Facility のセットを設定します。

setSubFacility(String)

推奨されません。

TraceManager.addSubFacility メソッドに置き換えられました。

この TraceManager/Facility の単一の subFacility を追加します。

setTraceWriterManager(TraceWriterManager)

この TraceManager で使用する TraceWriter を設定します。

宣言

すべての既知のサブインターフェイス

com.cisco.jtapi.extensions.CiscoJtapiPeer

メンバの概要

メソッド

getTraceManager()

オブジェクトがトレースに使用している TraceManager を返します。

getTraceModuleName()

モジュール名を返します。

宣言

すべての既知のサブインターフェイス

TraceWriterManager

既知の実装クラスの一覧

BaseTraceWriter

メンバの概要

メソッド

close()

この TraceWriter によって関連付けられたすべてのリソースを解放します。

flush()

println メソッドを使用して、出力されたすべてのメッセージを強制出力します。

getDescription()

戻り値：

この TraceWriter の簡単な説明。

getEnabled()

println メソッドによって出力されるものがあるかどうかを返します。クローズされた TraceWriter のこのメソッドは、常に false を返します。

戻り値：

TraceWriter が有効の場合に true、そうでない場合に false。

getName()

戻り値：

この TraceWriter の名前を返します。

getTraceLevels()

戻り値：

この TraceWriter によりトレースされるトレース レベルの配列。

println(String, int)

指定された文字列とそれに続く改行を出力します。TraceWriter の具象クラスでは、重大度を使用して、特定のストリームからのメッセージをブロックします。各 TraceWriter は、自分が実行する必要のある最高位レベルのトレース レベルを認知しています。

パラメータ：

message ：出力されるメッセージ。

severity ：トレースの重大度。

関連項目：

Trace

setTraceLevels(int[])

この TraceWriter によりトレースされるトレース レベルを設定します。

パラメータ：

int[] ：レベル。

関連項目：

Trace

宣言

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

TraceWriter

メンバの概要

メソッド

addTraceWriter(TraceWriter)

別の TraceWriter を配列に追加します。

パラメータ：

TraceWriter ：リストに追加される TraceWriter。

getTraceWriters()

戻り値：

Manager の TraceWriter の配列。

removeTraceWriter(TraceWriter)

Manager の配列から TraceWriter を取り除きます。

setTraceWriters(TraceWriter[])

実装では、このメソッドを使用して、提供された TraceWriter をオーバーライドまたは拡張できます。

パラメータ：

set ：TraceWriter の配列を設定します。

宣言

public abstract class TraceImpl

extends java.lang.Object

implements Trace

実装インターフェイスの一覧

Trace

メソッド

println

public final void println (java.lang.String message)

次のインターフェイスからコピーされた記述：Trace

Trace.print() と同じフォーマットでメッセージを出力し、システムでの定義に従って行を終了します。

定義：

インターフェイス Trace の println

パラメータ ：

message：出力されるメッセージ。

println

public final void println(java.lang.String mnemonic,

java.lang.String message)

次のインターフェイスからコピーされた記述：Trace

Trace.print() と同じフォーマットでメッセージを出力し、システムでの定義に従って行を終了します。

定義 ：

インターフェイス Trace の println

パラメータ ：

mnemonic：出力されるメッセージにマップされるニーモニック。

message：出力されるメッセージ。

println

public final void println (java.lang.Object object)

次のインターフェイスからコピーされた記述：Trace

Object.toString() メソッドによって返された文字列を出力し、システムでの定義に従って行を終了します。

定義 ：

インターフェイス Trace の println

パラメータ ：

object：出力されるオブジェクト。

println

public final void println (java.lang.String mnemonic,

java.lang.Object object)

次のインターフェイスからコピーされた記述：Trace

Object.toString() メソッドによって返された文字列を出力し、システムでの定義に従って行を終了します。

定義 ：

インターフェイス Trace の println

パラメータ ：

mnemonic：出力されるメッセージにマップされるニーモニック。

object：出力されるオブジェクト。

getName

public final java.lang.String getName ()

次のインターフェイスからコピーされた記述：Trace

この Trace オブジェクトの名前を返します。

定義 ：

インターフェイス Trace の getName

戻り値 ：

この Trace オブジェクトの名前を返します。

setDefaultMnemonic

public final void setDefaultMnemonic (java.lang.String mnemonic)

次のインターフェイスからコピーされた記述：Trace

このトレースに出力されるすべてのメッセージにデフォルトのニーモニックを設定します。

定義 ：

インターフェイス Trace の setDefaultMnemonic

パラメータ ：

mnemonic：ニーモニック文字列。

getType

public int getType ()

次のインターフェイスからコピーされた記述：Trace

トレースのタイプを返します。

定義 ：

インターフェイス Trace の getType

戻り値 ：

Syslog に指定されているトレースの重大度。DEBUGGING、INFORMATIONAL、WARNING など。

getSubFacility

public java.lang.String getSubFacility ()

次のインターフェイスからコピーされた記述：Trace

トレースの subFacility を返します。

定義 ：

インターフェイス Trace の getSubFacility

戻り値 ：

トレースの subFacility のタイプ。

継承したメソッド

isEnabled()

宣言

public final class ConditionalTraceImpl

extends TraceImpl

implements ConditionalTrace

実装インターフェイスの一覧

ConditionalTrace、Trace

メソッド

enable

public void enable()

次のインターフェイスからコピーされた記述：ConditionalTrace

このトレース条件を有効にします。

定義：

インターフェイス ConditionalTrace の enable

disable

public void disable()

次のインターフェイスからコピーされた記述：ConditionalTrace

このトレース条件を無効にします。

定義：

インターフェイス ConditionalTrace の disable

isEnabled()

public boolean isEnabled()

次のインターフェイスからコピーされた記述：Trace

この Trace オブジェクトの状態を返します。デフォルトでは、Trace オブジェクトは有効になっています。つまり、常に println() メソッドのトレースを実行します。このインターフェイスでは状態を変更できませんが、このオブジェクトに、状態を変更可能な追加のインターフェイスを実装することができます。

定義：

インターフェイス Trace の isEnabled

戻り値：

トレースが有効の場合に true、そうでない場合に false。

関連項目：

ConditionalTrace

継承したメソッド

クラス java.lang.Object から継承したメソッドは、clone、equals、finalize、getClass、hashCode、notify、notifyAll、toString、wait、wait、wait です。

宣言

public final class UnconditionalTraceImpl

extends TraceImpl

implements UnconditionalTrace

実装インターフェイスの一覧

Trace、UnconditionalTrace

メソッド

isEnabled()

public boolean isEnabled()

次のインターフェイスからコピーされた記述：Trace

この Trace オブジェクトの状態を返します。デフォルトでは、Trace オブジェクトは有効になっています。つまり、常に println() メソッドのトレースを実行します。このインターフェイスでは状態を変更できませんが、このオブジェクトに、状態を変更可能な追加のインターフェイスを実装することができます。

定義：

インターフェイス Trace の isEnabled

戻り値：

トレースが有効の場合に true、そうでない場合に false。

関連項目：

ConditionalTrace

継承したメソッド

クラス java.lang.Object から継承したメソッドは、clone、equals、finalize、getClass、hashCode、notify、notifyAll、toString、wait、wait、wait です。

宣言

public class TraceManagerImpl extends java.lang.Object

java.lang.Object

|

+--com.cisco.services.tracing.TraceManagerImpl

実装インターフェイスの一覧

TraceManager

コンストラクタ

public TraceManagerImpl(java.lang.String moduleName, java.lang.String[] subFacilities, TraceWriterManager traceWriterManager)

public TraceManagerImpl(java.lang.String moduleName, TraceWriterManager traceWriterManager)

メソッド

getConditionalTrace

public ConditionalTrace getConditionalTrace(int severity)

次のインターフェイスからコピーされた記述 ：TraceManager

この条件について、新規の ConditionalTrace オブジェクトを作成する、または既存の ConditionalTrace オブジェクトを取得します。

定義：

インターフェイス TraceManager の getConditionalTrace

getConditionalTrace

public ConditionalTrace getConditionalTrace(java.lang.String subFacility, int severity)

次のインターフェイスからコピーされた記述 ：TraceManager

この条件および subFacility について、新規の ConditionalTrace オブジェクトを作成する、または既存の ConditionalTrace オブジェクトを取得します。

定義：

インターフェイス TraceManager の getConditionalTrace

getUnconditionalTrace

public UnconditionalTrace getUnconditionalTrace(int severity)

次のインターフェイスからコピーされた記述 ：TraceManager

この条件について、新規の UnconditionalTrace オブジェクトを作成するか、または既存の UnconditionalTrace オブジェクトを取得します。

定義：

インターフェイス TraceManager の getUnconditionalTrace

getUnconditionalTrace

public UnconditionalTrace getUnconditionalTrace(java.lang.String subFacility, int severity)

次のインターフェイスからコピーされた記述 ：TraceManager

この条件および subFacility について、新規の UnconditionalTrace オブジェクトを作成するか、または既存の UnconditionalTrace オブジェクトを取得します。

定義：

インターフェイス TraceManager の getUnconditionalTrace

getTraceWriterManager

public TraceWriterManager getTraceWriterManager()

次のインターフェイスからコピーされた記述 ：TraceManager

この TraceManager により使用される TraceWriter を返します。

定義：

インターフェイス TraceManager の getTraceWriterManager

setTraceWriterManager

public void setTraceWriterManager(TraceWriterManager out)

次のインターフェイスからコピーされた記述 ：TraceManager

この TraceManager で使用する TraceWriter を設定します。

定義：

インターフェイス TraceManager の setTraceWriterManager

removeTrace

public void removeTrace(Trace tc)

次のインターフェイスからコピーされた記述 ：TraceManager

Trace オブジェクトを削除します（オブジェクトがある場合）。

定義：

インターフェイス TraceManager の removeTrace

getTraces()

public java.util.Enumeration getTraces()

次のインターフェイスからコピーされた記述 ：TraceManager

この TraceManager により管理される Trace オブジェクトの列挙を返します。

定義：

インターフェイス TraceManager の getTraces

enableAll

public void enableAll()

次のインターフェイスからコピーされた記述 ：TraceManager

この TraceManager によって管理されるすべての Trace オブジェクトのトレースを有効にします。

定義：

インターフェイス TraceManager の enableAll

disableAll

public void disableAll()

次のインターフェイスからコピーされた記述 ：TraceManager

この TraceManager により管理されるすべての Trace オブジェクトのトレースを無効にします。

定義：

インターフェイス TraceManager の disableAll

getName

public java.lang.String getName()

次のインターフェイスからコピーされた記述 ：TraceManager

この TraceManager の Facility 名を返します。

定義：

インターフェイス TraceManager の getName

enableTimeStamp

public void enableTimeStamp()

次のインターフェイスからコピーされた記述 ：TraceManager

この TraceManager によって出力されるすべてのメッセージについて、タイムスタンプにプレフィクスを付けることを有効にします。

定義：

インターフェイス TraceManager の enableTimeStamp

disableTimeStamp

public void disableTimeStamp()

次のインターフェイスからコピーされた記述 ：TraceManager

この TraceManager によって出力されるすべてのメッセージについて、タイムスタンプにプレフィクスを付けることを無効にします。

定義：

インターフェイス TraceManager の disableTimeStamp

getSubFacilities

public java.lang.String[] getSubFacilities()

この TraceManager/Facility の subFacility 名を返します。

定義：

インターフェイス TraceManager の getSubFacilities

addSubFacilities

public void addSubFacilities(java.lang.String[] names)

この TraceManager/Facility の subFacility を追加します。

定義：

インターフェイス TraceManager の addSubFacilities

addSubFacility

public void addSubFacility(java.lang.String name)

この TraceManager/Facility の subFacility を追加します。

定義：

インターフェイス TraceManager の addSubFacility

非推奨のメソッド

getSubFacilities(java.lang.String[] names)

addSubFacilties(String[]) に置き換えられました。

setSubFacility(java.lang.String name)

addSubFacility(String) に置き換えられました。

継承したメソッド

クラス java.lang.Object から継承したメソッドは、clone、equals、finalize、getClass、hashCode、notify、notifyAll、toString、wait、wait、wait です。

宣言

public class TraceWriterManagerImpl extends java.lang.Object implements TraceWriterManager

java.lang.Object

com.cisco.services.tracing.implementation.TraceWriterManagerImpl

実装インターフェイスの一覧

TraceWriter、TraceWriterManager

コンストラクタ

TraceWriterManagerImpl

public TraceWriterManagerImpl()

長さゼロの TraceWriter 配列で TraceWriterManagerImpl を作成します。

メソッド

setTraceWriters

public void setTraceWriters(TraceWriter[] traceWriters)

既存の TraceWriter を新しいユーザが指定したセットで上書きします。

定義：

インターフェイス TraceWriterManager の setTraceWriters

パラメータ：

traceWriters：TraceWriter の配列です。

getTraceWriters()

public TraceWriter[] getTraceWriters()

現在使用されている TraceWriter の配列を返します。

定義：

インターフェイス TraceWriterManager の getTraceWriters

戻り値：

Manager の TraceWriter の配列。

addTraceWriter

public void addTraceWriter(TraceWriter tw)

この TraceWriter を TraceWriter の配列に追加します。

定義：

インターフェイス TraceWriterManager の addTraceWriter

パラメータ：

tw：リストに追加される TraceWriter です。

removeTraceWriter

public void removeTraceWriter(TraceWriter tw)

TraceWriter の配列から Tracewriter を削除します。

定義：

インターフェイス TraceWriterManager の removeTraceWriter

println

public void println(java.lang.String message, int severity)

すべてのトレースがこのメソッドを呼び出します。トレースによって、メッセージとともに重大度が指定されます。トレースが TraceWriter の重大度のしきい値以下になる場合があります。例： 重大度のしきい値が INFORMATIONAL (level = 6) DEBUG に設定されている場合、トレースは TraceWriter によって渡されません。重大度レベルは TraceWriter のコンストラクタで設定されます。

定義：

インターフェイス TraceWriter の println

パラメータ：

message：出力されるメッセージ。

severity：トレースの重大度。

関連項目：

Trace

フラッシュ

public void flush()

次のインターフェイスからコピーされた記述 ：TraceWriter

println メソッドを使用して、出力されたすべてのメッセージを強制出力します。

定義：

インターフェイス TraceWriter の flush

close()

public void close()

次のインターフェイスからコピーされた記述 ：TraceWriter

この TraceWriter によって関連付けられたすべてのリソースを解放します。

定義：

インターフェイス TraceWriter の close

getEnabled

public boolean getEnabled()

基になる TraceWriter のいずれかが有効になっている場合は true を返し、そうでない場合は false を返します。

定義：

インターフェイス TraceWriter の getEnabled

戻り値：

TraceWriter が有効の場合に true、そうでない場合に false。