- java.lang.Object
-
- javax.security.auth.login.ConfigurationSpi
-
public abstract class ConfigurationSpi extends Object
This class defines the Service Provider Interface (SPI) for theConfiguration
class. All the abstract methods in this class must be implemented by each service provider who wishes to supply a Configuration implementation.Subclass implementations of this abstract class must provide a public constructor that takes a
Configuration.Parameters
object as an input parameter. This constructor also must throw an IllegalArgumentException if it does not understand theConfiguration.Parameters
input.- Since:
- 1.6
-
-
Constructor Summary
Constructors Constructor and Description ConfigurationSpi()
-
Method Summary
Methods Modifier and Type Method and Description protected abstract AppConfigurationEntry[]
engineGetAppConfigurationEntry(String name)
Retrieve the AppConfigurationEntries for the specified name.protected void
engineRefresh()
Refresh and reload the Configuration.
-
-
-
Method Detail
-
engineGetAppConfigurationEntry
protected abstract AppConfigurationEntry[] engineGetAppConfigurationEntry(String name)
Retrieve the AppConfigurationEntries for the specified name.- Parameters:
name
- the name used to index the Configuration.- Returns:
- an array of AppConfigurationEntries for the specified name, or null if there are no entries.
-
engineRefresh
protected void engineRefresh()
Refresh and reload the Configuration.This method causes this Configuration object to refresh/reload its contents in an implementation-dependent manner. For example, if this Configuration object stores its entries in a file, calling
refresh
may cause the file to be re-read.The default implementation of this method does nothing. This method should be overridden if a refresh operation is supported by the implementation.
- Throws:
SecurityException
- if the caller does not have permission to refresh its Configuration.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/security/auth/login/ConfigurationSpi.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.