Package net.shibboleth.oidc.saml.xmlobject

Interface OAuthRPExtensions

All Superinterfaces:

AttributeExtensibleXMLObject, ElementExtensibleXMLObject, SAMLObject, XMLObject

All Known Implementing Classes:

OAuthRPExtensionsImpl

public interface OAuthRPExtensions
extends SAMLObject, AttributeExtensibleXMLObject, ElementExtensibleXMLObject

SAML 2.0 Metadata extension OAuthRPExtensions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_TYPE_ATTRIB_NAME	Attribute local name.
static final String	BACK_CHANNEL_LOGOUT_SESSION_REQUIRED_ATTRIB_NAME	Attribute local name.
static final String	CLIENT_URI_ATTRIB_NAME	Attribute local name.
static final String	DEFAULT_MAX_AGE_ATTRIB_NAME	Attribute local name.
static final String	FRONT_CHANNEL_LOGOUT_SESSION_REQUIRED_ATTRIB_NAME	Attribute local name.
static final String	GRANT_TYPES_ATTRIB_NAME	Attribute local name.
static final String	ID_TOKEN_ENCRYPTED_RESPONSE_ALG_ATTRIB_NAME	Attribute local name.
static final String	ID_TOKEN_ENCRYPTED_RESPONSE_ENC_ATTRIB_NAME	Attribute local name.
static final String	ID_TOKEN_SIGNED_RESPONSE_ALG_ATTRIB_NAME	Attribute local name.
static final String	INITIATE_LOGIN_URI_ATTRIB_NAME	Attribute local name.
static final String	REQUEST_OBJECT_ENCRYPTION_ALG_ATTRIB_NAME	Attribute local name.
static final String	REQUEST_OBJECT_ENCRYPTION_ENC_ATTRIB_NAME	Attribute local name.
static final String	REQUEST_OBJECT_SIGNING_ALG_ATTRIB_NAME	Attribute local name.
static final String	REQUIRE_AUTH_TIME_ATTRIB_NAME	Attribute local name.
static final String	RESPONSE_TYPES_ATTRIB_NAME	Attribute local name.
static final String	SCOPES_ATTRIB_NAME	Attribute local name.
static final String	SECTOR_IDENTIFIER_URI_ATTRIB_NAME	Attribute local name.
static final String	SOFTWARE_ID_ATTRIB_NAME	Attribute local name.
static final String	SOFTWARE_VERSION_ATTRIB_NAME	Attribute local name.
static final String	TOKEN_ENDPOINT_AUTH_METHOD_ATTRIB_NAME	Attribute local name.
static final String	TOKEN_ENDPOINT_AUTH_SIGNING_ALG_ATTRIB_NAME	Attribute local name.
static final String	TYPE_LOCAL_NAME	Local name of the XSI type.
static final QName	TYPE_NAME	QName of the XSI type.
static final String	USERINFO_ENCRYPTED_RESPONSE_ALG_ATTRIB_NAME	Attribute local name.
static final String	USERINFO_ENCRYPTED_RESPONSE_ENC_ATTRIB_NAME	Attribute local name.
static final String	USERINFO_SIGNED_RESPONSE_ALG_ATTRIB_NAME	Attribute local name.

Method Summary

