org.deviceconnect.android.profile.spec

クラス OpenAPIValidator

java.lang.Object

org.deviceconnect.android.profile.spec.OpenAPIValidator

public final class OpenAPIValidator
extends java.lang.Object

API 定義されたにリクエストが妥当なパラメータか確認するためのクラス.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static java.util.List<Parameter>	findParameters(Swagger swagger, android.content.Intent request) 仕様定義されているパラメータの仕様のリストを取得します.
static boolean	validate(Parameter parameter, java.lang.Object value) リクエストされたパラメータが妥当か確認します.
static boolean	validate(Swagger swagger, android.content.Intent request) リクエストを妥当性を確認します.

クラスから継承されたメソッド java.lang.Object

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

メソッドの詳細

validate

public static boolean validate(Swagger swagger,
                               android.content.Intent request)

リクエストを妥当性を確認します.

送られてきたリクエストのパラメータに仕様にないパラメータが存在した場合には特にチェックは行わずに妥当とします。

パラメータ:

swagger - 操作API

request - リクエスト

戻り値:

妥当なリクエストの場合はtrue、それ以外はfalse

findParameters

public static java.util.List<Parameter> findParameters(Swagger swagger,
                                                       android.content.Intent request)

仕様定義されているパラメータの仕様のリストを取得します.

Operation > Path > Root の順に parameters のリストに追加します。
同じ名前のパラメータが存在する場合はリストには追加しません。

パラメータ:

swagger - 仕様定義

request - リクエスト

戻り値:

パラメータの仕様リスト

validate

public static boolean validate(Parameter parameter,
                               java.lang.Object value)

リクエストされたパラメータが妥当か確認します.

パラメータ:

parameter - パラメータの仕様

value - リクエストされたパラメータの値

戻り値:

パラメータが妥当な場合はtrue、それ以外はfalse