com.nimbusds.openid.connect.provider.spi

Interface InitContext

All Known Implementing Classes:

ServletInitContext

public interface InitContext

Context for the initialisation of SPI implementations.

Features:

• Provides a method to retrieve a configuration or another file from the web application.
• Provides methods to obtain the OpenID Provider issuer identifier and token endpoint URI, which may be used to set the accepted audience values for SAML 2.0 or JWT bearer grant handlers.
• Provides a service context for accessing selected Connect2id server components that may be required in order to process claims or grant handler requests.

Method Summary

Modifier and Type	Method and Description
org.infinispan.manager.EmbeddedCacheManager	getInfinispanCacheManager() Returns the Infinispan cache manager.
com.nimbusds.oauth2.sdk.id.Issuer	getOPIssuer() Returns the OpenID Provider (OP) issuer identifier.
InputStream	getResourceAsStream(String path) Returns the resource located at the named path as an input stream.
ServiceContext	getServiceContext() Returns a service context for accessing selected Connect2id server components that may be required in order to process claims or grant handler requests.
javax.servlet.ServletContext	getServletContext() Returns the servlet context.
URI	getTokenEndpointURI() Returns the token endpoint of the OpenID Provider (OP) / Authorisation Server (AS).

Method Detail

getServletContext

javax.servlet.ServletContext getServletContext()

Returns the servlet context.

Returns:

The servlet context.

getResourceAsStream

InputStream getResourceAsStream(String path)

Returns the resource located at the named path as an input stream. Has the same behaviour as ServletContext.getResourceAsStream(java.lang.String).

Parameters:

path - The path to the resource, must be begin with a '/' and is interpreted as relative to the web application root. Must not be null.

Returns:

The resource as an input stream, or null if no resource exists at the specified path.

getInfinispanCacheManager

org.infinispan.manager.EmbeddedCacheManager getInfinispanCacheManager()

Returns the Infinispan cache manager.

Returns:

The Infinispan cache manager.

getOPIssuer

com.nimbusds.oauth2.sdk.id.Issuer getOPIssuer()

Returns the OpenID Provider (OP) issuer identifier. May be used to set the accepted audience values for SAML 2.0 or JWT bearer grant handlers.

Returns:

The OpenID Provider (OP) issuer identifier.

getTokenEndpointURI

URI getTokenEndpointURI()

Returns the token endpoint of the OpenID Provider (OP) / Authorisation Server (AS). May be used to set the accepted audience values for SAML 2.0 or JWT bearer grant handlers.

Returns:

The token endpoint URI.

getServiceContext

ServiceContext getServiceContext()

Returns a service context for accessing selected Connect2id server components that may be required in order to process claims or grant handler requests. The service context is only available during SPI request processing. Attempting to use it during SPI ininitialisation will produce an IllegalStateException.

Returns:

The service context.