Modifier and Type	Method	Description
String	getApplicationType()	Get the application type.
String	getClientUri()	Get the client URI.
List<DefaultAcrValue>	getDefaultAcrValues()	Get the list of default ACR values.
int	getDefaultMaxAge()	Get the value for default max age.
String	getGrantTypes()	Get the whitespace-delimited list of grant types.
String	getIdTokenEncryptedResponseAlg()	Get the JWE alg algorithm for ID token encryption.
String	getIdTokenEncryptedResponseEnc()	Get the JWE enc algorithm for ID token encryption.
String	getIdTokenSignedResponseAlg()	Get the JWS alg algorithm for ID token signature.
String	getInitiateLoginUri()	Get the URI for initiating login.
List<PostLogoutRedirectUri>	getPostLogoutRedirectUris()	Get the list of post logout redirection URIs.
String	getRequestObjectEncryptionAlg()	Get the JWE alg algorithm for request object encryption.
String	getRequestObjectEncryptionEnc()	Get the JWE enc algorithm for request object encryption.
String	getRequestObjectSigningAlg()	Get the JWS alg algorithm for request object signature.
List<RequestUri>	getRequestUris()	Get the list of request URIs.
String	getResponseTypes()	Get the whitespace-delimited list of response types.
String	getScopes()	Get the whitespace-delimited list of scopes.
String	getSectorIdentifierUri()	Get the sector identifier URI.
String	getSoftwareId()	Get the software identifier.
String	getSoftwareVersion()	Get the software version.
String	getTokenEndpointAuthMethod()	Get the token endpoint authentication method.
String	getTokenEndpointAuthSigningAlg()	Get the JWS alg algorithm for token endpoint authentication signature.
String	getUserInfoEncryptedResponseAlg()	Get the JWE alg algorithm for UserInfo response encryption.
String	getUserInfoEncryptedResponseEnc()	Get the JWE enc algorithm for UserInfo response encryption.
String	getUserInfoSignedResponseAlg()	Get the JWS alg algorithm for UserInfo response signature.
boolean	isBackChannelLogoutSessionRequired()	Get the flag to require session id in back-channel logout request.
boolean	isFrontChannelLogoutSessionRequired()	Get the flag to require session id in front-channel logout request.
boolean	isRequireAuthTime()	Get the flag to require authentication time.
void	setApplicationType(String type)	Set the application type.
void	setBackChannelLogoutSessionRequired(boolean flag)	Set the flag to require session id in back-channel logout request.
void	setClientUri(String uri)	Set the client URI.
void	setDefaultMaxAge(int age)	Set the value for default max age.
void	setFrontChannelLogoutSessionRequired(boolean flag)	Set the flag to require session id in front-channel logout request.
void	setGrantTypes(String types)	Set the whitespace-delimited list of grant types.
void	setIdTokenEncryptedResponseAlg(String algorithm)	Set the JWE alg algorithm for ID token encryption.
void	setIdTokenEncryptedResponseEnc(String algorithm)	Set the JWE enc algorithm for ID token encryption.
void	setIdTokenSignedResponseAlg(String algorithm)	Set the JWS alg algorithm for ID token signature.
void	setInitiateLoginUri(String uri)	Set the URI for initiating login.
void	setRequestObjectEncryptionAlg(String algorithm)	Set the JWE alg algorithm for request object encryption.
void	setRequestObjectEncryptionEnc(String algorithm)	Set the JWE enc algorithm for request object encryption.
void	setRequestObjectSigningAlg(String algorithm)	Set the JWS alg algorithm for request object signature.
void	setRequireAuthTime(boolean flag)	Set the flag to require authentication time.
void	setResponseTypes(String types)	Set the whitespace-delimited list of response types.
void	setScopes(String scopes)	Set the whitespace-delimited list of scopes.
void	setSectorIdentifierUri(String uri)	Set the sector identifier URI.
void	setSoftwareId(String id)	Set the software identifier.
void	setSoftwareVersion(String version)	Set the software version.
void	setTokenEndpointAuthMethod(String method)	Set the token endpoint authentication method.
void	setTokenEndpointAuthSigningAlg(String algorithm)	Set the JWS alg algorithm for token endpoint authentication signature.
void	setUserInfoEncryptedResponseAlg(String algorithm)	Set the JWE alg algorithm for UserInfo response encryption.
void	setUserInfoEncryptedResponseEnc(String algorithm)	Set the JWE enc algorithm for UserInfo response encryption.
void	setUserInfoSignedResponseAlg(String algorithm)	Set the JWS alg algorithm for UserInfo response signature.

Methods inherited from interface org.opensaml.core.xml.AttributeExtensibleXMLObject

getUnknownAttributes

Methods inherited from interface org.opensaml.core.xml.ElementExtensibleXMLObject

getUnknownXMLObjects, getUnknownXMLObjects

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Details

TYPE_LOCAL_NAME

@Nonnull
@NotEmpty
static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

• Constant Field Values

TYPE_NAME

