Quellcodebibliothek Statistik Leitseite products/sources/formale Sprachen/Java/Tomcat/java/jakarta/servlet/   (Apache Software Stiftung Version 11.0©)  Datei vom 10.10.2023 mit Größe 4 kB image not shown  

Quelle  ServletRegistration.java   Sprache: JAVA

 
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jakarta.servlet;

import java.util.Collection;
import java.util.Set;

/**
 * Interface through which a Servlet may be further configured.
 *
 * @since Servlet 3.0
 */

public interface ServletRegistration extends Registration {

    /**
     * Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration. If
     * any of the specified URL patterns are already mapped to a different Servlet, no updates will be performed. If
     * this method is called multiple times, each successive call adds to the effects of the former. The returned set is
     * not backed by the ServletRegistration object, so changes in the returned set are not reflected in the
     * ServletRegistration object, and vice-versa.
     *
     * @param urlPatterns The URL patterns that this Servlet should be mapped to
     *
     * @return the (possibly empty) Set of URL patterns that are already mapped to a different Servlet
     *
     * @throws IllegalArgumentException if urlPattern is null or empty
     * @throws IllegalStateException    if the associated ServletContext has already been initialised
     */

    Set<String> addMapping(String... urlPatterns);

    /**
     * Gets the currently available mappings of the Servlet represented by this ServletRegistration. If permitted, any
     * changes to the returned Collection must not affect this ServletRegistration.
     *
     * @return a (possibly empty) Collection of the currently available mappings of the Servlet represented by this
     *             ServletRegistration
     */

    Collection<String> getMappings();

    /**
     * Obtain the name of the user / group under which the Servlet has been configured to run.
     *
     * @return the name of the user / group or {@code null} if none has been specified
     */

    String getRunAsRole();

    /**
     * Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further
     * configured.
     */

    interface Dynamic extends ServletRegistration, Registration.Dynamic {

        /**
         * Set the loadOnStartup order for the Servlet
         *
         * @param loadOnStartup The position in the order the Servlet should be started (higher numbers are started
         *                          after lower numbers)
         */

        void setLoadOnStartup(int loadOnStartup);

        /**
         * Add security constraints to this Servlet.
         *
         * @param constraint new security constraints for this Servlet
         *
         * @return urls currently mapped to this registration that are already present in web.xml
         */

        Set<String> setServletSecurity(ServletSecurityElement constraint);

        /**
         * Set the multi-part configuration for the associated Servlet. To clear the multi-part configuration specify
         * <code>null</code> as the new value.
         *
         * @param multipartConfig The configuration to associate with the Servlet
         */

        void setMultipartConfig(MultipartConfigElement multipartConfig);

        /**
         * Set the name of the user / group under which the Servlet should be configured to run.
         *
         * @param roleName name of the user / group or {@code null} if none
         */

        void setRunAsRole(String roleName);
    }
}

95%


¤ Dauer der Verarbeitung: 0.24 Sekunden  (vorverarbeitet)  ¤

*© Formatika GbR, Deutschland






Wurzel

Suchen

Beweissystem der NASA

Beweissystem Isabelle

NIST Cobol Testsuite

Cephes Mathematical Library

Wiener Entwicklungsmethode

Haftungshinweis

Die Informationen auf dieser Webseite wurden nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit, noch Qualität der bereit gestellten Informationen zugesichert.

Bemerkung:

Die farbliche Syntaxdarstellung ist noch experimentell.