com.nimbusds.openid.connect.provider.spi

Interface InitContext

All Known Implementing Classes:

ServletInitContext

public interface InitContext

Context for the initialisation of SPI implementations.

Provides:

• Access to the web application context.
• A method to retrieve a configuration or another file in the web application package.
• Access to the Infinispan cache manager.

Method Summary

Modifier and Type	Method and Description
org.infinispan.manager.EmbeddedCacheManager	getInfinispanCacheManager() Returns the Infinispan cache manager.
com.nimbusds.oauth2.sdk.id.Issuer	getIssuer() Deprecated.
com.nimbusds.oauth2.sdk.id.Issuer	getOPIssuer() Deprecated.
InputStream	getResourceAsStream(String path) Returns the resource located at the named path as an input stream.
ServiceContext	getServiceContext() Deprecated.
javax.servlet.ServletContext	getServletContext() Returns the servlet context.
URI	getTokenEndpointURI() Deprecated.

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.

getIssuer

@Deprecated
com.nimbusds.oauth2.sdk.id.Issuer getIssuer()

Deprecated.

Returns the OpenID Provider / Authorisation Server issuer URL. May be used to set the accepted audience values for SAML 2.0 or JWT bearer grant handlers.

Use InvocationContext.getIssuer() instead.

Returns:

The OpenID Provider / Authorisation Server issuer, null if not available (for a multi-tenant Connect2id server).

getOPIssuer

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

Deprecated.

Returns the OpenID Provider / Authorisation Server issuer URL. May be used to set the accepted audience values for SAML 2.0 or JWT bearer grant handlers.

Use InvocationContext.getIssuer() instead.

Returns:

The OpenID Provider / Authorisation Server issuer, null if not available (for a multi-tenant Connect2id server).

getTokenEndpointURI

@Deprecated
URI getTokenEndpointURI()

Deprecated.

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

Returns:

The token endpoint URI, null if not available (for a multi-tenant Connect2id server).

getServiceContext

@Deprecated
ServiceContext getServiceContext()

Deprecated.

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.

Use InvocationContext instead.

Returns:

The service context.