Package com.authlete.jaxrs

Class IntrospectionRequestHandler.Params

java.lang.Object

com.authlete.jaxrs.IntrospectionRequestHandler.Params

All Implemented Interfaces:

Serializable

Enclosing class:

IntrospectionRequestHandler

public static class IntrospectionRequestHandler.Params
extends Object
implements Serializable

Parameters passed to the IntrospectionRequestHandler.handle(Params) method.

Since:

2.63

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Params()

Method Summary

Modifier and Type	Method	Description
String	getHttpAcceptHeader()	Get the value of the HTTP Accept header in the introspection request.
com.authlete.common.types.JWEAlg	getIntrospectionEncryptionAlg()	Get the JWE alg algorithm for encrypting the introspection response.
com.authlete.common.types.JWEEnc	getIntrospectionEncryptionEnc()	Get the JWE enc algorithm for encrypting the introspection response.
com.authlete.common.types.JWSAlg	getIntrospectionSignAlg()	Get the JWS alg algorithm for signing the introspection response.
javax.ws.rs.core.MultivaluedMap<String,String>	getParameters()	Get the request parameters of the introspection request.
String	getPublicKeyForEncryption()	Get the public key for encrypting the introspection response with an asymmetric algorithm.
URI	getRsUri()	Get the URI of the resource server making the introspection request.
String	getSharedKeyForEncryption()	Get the shared key for encrypting the introspection response with a symmetric algorithm.
String	getSharedKeyForSign()	Get the shared key for signing the introspection response with a symmetric algorithm.
boolean	isWithHiddenProperties()	Get the flag which indicates whether to include hidden properties associated with the token in the output.
IntrospectionRequestHandler.Params	setHttpAcceptHeader(String header)	Set the value of the HTTP Accept header in the introspection request.
IntrospectionRequestHandler.Params	setIntrospectionEncryptionAlg(com.authlete.common.types.JWEAlg alg)	Set the JWE alg algorithm for encrypting the introspection response.
IntrospectionRequestHandler.Params	setIntrospectionEncryptionEnc(com.authlete.common.types.JWEEnc enc)	Set the JWE enc algorithm for encrypting the introspection response.
IntrospectionRequestHandler.Params	setIntrospectionSignAlg(com.authlete.common.types.JWSAlg alg)	Set the JWS alg algorithm for signing the introspection response.
IntrospectionRequestHandler.Params	setParameters(javax.ws.rs.core.MultivaluedMap<String,String> parameters)	Set the request parameters of the introspection request.
IntrospectionRequestHandler.Params	setPublicKeyForEncryption(String key)	Set the public key for encrypting the introspection response with an asymmetric algorithm.
IntrospectionRequestHandler.Params	setRsUri(URI uri)	Set the URI of the resource server making the introspection request.
IntrospectionRequestHandler.Params	setSharedKeyForEncryption(String key)	Set the shared key for encrypting the introspection response with a symmetric algorithm.
IntrospectionRequestHandler.Params	setSharedKeyForSign(String key)	Set the shared key for signing the introspection response with a symmetric algorithm.
IntrospectionRequestHandler.Params	setWithHiddenProperties(boolean with)	Set the flag which indicates whether to include hidden properties associated with the token in the output.

Methods inherited from class java.lang.Object

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

Constructor Detail

Params

public Params()

Method Detail

getParameters

public javax.ws.rs.core.MultivaluedMap<String,String> getParameters()

Get the request parameters of the introspection request.

Returns:

The request parameters of the introspection request.

setParameters

public IntrospectionRequestHandler.Params setParameters(javax.ws.rs.core.MultivaluedMap<String,String> parameters)

Set the request parameters of the introspection request.

Parameters:

parameters - The request parameters of the introspection request.

Returns:

this object.

isWithHiddenProperties

public boolean isWithHiddenProperties()

Get the flag which indicates whether to include hidden properties associated with the token in the output.

Returns:

true if hidden properties are included in the output.

setWithHiddenProperties

public IntrospectionRequestHandler.Params setWithHiddenProperties(boolean with)

Set the flag which indicates whether to include hidden properties associated with the token in the output.

Parameters:

with - true if hidden properties are included in the output.

Returns:

this object.

getRsUri

public URI getRsUri()

Get the URI of the resource server making the introspection request.

Returns:

The URI of the resource server making the introspection request.

setRsUri

public IntrospectionRequestHandler.Params setRsUri(URI uri)

Set the URI of the resource server making the introspection request.

Parameters:

rsUri - The URI of the resource server making the introspection request.

Returns:

this object.

getHttpAcceptHeader

public String getHttpAcceptHeader()

Get the value of the HTTP Accept header in the introspection request.

Returns:

The value of the HTTP Accept header in the introspection request.

setHttpAcceptHeader

public IntrospectionRequestHandler.Params setHttpAcceptHeader(String header)