@Nonnull
static final QName TYPE_NAME

QName of the XSI type.

TOKEN_ENDPOINT_AUTH_METHOD_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String TOKEN_ENDPOINT_AUTH_METHOD_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

GRANT_TYPES_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String GRANT_TYPES_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

RESPONSE_TYPES_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String RESPONSE_TYPES_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

APPLICATION_TYPE_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String APPLICATION_TYPE_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

CLIENT_URI_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String CLIENT_URI_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

SCOPES_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String SCOPES_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

SOFTWARE_ID_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String SOFTWARE_ID_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

SOFTWARE_VERSION_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String SOFTWARE_VERSION_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

SECTOR_IDENTIFIER_URI_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String SECTOR_IDENTIFIER_URI_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

ID_TOKEN_SIGNED_RESPONSE_ALG_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String ID_TOKEN_SIGNED_RESPONSE_ALG_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

ID_TOKEN_ENCRYPTED_RESPONSE_ALG_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String ID_TOKEN_ENCRYPTED_RESPONSE_ALG_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

ID_TOKEN_ENCRYPTED_RESPONSE_ENC_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String ID_TOKEN_ENCRYPTED_RESPONSE_ENC_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

USERINFO_SIGNED_RESPONSE_ALG_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String USERINFO_SIGNED_RESPONSE_ALG_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

USERINFO_ENCRYPTED_RESPONSE_ALG_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String USERINFO_ENCRYPTED_RESPONSE_ALG_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

USERINFO_ENCRYPTED_RESPONSE_ENC_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String USERINFO_ENCRYPTED_RESPONSE_ENC_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

REQUEST_OBJECT_SIGNING_ALG_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String REQUEST_OBJECT_SIGNING_ALG_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

REQUEST_OBJECT_ENCRYPTION_ALG_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String REQUEST_OBJECT_ENCRYPTION_ALG_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

REQUEST_OBJECT_ENCRYPTION_ENC_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String REQUEST_OBJECT_ENCRYPTION_ENC_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

TOKEN_ENDPOINT_AUTH_SIGNING_ALG_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String TOKEN_ENDPOINT_AUTH_SIGNING_ALG_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

INITIATE_LOGIN_URI_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String INITIATE_LOGIN_URI_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

DEFAULT_MAX_AGE_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String DEFAULT_MAX_AGE_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

REQUIRE_AUTH_TIME_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String REQUIRE_AUTH_TIME_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

BACK_CHANNEL_LOGOUT_SESSION_REQUIRED_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String BACK_CHANNEL_LOGOUT_SESSION_REQUIRED_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

FRONT_CHANNEL_LOGOUT_SESSION_REQUIRED_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String FRONT_CHANNEL_LOGOUT_SESSION_REQUIRED_ATTRIB_NAME

Attribute local name.

See Also:

• Constant Field Values

Method Details

getTokenEndpointAuthMethod

@Nullable
String getTokenEndpointAuthMethod()

Get the token endpoint authentication method.

Returns:

token endpoint authentication method

setTokenEndpointAuthMethod

void setTokenEndpointAuthMethod(@Nullable
 String method)

Set the token endpoint authentication method.

Parameters:

method - The token endpoint authentication method.

getResponseTypes

@Nullable
String getResponseTypes()

Get the whitespace-delimited list of response types.

Returns:

list of response types

setResponseTypes

void setResponseTypes(@Nullable
 String types)

Set the whitespace-delimited list of response types.

Parameters:

types - response types

getGrantTypes

@Nullable
String getGrantTypes()

Get the whitespace-delimited list of grant types.

Returns:

list of grant types

setGrantTypes

void setGrantTypes(@Nullable
 String types)

Set the whitespace-delimited list of grant types.

Parameters:

types - grant types

getApplicationType

@Nullable
String getApplicationType()

Get the application type.

Returns:

The application type.

setApplicationType

void setApplicationType(@Nullable
 String type)

Set the application type.

Parameters:

type - The application type.

getClientUri

@Nullable
String getClientUri()

Get the client URI.

Returns:

The client URI

setClientUri

void setClientUri(@Nullable
 String uri)

Set the client URI.

