メソッドの概要

返却値の型 メソッド名
ResultObject addSafeUrl (String id, String url, Boolean isRegex)
セーフURLを追加します。
ResultObject countSafeUrls (String [urlLike])
セーフURLのレコード件数を取得します。
ResultObject deleteSafeUrl (String id)
指定したIDのセーフURLを削除します。
ResultObject fetchSafeUrls (Number start, Number length, String orderBy, String [urlLike])
セーフURLリストを取得します。
ResultObject getSafeUrl (String id)
指定したセーフURLを取得します。
ResultObject getSafeUrls ()
セーフURLリストを取得します。
ResultObject isSafe (String url, Array [safeUrls])
指定されたURLがセーフリストに存在するか確認します。 引数が null の場合 false を返却します。ベースURLで始まるURLは許可されます(trueが返却されます)。
ResultObject updateSafeUrl (String id, String url, Boolean isRegex)
指定したIDのセーフURLを更新します。

メソッドの詳細

ResultObject addSafeUrl (String id, String url, Boolean isRegex)
セーフURLを追加します。
パラメータ
id : String
セーフURLを一意に示すID
url : String
セーフURL
isRegex : Boolean
URLが正規表現か否か。false の場合のみに限り URL が非正規表現であることを示します。false 以外の場合には URL は正規表現として扱われます。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには追加されたレコードの件数が設定されます。
ResultObject countSafeUrls (String [urlLike])
セーフURLのレコード件数を取得します。
パラメータ
[urlLike] : String
セーフURLリスト取得時のURLのLIKEとして設定する検索条件。省略時にはURLによる絞り込みを行いません。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティにはセーフURLのレコード件数が設定されます。
ResultObject deleteSafeUrl (String id)
指定したIDのセーフURLを削除します。
パラメータ
id : String
セーフURLを一意に示すID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには削除されたレコードの件数が設定されます。
ResultObject fetchSafeUrls (Number start, Number length, String orderBy, String [urlLike])
セーフURLリストを取得します。
パラメータ
start : Number
取得するデータの開始レコード位置(1以上)
length : Number
取得するデータの最大レコード数(0以上、0の場合、start以降の全件)
orderBy : String
セーフURLリスト取得時の order by に渡すパラメータを設定します(例:"record_date ASC, id ASC")。SQLとしてそのまま利用されるため、SQLインジェクションに注意して利用してください。
[urlLike] : String
セーフURLリスト取得時のURLのLIKEとして設定する検索条件。省略時にはURLによる絞り込みを行いません。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティにはセーフURLの配列が設定されます。
データがない場合は空の配列が設定されます。
ResultObject getSafeUrl (String id)
指定したセーフURLを取得します。
パラメータ
id : String
セーフURLを一意に示すID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティにはセーフURLが設定されます。
データがない場合は null が設定されます。
ResultObject getSafeUrls ()
セーフURLリストを取得します。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティにはセーフURLの配列が設定されます。
データがない場合は空の配列が設定されます。
ResultObject isSafe (String url, Array [safeUrls])
指定されたURLがセーフリストに存在するか確認します。 引数が null の場合 false を返却します。ベースURLで始まるURLは許可されます(trueが返却されます)。
パラメータ
url : String
URL
[safeUrls] : Array
セーフURL の配列。省略された場合、本メソッド呼び出し時点で登録済みのセーフURLから判別を行います。指定された場合、渡された配列をセーフURLリストとしてURLの判別を行います。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには引数に指定した URL が安全かどうかが設定されます(true の場合安全)。
ResultObject updateSafeUrl (String id, String url, Boolean isRegex)
指定したIDのセーフURLを更新します。
パラメータ
id : String
更新対象のセーフURLを一意に示すID
url : String
セーフURL
isRegex : Boolean
URLが正規表現か否か。false の場合のみに限り URL が非正規表現であることを示します。false 以外の場合には URL は正規表現として扱われます。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには更新されたレコードの件数が設定されます。