javax.servlet

Interface Registration

Table des matières
  • All Known Subinterfaces:
    FilterRegistration, FilterRegistration.Dynamic, Registration.Dynamic, ServletRegistration, ServletRegistration.Dynamic

    public interface Registration
    Interface through which a Servlet or Filter may be further configured.

    A Registration object whose getClassName() method returns null is considered preliminary. Servlets and Filters whose implementation class is container implementation specific may be declared without any servlet-class or filter-class elements, respectively, and will be represented as preliminary Registration objects. Preliminary registrations must be completed by calling one of the addServlet or addFilter methods on ServletContext, and passing in the Servlet or Filter name (obtained via getName()) along with the supporting Servlet or Filter implementation class name, Class object, or instance, respectively. In most cases, preliminary registrations will be completed by an appropriate, container-provided ServletContainerInitializer.

    Since:
    Servlet 3.0

    • Method Detail

      • getName

        String getName()
        Gets the name of the Servlet or Filter that is represented by this Registration.
        Returns:
        the name of the Servlet or Filter that is represented by this Registration

      • getClassName

        String getClassName()
        Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration.
        Returns:
        the fully qualified class name of the Servlet or Filter that is represented by this Registration, or null if this Registration is preliminary

      • setInitParameter

        boolean setInitParameter(String name,
                         String value)
        Sets the initialization parameter with the given name and value on the Servlet or Filter that is represented by this Registration.
        Parameters:
        name - the initialization parameter name
        value - the initialization parameter value
        Returns:
        true if the update was successful, i.e., an initialization parameter with the given name did not already exist for the Servlet or Filter represented by this Registration, and false otherwise
        Throws:
        IllegalStateException - if the ServletContext from which this Registration was obtained has already been initialized
        IllegalArgumentException - if the given name or value is null

      • getInitParameter

        String getInitParameter(String name)
        Gets the value of the initialization parameter with the given name that will be used to initialize the Servlet or Filter represented by this Registration object.
        Parameters:
        name - the name of the initialization parameter whose value is requested
        Returns:
        the value of the initialization parameter with the given name, or null if no initialization parameter with the given name exists

      • setInitParameters

        Set<String> setInitParameters(Map<String,String> initParameters)
        Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration.

        The given map of initialization parameters is processed by-value, i.e., for each initialization parameter contained in the map, this method calls setInitParameter(String,String). If that method would return false for any of the initialization parameters in the given map, no updates will be performed, and false will be returned. Likewise, if the map contains an initialization parameter with a null name or value, no updates will be performed, and an IllegalArgumentException will be thrown.

        Parameters:
        initParameters - the initialization parameters
        Returns:
        the (possibly empty) Set of initialization parameter names that are in conflict
        Throws:
        IllegalStateException - if the ServletContext from which this Registration was obtained has already been initialized
        IllegalArgumentException - if the given map contains an initialization parameter with a null name or value

      • getInitParameters

        Map<String,String> getInitParameters()
        Gets an immutable (and possibly empty) Map containing the currently available initialization parameters that will be used to initialize the Servlet or Filter represented by this Registration object.
        Returns:
        Map containing the currently available initialization parameters that will be used to initialize the Servlet or Filter represented by this Registration object

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

21/08/2025 15:08:36 Cette version de la page est en cache (à la date du 21/08/2025 15:08:36) afin d'accélérer le traitement.
Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.

Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/servlet/registration.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.