Parameters:

uri - The client URI.

getScopes

@Nullable
String getScopes()

Get the whitespace-delimited list of scopes.

Returns:

list of scopes

setScopes

void setScopes(@Nullable
 String scopes)

Set the whitespace-delimited list of scopes.

Parameters:

scopes - the scopes

getSoftwareId

@Nullable
String getSoftwareId()

Get the software identifier.

Returns:

software identifier

setSoftwareId

void setSoftwareId(@Nullable
 String id)

Set the software identifier.

Parameters:

id - The software identifier.

getSoftwareVersion

@Nullable
String getSoftwareVersion()

Get the software version.

Returns:

The software version.

setSoftwareVersion

void setSoftwareVersion(@Nullable
 String version)

Set the software version.

Parameters:

version - The software version.

getSectorIdentifierUri

@Nullable
String getSectorIdentifierUri()

Get the sector identifier URI.

Returns:

he sector identifier URI.

setSectorIdentifierUri

void setSectorIdentifierUri(@Nullable
 String uri)

Set the sector identifier URI.

Parameters:

uri - The sector identifier URI.

getIdTokenSignedResponseAlg

@Nullable
String getIdTokenSignedResponseAlg()

Get the JWS alg algorithm for ID token signature.

Returns:

The JWS alg algorithm for ID token signature.

setIdTokenSignedResponseAlg

void setIdTokenSignedResponseAlg(@Nullable
 String algorithm)

Set the JWS alg algorithm for ID token signature.

Parameters:

algorithm - The JWS alg algorithm for ID token signature.

getIdTokenEncryptedResponseAlg

@Nullable
String getIdTokenEncryptedResponseAlg()

Get the JWE alg algorithm for ID token encryption.

Returns:

The JWE alg algorithm for ID token encryption.

setIdTokenEncryptedResponseAlg

void setIdTokenEncryptedResponseAlg(@Nullable
 String algorithm)

Set the JWE alg algorithm for ID token encryption.

Parameters:

algorithm - The JWE alg algorithm for ID token encryption.

getIdTokenEncryptedResponseEnc

@Nullable
String getIdTokenEncryptedResponseEnc()

Get the JWE enc algorithm for ID token encryption.

Returns:

The JWE enc algorithm for ID token encryption.

setIdTokenEncryptedResponseEnc

void setIdTokenEncryptedResponseEnc(@Nullable
 String algorithm)

Set the JWE enc algorithm for ID token encryption.

Parameters:

algorithm - The JWE enc algorithm for ID token encryption.

getUserInfoSignedResponseAlg

@Nullable
String getUserInfoSignedResponseAlg()

Get the JWS alg algorithm for UserInfo response signature.

Returns:

The JWS alg algorithm for UserInfo response signature.

setUserInfoSignedResponseAlg

void setUserInfoSignedResponseAlg(@Nullable
 String algorithm)

Set the JWS alg algorithm for UserInfo response signature.

Parameters:

algorithm - The JWS alg algorithm for UserInfo response signature.

getUserInfoEncryptedResponseAlg

@Nullable
String getUserInfoEncryptedResponseAlg()

Get the JWE alg algorithm for UserInfo response encryption.

Returns:

The JWE alg algorithm for UserInfo response encryption.

setUserInfoEncryptedResponseAlg

void setUserInfoEncryptedResponseAlg(@Nullable
 String algorithm)

Set the JWE alg algorithm for UserInfo response encryption.

Parameters:

algorithm - The JWE alg algorithm for UserInfo response encryption.

getUserInfoEncryptedResponseEnc

@Nullable
String getUserInfoEncryptedResponseEnc()

Get the JWE enc algorithm for UserInfo response encryption.

Returns:

The JWE enc algorithm for UserInfo response encryption.

setUserInfoEncryptedResponseEnc

void setUserInfoEncryptedResponseEnc(@Nullable
 String algorithm)

Set the JWE enc algorithm for UserInfo response encryption.

Parameters:

algorithm - The JWE enc algorithm for UserInfo response encryption.

getRequestObjectSigningAlg

@Nullable
String getRequestObjectSigningAlg()