Set the value of the HTTP Accept header in the introspection request.

Parameters:

header - The value of the HTTP Accept header in the introspection request.

Returns:

this object.

getIntrospectionSignAlg

public com.authlete.common.types.JWSAlg getIntrospectionSignAlg()

Get the JWS alg algorithm for signing the introspection response. This property corresponds to introspection_signed_response_alg defined in " 6. Client Metadata" of " JWT Response for OAuth Token Introspection".

Returns:

The JWS alg algorithm for signing the introspection response.

See Also:

JWT Response for OAuth Token Introspection

setIntrospectionSignAlg

public IntrospectionRequestHandler.Params setIntrospectionSignAlg(com.authlete.common.types.JWSAlg alg)

Set the JWS alg algorithm for signing the introspection response. This property corresponds to introspection_signed_response_alg defined in " 6. Client Metadata" of " JWT Response for OAuth Token Introspection".

Parameters:

alg - The JWS alg algorithm for signing the introspection response.

Returns:

this object.

See Also:

JWT Response for OAuth Token Introspection

getIntrospectionEncryptionAlg

public com.authlete.common.types.JWEAlg getIntrospectionEncryptionAlg()

Get the JWE alg algorithm for encrypting the introspection response. This property corresponds to introspection_encrypted_response_alg defined in " 6. Client Metadata" of " JWT Response for OAuth Token Introspection".

Returns:

The JWE alg algorithm for encrypting the introspection response.

See Also:

JWT Response for OAuth Token Introspection

setIntrospectionEncryptionAlg

public IntrospectionRequestHandler.Params setIntrospectionEncryptionAlg(com.authlete.common.types.JWEAlg alg)

Set the JWE alg algorithm for encrypting the introspection response. This property corresponds to introspection_encrypted_response_alg defined in " 6. Client Metadata" of " JWT Response for OAuth Token Introspection".

Parameters:

alg - The JWE alg algorithm for encrypting the introspection response.

Returns:

this object.

See Also:

JWT Response for OAuth Token Introspection

getIntrospectionEncryptionEnc

public com.authlete.common.types.JWEEnc getIntrospectionEncryptionEnc()

Get the JWE enc algorithm for encrypting the introspection response. This property corresponds to introspection_encrypted_response_enc defined in " 6. Client Metadata" of " JWT Response for OAuth Token Introspection".

Returns:

The JWE enc algorithm for encrypting the introspection response.

See Also:

JWT Response for OAuth Token Introspection

setIntrospectionEncryptionEnc

public IntrospectionRequestHandler.Params setIntrospectionEncryptionEnc(com.authlete.common.types.JWEEnc enc)

Set the JWE enc algorithm for encrypting the introspection response. This property corresponds to introspection_encrypted_response_enc defined in " 6. Client Metadata" of " JWT Response for OAuth Token Introspection".

Parameters:

enc - The JWE enc algorithm for encrypting the introspection response.

Returns:

this object.

See Also:

JWT Response for OAuth Token Introspection

getSharedKeyForSign

public String getSharedKeyForSign()

Get the shared key for signing the introspection response with a symmetric algorithm.

Returns:

The shared key for signing the introspection response with a symmetric algorithm.

See Also:

JWT Response for OAuth Token Introspection

setSharedKeyForSign

public IntrospectionRequestHandler.Params setSharedKeyForSign(String key)

Set the shared key for signing the introspection response with a symmetric algorithm.

Parameters:

key - The shared key for signing the introspection response with a symmetric algorithm.

Returns:

this object.

See Also:

JWT Response for OAuth Token Introspection

getSharedKeyForEncryption

public String getSharedKeyForEncryption()

Get the shared key for encrypting the introspection response with a symmetric algorithm.

Returns:

The shared key for encrypting the introspection response with a symmetric algorithm.

See Also:

JWT Response for OAuth Token Introspection

setSharedKeyForEncryption

public IntrospectionRequestHandler.Params setSharedKeyForEncryption(String key)

Set the shared key for encrypting the introspection response with a symmetric algorithm.

Parameters:

key - The shared key for encrypting the introspection response with a symmetric algorithm.

Returns:

this object.

See Also:

JWT Response for OAuth Token Introspection

getPublicKeyForEncryption

public String getPublicKeyForEncryption()

Get the public key for encrypting the introspection response with an asymmetric algorithm.

Returns:

The public key for encrypting the introspection response with an asymmetric algorithm.

See Also:

JWT Response for OAuth Token Introspection

setPublicKeyForEncryption

public IntrospectionRequestHandler.Params setPublicKeyForEncryption(String key)

Set the public key for encrypting the introspection response with an asymmetric algorithm.

Parameters:

key - The public key for encrypting the introspection response with an asymmetric algorithm.

Returns:

this object.

See Also:

JWT Response for OAuth Token Introspection