Este conteúdo não está disponível no idioma selecionado.

4.4. Configure a Web Application to use a Valve


Valves that are not installed as global valves must be included with your application and configure in the jboss-web.xml deployment descriptor.

Important

Valves that are installed a global valves are automatically applied to all deployed applications. For instructions on how to configure Global Valves, see the chapter entitled Global Valves in the Administration and Configuration Guide for JBoss EAP.

Prerequisites

  • The valve must be created and included in your application's classpath. This can be done by either including it in the application's WAR file or any module that is added as a dependency. Examples of such modules include a static module installed on the server or a JAR file in the lib/ directory of an EAR archive if the WAR is deployed in an EAR.
  • The application must include a jboss-web.xml deployment descriptor.

Procedure 4.1. Configure an application for a local valve

  1. Configure a Valve

    Create a valve element containing the class-name child element in the application's jboss-web.xml file. The class-name is the name of the valve class.
    <valve>
          <class-name>VALVE_CLASS_NAME</class-name>
    </valve>
    Copy to Clipboard Toggle word wrap

    Example 4.1. Example of a valve element configured in the jboss-web.xml file

    <valve>
          <class-name>org.jboss.security.negotiation.NegotiationAuthenticator</class-name>
    </valve>
    Copy to Clipboard Toggle word wrap
  2. Configure a Custom Valve

    If the valve has configurable parameters, add a param child element to the valve element for each parameter, specifying the param-name and param-value for each.

    Example 4.2. Example of a custom valve element configured in the jboss-web.xml file

    <valve>   
        <class-name>org.jboss.web.tomcat.security.GenericHeaderAuthenticator</class-name>  
        <param>  
            <param-name>httpHeaderForSSOAuth</param-name>  
            <param-value>sm_ssoid,ct-remote-user,HTTP_OBLIX_UID</param-value>  
        </param>  
        <param>  
            <param-name>sessionCookieForSSOAuth</param-name>  
            <param-value>SMSESSION,CTSESSION,ObSSOCookie</param-value>  
        </param>  
    </valve>
    Copy to Clipboard Toggle word wrap
When the application is deployed, the valve will be enabled for the application with the specified configuration.

Example 4.3. jboss-web.xml valve configuration

<valve>
    <class-name>org.jboss.samplevalves.RestrictedUserAgentsValve</class-name>
    <param>  
        <param-name>restrictedUserAgents</param-name>
        <param-value>^.*MS Web Services Client Protocol.*$</param-value>
    </param>
 </valve>
Copy to Clipboard Toggle word wrap
Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat