列挙 org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode 詳解

org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode 連携図

公開メンバ関数
Response	getResponse ()

公開変数類
	SUCCESS
	NO_NUMBER
	NUMBER_ALREADY_ENROLLED
	UNDELIVERED
	DELIVERY_FAILED
	APP_SETUP_ERROR
	SMS_SERVICE_ERROR

非公開メンバ関数
String	getEntity ()

詳解

All status codes are returned in a 200 (OK) HTTP response, except for the following:

• NO_NUMBER: 400 (BAD REQUEST)
• APP_SETUP_ERROR, SMS_SERVICE_ERROR, and WS_SERVICE_ERROR: 500 (INTERNAL SERVER ERROR)

著者

jgomer

関数詳解

getEntity()

String org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.getEntity ( )

inlineprivate

                               {
        return Utils.jsonFromObject(Collections.singletonMap("code", toString()));
    }

getResponse()

Response org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.getResponse ( )

inline

                                  {

        Response.Status httpStatus;
        switch (this) {
            case NO_NUMBER:
                httpStatus = BAD_REQUEST;
                break;
            case APP_SETUP_ERROR:
            case SMS_SERVICE_ERROR:
            case WS_SERVICE_ERROR:
                httpStatus = INTERNAL_SERVER_ERROR;
                break;
            default:
                httpStatus = OK;
        }
        return Response.status(httpStatus).entity(getEntity()).build();

    }

メンバ詳解

APP_SETUP_ERROR

org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.APP_SETUP_ERROR

The message was not delivered due to a misconfiguration in the connection with the underlying Twilio service

DELIVERY_FAILED

org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.DELIVERY_FAILED

The underlying Twilio API call returned a status of "failed". See Twilio status values.

NO_NUMBER

org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.NO_NUMBER

The API call received no phone number to send the message to

NUMBER_ALREADY_ENROLLED

org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.NUMBER_ALREADY_ENROLLED

The phone number supplied is already enrolled and should not receive a SMS

SMS_SERVICE_ERROR

org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.SMS_SERVICE_ERROR

The underlying Twilio API call threw an exception. This may happen in a variety of situations, for instance, providing a non-valid phone number (e.g 555-1234-AB)

SUCCESS

org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.SUCCESS

The underlying Twilio API call returned a status other than UNDELIVERED or DELIVERY_FAILED. See Twilio status values.

Recall that a success status does not guarantee the recipient actually receiving a message.

UNDELIVERED

org.gluu.credmanager.plugins.authnmethod.rs.status.sms.SendCode.UNDELIVERED

The underlying Twilio API call returned a status of "undelivered". See Twilio status values.

---

次のファイルからこの列挙についての詳解を抽出しました:

• D:/AppData/OpenId/gluu/src/cred-manager/app/src/main/java/org/gluu/credmanager/plugins/authnmethod/rs/status/sms/SendCode.java