2.3 AjsCdApiインターフェース
JP1/AJS3 - Managerを操作するためのAPIのインターフェースです。
-
クラス定義
public interface AjsCdApi
-
パッケージ名
jp.co.Hitachi.soft.jp1.ajs.cd.api
-
メソッド一覧
表2‒3 AjsCdApiインターフェースのメソッド一覧 メソッドの概要
public void
login(java.lang.String manager,
java.lang.String userName,
java.lang.String passwd) throws AjsCdException
指定されたJP1ユーザーとパスワードで指定されたログイン対象のJP1/AJS3 - Managerに接続し，JP1/Base認証サーバでログイン認証を行います。
public void
logout(java.lang.String manager) throws AjsCdException
ログインしているJP1/AJS3 - Managerからログアウトします。
public void
logoutAll() throws AjsCdException
ログインしているすべてのJP1/AJS3 - Managerからログアウトします。
public java.lang.String
registerImmediateExec(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
AjsCdStartCondition startCondition,
AjsCdMacroVariableList macro) throws AjsCdException
指定されたジョブネットを即時実行登録します。
public void
registerPlannedExec(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
PlannedTimePassedType passedDaemonStarts,
PlannedTimePassedType passedRegForExe,
AjsCdMacroVariableList macro) throws AjsCdException
指定されたジョブネットを計画実行登録します。
public void
registerFixedExec(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String fixedScheduleFrom,
java.lang.String fixedScheduleTo,
int futureGeneration,
PlannedTimePassedType passedDaemonStarts,
AjsCdMacroVariableList macro) throws AjsCdException
指定されたジョブネットを確定実行登録します。
public void
cancelRegistration(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName) throws AjsCdException
指定された実行登録中のジョブネットの登録を解除します。
public java.lang.String
addExecSchedule(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String startTime,
AjsCdMacroVariableList macro) throws AjsCdException
指定されたジョブネットに実行予定を追加します。（ルートジョブネットを指定する場合）
public void
addExecSchedule(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
java.lang.String startTime) throws AjsCdException
指定されたジョブネットに実行予定を追加します。（ネストジョブネットを指定する場合）
public void
changeStartTime(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
ChangeStartTimeType kindTime,
java.lang.String time,
ChangePushedAheadType pushedAhead,
ChangeLowerType changeLower) throws AjsCdException
指定された実行登録済みのジョブネットの実行開始予定日時を一時的に変更します。
public void
execImmediate(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
ChangePushedAheadType pushedAhead,
ChangeLowerType changeLower) throws AjsCdException
指定された実行登録済みのジョブネットの実行スケジュールを一時的に変更し，即時実行します。
public void
cancelExecSchedule(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID) throws AjsCdException
指定された実行登録済みのジョブネットの実行スケジュールを一時的に変更し，実行を中止します。
public void
restoreStartTime(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID) throws AjsCdException
指定されたジョブネットの実行開始予定日時の変更を解除します。
public void
changeHold(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
ChangeHoldAttr holdAttr) throws AjsCdException
指定されたジョブネットの保留属性を変更します。
public void
changeDelayMonitor(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
DelayMonitorType delayedStart,
java.lang.String delayedStartTime,
DelayMonitorType delayedEnd,
java.lang.String delayedEndTime,
java.lang.String monitoringJobnet
) throws AjsCdException
指定された登録済みのジョブネットの遅延監視の設定を一時的に変更できます。
public void
changeStatus(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
ChangeStatus newStatus,
int newReturnCode) throws AjsCdException
指定されたジョブの状態を変更できます。（終了コードを変更する場合）
public void
changeStatus(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
ChangeStatus newStatus) throws AjsCdException
指定されたジョブの状態を変更できます。（終了コードを変更しない場合）
public void
interrupt(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID) throws AjsCdException
指定された実行中のジョブネットを中断できます。
public void
kill(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID) throws AjsCdException
指定された実行中のジョブおよびジョブネットを強制終了できます。
public void
rerun(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
RootRerunType rerunMethod,
EnumSet<RerunOption> rerunOptions
) throws AjsCdException
実行が終了したジョブネットやジョブの実行結果を指定して，再実行できます。（ルートジョブネットの場合）
public void
rerun(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
RerunType rerunMethod,
EnumSet<RerunOption> rerunOptions
) throws AjsCdException
実行が終了したジョブネットやジョブの実行結果を指定して，再実行できます。（ネストジョブネットの場合）
public AjsCdSearchResult
searchUnit(java.lang.String manager,
java.lang.String serviceName,
AjsCdSearchCondition searchCondition
) throws AjsCdException
ユニットの一覧を取得します。（要求IDを設定しない場合）
public AjsCdSearchResult
searchUnit(java.lang.String manager,
java.lang.String serviceName,
java.lang.String id,
AjsCdSearchCondition searchCondition
) throws AjsCdException
ユニットの一覧を取得します。（要求IDを設定する場合）
public boolean
cancelSearch(java.lang.String manager,
java.lang.String serviceName) throws AjsCdException
実行中のsearchUnitメソッドでのユニット一覧取得を中止します。（要求IDを設定しないキャンセルの場合）
public boolean
cancelSearch(java.lang.String manager,
java.lang.String serviceName,
java.lang.String id) throws AjsCdException
実行中のsearchUnitメソッドでのユニット一覧取得を中止します。（要求IDを設定するキャンセルの場合）
public AjsCdUnitStatus
getUnitStatus(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID) throws AjsCdException
ユニットの実行状態および実行結果の詳細情報を取得します。
public java.lang.String
getExecResultDetails(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID) throws AjsCdException
実行が終了したジョブの実行結果詳細を取得します。
public java.util.List<AjsCdMacroVariable>
getInheritResult(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID) throws AjsCdException
指定されたジョブネットの実行登録時に指定したマクロ変数名と引き継ぎ情報，またはジョブ実行時に引き継いだマクロ変数名と引き継ぎ結果情報を取得します。
public AjsCdGetCurrentStatusesUnderJobGroupResult
getCurrentStatusesUnderJobGroup(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
AjsCdGetCurrentStatusesUnderJobGroupOption option
) throws AjsCdException
ジョブグループ直下のユニットのユニット定義情報，最新状態情報，および最新結果情報を取得します。
public AjsCdGetDefinitionsUnderJobnetResult
getDefinitionsUnderJobnet(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
java.lang.String releaseID
) throws AjsCdException
ジョブネット直下のユニット状態情報を取得します。
public AjsCdGetStatusesUnderJobnetResult
getStatusesUnderJobnet(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
AjsCdGetStatusesUnderJobnetOption option
) throws AjsCdException
ジョブネット直下のユニット状態情報を取得します。
public AjsCdGetRelationsUnderJobnetResult
getRelationsUnderJobnet(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String execID,
java.lang.String releaseID
) throws AjsCdException
ジョブネット直下の関連線情報を取得します。
public AjsCdGetScheduleResult
getSchedule(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
long begin,
long end,
DateType dateType,
java.lang.String releaseID,
AjsCdGetScheduleOption option
) throws AjsCdException
ジョブネットの予実績情報を取得します。（要求IDを設定しない場合）
public AjsCdGetScheduleResult
getSchedule(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
long begin,
long end,
DateType dateType,
java.lang.String releaseID,
java.lang.String id,
AjsCdGetScheduleOption option
) throws AjsCdException
ジョブネットの予実績情報を取得します。（要求IDを設定する場合）
public boolean
cancelGetSchedule(java.lang.String manager,
java.lang.String serviceName
) throws AjsCdException
実行中のgetScheduleメソッドでの予実績情報取得を中止します。（要求IDを設定しないキャンセルの場合）
public boolean
cancelGetSchedule(java.lang.String manager,
java.lang.String serviceName,
java.lang.String id
) throws AjsCdException
実行中のgetScheduleメソッドでの予実績情報取得を中止します。（要求IDを設定するキャンセル場合）
public AjsCdCalendar
getCalendar(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
java.lang.String month
) throws AjsCdException
カレンダー情報を取得します。（年月を指定して情報を取得する場合）
public AjsCdCalendar
getCalendar(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName
java.lang.String begin,
java.lang.String end) throws AjsCdException
カレンダー情報を取得します。（期間を指定して情報を取得する場合）
public AjsCdTotalSummary
getJobnetSummary(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName,
long begin,
long end,
AjsCdGetSummaryOption option
) throws AjsCdException
サマリー情報を取得します。
public java.util.List<AjsCdJobnetReleaseInfo>
getJobnetReleaseInfo(java.lang.String manager,
java.lang.String serviceName,
java.lang.String unitName
) throws AjsCdException
ルートジョブネットに設定されているリリース情報を取得します。
public java.util.List<AjsCdSchServiceDef>
enumSchService(java.lang.String manager
) throws AjsCdException
スケジューラーサービスの一覧を取得します。
public AjsCdSchServiceInfo
getSchServiceInfo(java.lang.String manager,
java.lang.String serviceName) throws AjsCdException
スケジューラーサービスの情報（文字コード，DB種別などに指定できる文字数の変更設定）を取得します。
public AjsCdAJSManager
getAJSManagerInfo(java.lang.String manager,
) throws AjsCdException
JP1/AJS3 - Managerの情報（バージョン，OS情報，データベース構成）を取得します。
public java.lang.String
getCharCode(java.lang.String manager,
java.lang.String serviceName) throws AjsCdException
APIがJP1/AJS3 - Managerの文字列をUnicodeに変換するために使用するJP1/AJS3 - Managerのスケジューラーサービスの文字コードを取得します。
public void
setCharCode(java.lang.String manager,
java.lang.String serviceName,
java.lang.String charCode) throws AjsCdException
APIがJP1/AJS3 - Managerの文字列をUnicodeに変換するために使用するJP1/AJS3 - Managerのスケジューラーサービスの文字コードを設定します。
- 〈この節の構成〉
-