|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.nimbusds.oauth2.sdk.auth.ClientAuthentication com.nimbusds.oauth2.sdk.auth.ClientSecretPost
@Immutable public final class ClientSecretPost
Client secret post authentication at the Token endpoint. Implements
ClientAuthenticationMethod.CLIENT_SECRET_POST
. This class is
immutable.
Related specifications:
Constructor Summary | |
---|---|
ClientSecretPost(ClientID clientID,
Secret secret)
Creates a new client secret post authentication. |
Method Summary | |
---|---|
void |
applyTo(HTTPRequest httpRequest)
Applies the authentication to the specified HTTP request by setting its Authorization header and/or POST entity-body parameters (according to the implemented client authentication method). |
ClientID |
getClientID()
Gets the client identifier. |
Secret |
getClientSecret()
Gets the client secret. |
static ClientSecretPost |
parse(HTTPRequest httpRequest)
Parses a client secret post authentication from the specified HTTP POST request. |
static ClientSecretPost |
parse(Map<String,String> params)
Parses a client secret post authentication from the specified parameters map. |
static ClientSecretPost |
parse(String paramsString)
Parses a client secret post authentication from the specified application/x-www-form-urlencoded encoded parameters string. |
Map<String,String> |
toParameters()
Returns the parameter representation of this client secret post authentication. |
Methods inherited from class com.nimbusds.oauth2.sdk.auth.ClientAuthentication |
---|
getMethod |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ClientSecretPost(ClientID clientID, Secret secret)
clientID
- The client identifier. Must not be null
.secret
- The client secret. Must not be null
.Method Detail |
---|
public ClientID getClientID()
public Secret getClientSecret()
public Map<String,String> toParameters()
application/x-www-form-urlencoded
encoded.
Parameters map:
"client_id" -> [client-identifier] "client_secret" -> [client-secret]
public void applyTo(HTTPRequest httpRequest) throws SerializeException
ClientAuthentication
applyTo
in class ClientAuthentication
httpRequest
- The HTTP request. Must not be null
.
SerializeException
- If the client authentication parameters
couldn't be applied to the HTTP request.public static ClientSecretPost parse(Map<String,String> params) throws ParseException
application/x-www-form-urlencoded
encoded.
params
- The parameters map to parse. The client secret post
parameters must be keyed under "client_id" and
"client_secret". The map must not be null
.
ParseException
- If the parameters map couldn't be parsed to a
client secret post authentication.public static ClientSecretPost parse(String paramsString) throws ParseException
application/x-www-form-urlencoded
encoded parameters string.
paramsString
- The parameters string to parse. The client secret
post parameters must be keyed under "client_id"
and "client_secret". The string must not be
null
.
ParseException
- If the parameters string couldn't be parsed to
a client secret post authentication.public static ClientSecretPost parse(HTTPRequest httpRequest) throws ParseException
httpRequest
- The HTTP POST request to parse. Must not be
null
and must contain a valid
application/x-www-form-urlencoded
encoded
parameters string in the entity body. The client
secret post parameters must be keyed under
"client_id" and "client_secret".
ParseException
- If the HTTP request header couldn't be parsed
to a valid client secret post authentication.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |