Package com.authlete.common.dto
Enum ClientRegistrationResponse.Action
- java.lang.Object
-
- java.lang.Enum<ClientRegistrationResponse.Action>
-
- com.authlete.common.dto.ClientRegistrationResponse.Action
-
- All Implemented Interfaces:
Serializable
,Comparable<ClientRegistrationResponse.Action>
- Enclosing class:
- ClientRegistrationResponse
public static enum ClientRegistrationResponse.Action extends Enum<ClientRegistrationResponse.Action>
The next action that the implementation of client registration endpoint should take.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BAD_REQUEST
The request from the client was wrong.CREATED
The request was valid and a client application has been registered successfully.DELETED
The request was valid and a client application has been deleted successfully.INTERNAL_SERVER_ERROR
The request from the endpoint implementation was wrong or an error occurred in Authlete.OK
The request was valid and the client application has been returned.UNAUTHORIZED
The registration access token used by the client configuration request (RFC 7592) is invalid, or the client application which the token is tied to does not exist any longer or is invalid.UPDATED
The request was valid and a client application has been updated successfully.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ClientRegistrationResponse.Action
valueOf(String name)
Returns the enum constant of this type with the specified name.static ClientRegistrationResponse.Action[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INTERNAL_SERVER_ERROR
public static final ClientRegistrationResponse.Action INTERNAL_SERVER_ERROR
The request from the endpoint implementation was wrong or an error occurred in Authlete. The endpoint implementation should return"500 Internal Server Error"
to the client application.
-
BAD_REQUEST
public static final ClientRegistrationResponse.Action BAD_REQUEST
The request from the client was wrong. The endpoint implementation should return"400 Bad Request"
to the client application.
-
UNAUTHORIZED
public static final ClientRegistrationResponse.Action UNAUTHORIZED
The registration access token used by the client configuration request (RFC 7592) is invalid, or the client application which the token is tied to does not exist any longer or is invalid. The endpoint implementation should return"401 Unauthorized"
.This enum value did not exist in the initial implementation of this enum, meaning that implementations of client configuration endpoint were not able to conform to RFC 7592 strictly.
For backward compatibility (to avoid breaking running systems), Authlete's
/api/client/registration
API does not return thisUNAUTHORIZED
enum value if theunauthorizedOnClientConfigSupported
flag of theService
is not turned on. See the description ofService.setUnauthorizedOnClientConfigSupported(boolean)
for details.- Since:
- 3.4
-
CREATED
public static final ClientRegistrationResponse.Action CREATED
The request was valid and a client application has been registered successfully. The endpoint implementation should return"201 Created"
to the client application.
-
UPDATED
public static final ClientRegistrationResponse.Action UPDATED
The request was valid and a client application has been updated successfully. The endpoint implementation should return"200 OK"
to the client application.
-
DELETED
public static final ClientRegistrationResponse.Action DELETED
The request was valid and a client application has been deleted successfully. The endpoint implementation should return"204 No Content"
to the client application.
-
OK
public static final ClientRegistrationResponse.Action OK
The request was valid and the client application has been returned. The endpoint implementation should return"200 OK"
to the client application.
-
-
Method Detail
-
values
public static ClientRegistrationResponse.Action[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ClientRegistrationResponse.Action c : ClientRegistrationResponse.Action.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ClientRegistrationResponse.Action valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-