Get the JWS alg algorithm for request object signature.

Returns:

The JWS alg algorithm for request object signature.

setRequestObjectSigningAlg

void setRequestObjectSigningAlg(@Nullable
 String algorithm)

Set the JWS alg algorithm for request object signature.

Parameters:

algorithm - The JWS alg algorithm for request object signature.

getRequestObjectEncryptionAlg

@Nullable
String getRequestObjectEncryptionAlg()

Get the JWE alg algorithm for request object encryption.

Returns:

The JWE alg algorithm for request object encryption.

setRequestObjectEncryptionAlg

void setRequestObjectEncryptionAlg(@Nullable
 String algorithm)

Set the JWE alg algorithm for request object encryption.

Parameters:

algorithm - The JWE alg algorithm for request object encryption.

getRequestObjectEncryptionEnc

@Nullable
String getRequestObjectEncryptionEnc()

Get the JWE enc algorithm for request object encryption.

Returns:

The JWE enc algorithm for request object encryption.

setRequestObjectEncryptionEnc

void setRequestObjectEncryptionEnc(@Nullable
 String algorithm)

Set the JWE enc algorithm for request object encryption.

Parameters:

algorithm - The JWE enc algorithm for request object encryption.

getTokenEndpointAuthSigningAlg

@Nullable
String getTokenEndpointAuthSigningAlg()

Get the JWS alg algorithm for token endpoint authentication signature.

Returns:

The JWS alg algorithm for token endpoint authentication signature.

setTokenEndpointAuthSigningAlg

void setTokenEndpointAuthSigningAlg(@Nullable
 String algorithm)

Set the JWS alg algorithm for token endpoint authentication signature.

Parameters:

algorithm - The JWS alg algorithm for token endpoint authentication signature.

getInitiateLoginUri

@Nullable
String getInitiateLoginUri()

Get the URI for initiating login.

Returns:

The URI for initiating login.

setInitiateLoginUri

void setInitiateLoginUri(@Nullable
 String uri)

Set the URI for initiating login.

Parameters:

uri - The URI for initiating login.

getDefaultMaxAge

int getDefaultMaxAge()

Get the value for default max age.

Returns:

The value for default max age.

setDefaultMaxAge

void setDefaultMaxAge(int age)

Set the value for default max age.

Parameters:

age - The value for default max age.

isRequireAuthTime

boolean isRequireAuthTime()

Get the flag to require authentication time.

Returns:

The flag to require authentication time.

setRequireAuthTime

void setRequireAuthTime(boolean flag)

Set the flag to require authentication time.

Parameters:

flag - The flag to require authentication time.

setBackChannelLogoutSessionRequired

void setBackChannelLogoutSessionRequired(boolean flag)

Set the flag to require session id in back-channel logout request.

Parameters:

flag - The flag to require session id in back-channel logout request.

Since:

2.2.0

isBackChannelLogoutSessionRequired

boolean isBackChannelLogoutSessionRequired()

Get the flag to require session id in back-channel logout request.

Returns:

The flag to require session id in back-channel logout request.

Since:

2.2.0

setFrontChannelLogoutSessionRequired

void setFrontChannelLogoutSessionRequired(boolean flag)

Set the flag to require session id in front-channel logout request.

Parameters:

flag - The flag to require session id in front-channel logout request.

Since:

2.2.0

isFrontChannelLogoutSessionRequired

boolean isFrontChannelLogoutSessionRequired()

Get the flag to require session id in front-channel logout request.

Returns:

The flag to require session id in front-channel logout request.

Since:

2.2.0

getDefaultAcrValues

@Nonnull
@Live
List<DefaultAcrValue> getDefaultAcrValues()

Get the list of default ACR values.

Returns:

The list of default ACR values.

getRequestUris

@Nonnull
@Live
List<RequestUri> getRequestUris()

Get the list of request URIs.

Returns:

The list of request URIs.

getPostLogoutRedirectUris

@Nonnull
@Live
List<PostLogoutRedirectUri> getPostLogoutRedirectUris()

Get the list of post logout redirection URIs.

Returns:

The list of post logout redirection URIs.