Package com.spotfire.server.security

Class CustomWebAuthenticatorInitContext

java.lang.Object

com.spotfire.server.security.CustomWebAuthenticatorInitContext

public class CustomWebAuthenticatorInitContext
extends Object

The initialization context for a CustomWebAuthenticator.

Since:

7.8

See Also:

• CustomWebAuthenticator.init(CustomWebAuthenticatorInitContext)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getParameters()	Returns a, possibly empty, map of initialization parameters (configured using the Configuration Tool or the config-custom-web-auth configuration command).
String	getReturnEndpoint()	Deprecated. This method is deprecated and will be removed in a future release.
UserDirectory	getUserDirectory()	Returns a reference to the User Directory class, that can be used for reading and writing users and groups.

Methods inherited from class java.lang.Object

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

Method Details

getReturnEndpoint

@Deprecated
public String getReturnEndpoint()

Deprecated.

This method is deprecated and will be removed in a future release. Please use WebAuthenticationContext.getReturnEndpoint() instead.

Returns the URL to the endpoint on the Spotfire Server to which the identity provider should redirect the user's browser after authentication. The returned String is an absolute URL on the form http[s]://<host>[:<port>]/spotfire/auth/custom/authenticate.

Returns:

the URL to the endpoint on the Spotfire Server to which the identity provider should redirect the user's browser after authentication

Since:

7.8

getParameters

public Map<String,String> getParameters()

Returns a, possibly empty, map of initialization parameters (configured using the Configuration Tool or the config-custom-web-auth configuration command).

Returns:

a, possibly empty, map of initialization parameters.

Since:

7.8

getUserDirectory

public UserDirectory getUserDirectory()

Returns a reference to the User Directory class, that can be used for reading and writing users and groups.

Returns:

a reference to the User Directory class

Since:

10.1