Elemento roleManager (Esquema de configuración de ASP.NET)

Artículo
08/10/2011

Configura una aplicación para la administración de funciones.

Se trata de un elemento nuevo en .NET Framework, versión 2.0.

<roleManager
    cacheRolesInCookie="true|false"
    cookieName="name"
    cookiePath="/"
    cookieProtection="All|Encryption|Validation|None"
    cookieRequireSSL="true|false "
    cookieSlidingExpiration="true|false "
    cookieTimeout="number of minutes"
    createPersistentCookie="true|false"
    defaultProvider="provider name"
    domain="cookie domain">
    enabled="true|false"
    maxCachedResults="maximum number of role names cached"
    <providers>...</providers>
</roleManager>

Atributos y elementos

Las secciones siguientes describen los atributos, los elementos secundarios y los elementos primarios de esta sección.

Atributos

Atributo	Descripción
cacheRolesInCookie	Atributo Boolean opcional. Especifica que, en el momento de validar si un usuario pertenece a una función determinada, se compruebe la cookie antes de utilizar el proveedor de funciones para comprobar la lista de funciones en el origen de datos. Si es true, la lista de nombres de función de una cookie se almacena en memoria caché para el usuario actual; de lo contrario, es false. El valor predeterminado es false.
cookieName	Atributo String opcional. Especifica el nombre de la cookie en la que se almacenan los nombres de función. El valor predeterminado es ".ASPXROLES".
cookiePath	Atributo String opcional. La ruta de acceso al cookie de nombres de función. El valor predeterminado es "/".
cookieProtection	Atributo CookieProtection opcional. Especifica uno de los valores de enumeración CookieProtection. El valor predeterminado es All.
cookieRequireSSL	Atributo Boolean opcional. Especifica si la cookie de nombres de función requiere SSL para el envío al servidor. Si se establece en true, las cookies de nombres de función requieren SSL para ser enviadas al servidor. El valor predeterminado es false.
cookieSlidingExpiration	Atributo Boolean opcional. Especifica si la fecha y hora de expiración de la cookie de nombres de función se restablece periódicamente. Si se establece en true, la expiración de la cookie se establecerá inicialmente en la fecha y hora actuales más el valor de CookieTimeout, en minutos. Mientras el usuario continúa utilizando la aplicación ASP.NET de forma activa, la fecha y hora de expiración de la cookie se actualiza automáticamente, si todavía queda menos de la mitad del valor de CookieTimeout. Para obtener más información, vea Expires. El valor predeterminado es true.
cookieTimeout	Atributo Int32 opcional. Número de minutos que faltan para que expire la cookie de nombres de función. El valor predeterminado es "30" (minutos).
createPersistentCookie	Atributo Boolean opcional. Especifica si la cookie de nombres de función es una cookie de sesión, es decir, se pierde al cerrar el explorador. Si se establece en true, la cookie de nombres de función se conserva y está disponible en las sucesivas sesiones del explorador. La fecha y hora de expiración de una cookie persistente se establecen en la fecha y hora actuales más el valor de CookieTimeout, en minutos. El valor predeterminado es false.
defaultProvider	Atributo String opcional. El nombre del proveedor de funciones predeterminado. Para obtener más información, vea Provider. El valor predeterminado es "AspNetSqlRoleProvider".
domain	Atributo String opcional. Especifica el valor Domain de la cookie de nombres de función. El valor predeterminado es el valor predeterminado de la propiedad HttpCookie, que es una cadena vacía ("").
enabled	Atributo Boolean opcional. Especifica si se habilita la administración de funciones. Cuando se establece en true, se habilita la administración de funciones. El valor predeterminado es false en el archivo Machine.config.
maxCachedResults	Atributo Int32 opcional. Especifica el número máximo de nombres de función que se almacena en la cookie de funciones. El valor predeterminado es 25.
Atributos heredados	Atributos opcionales. Atributos heredados por todos los elementos section. Para obtener más información, vea Atributos generales heredados por elementos de una sección.

Elementos secundarios

Elemento	Descripción
providers	Elemento opcional. Define una colección de proveedores de rol para la administración de roles.

providers

Elemento opcional.

Define una colección de proveedores de rol para la administración de roles.

Elementos primarios

Elemento	Descripción
configuration	Especifica el elemento raíz necesario de cada archivo de configuración que utilizan las aplicaciones basadas en Common Language Runtime y .NET Framework.
system.web	Especifica el elemento raíz de la sección de configuración de ASP.NET.

Comentarios

El elemento roleManager configura una aplicación para la administración de funciones.

Para obtener información sobre cómo tener acceso a los valores de configuración del elemento roleManager en el código de aplicación y cómo modificarlos, vea RoleManagerSection.

Configuración predeterminada

El siguiente elemento roleManager predeterminado no se configura explícitamente en el archivo Machine.config o en el archivo Web.config raíz. Sin embargo, es la configuración predeterminada que la aplicación devuelve. Los proveedores se configuran explícitamente en el archivo Machine.config.

<roleManager 
   enabled="false" 
   cacheRolesInCookie="false" 
   cookieName=".ASPXROLES" 
   cookieTimeout="30" 
   cookiePath="/" 
   cookieRequireSSL="false" 
   cookieSlidingExpiration="true" 
   cookieProtection="All" 
   defaultProvider="AspNetSqlRoleProvider" 
   createPersistentCookie="false" 
   maxCachedResults="25">
   <providers>
      <clear />
      <add 
         connectionStringName="LocalSqlServer" 
         applicationName="/" 
         name="AspNetSqlRoleProvider" 
         type="System.Web.Security.SqlRoleProvider, System.Web, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
      <add 
         applicationName="/" 
         name="AspNetWindowsTokenRoleProvider" 
         type="System.Web.Security.WindowsTokenRoleProvider, System.Web, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
   </providers>
</roleManager>

Ejemplo

En el ejemplo de código siguiente se muestra cómo configurar una aplicación ASP.NET de manera que utilice la clase SqlRoleProvider para almacenar y recuperar información de funciones.

<configuration>
  <system.web>
    <roleManager defaultProvider="SqlProvider" 
      enabled="true"
      cacheRolesInCookie="true"
      cookieName=".ASPROLES"
      cookieTimeout="30"
      cookiePath="/"
      cookieRequireSSL="false"
      cookieSlidingExpiration="true"
      cookieProtection="All" >
      <providers>
        <add
          name="SqlProvider"
          type="System.Web.Security.SqlRoleProvider"
          connectionStringName="SqlServices" 
          applicationName="SampleApplication" />
      </providers>
    </roleManager>
  </system.web>
</configuration>

Información de elemento

Controlador de la sección de configuración	RoleManagerSection
Miembro de configuración	RoleManager
Ubicaciones configurables	Machine.config Web.config del nivel raíz Web.config del nivel de aplicaciones
Requisitos	Microsoft Internet Information Services (IIS) versión 5.0, 5.1 ó 6.0 .NET Framework versión 2.0 Microsoft Visual Studio 2003 o Visual Studio 2005

Vea también

Elemento roleManager (Esquema de configuración de ASP.NET)

Atributos y elementos

Atributos

Elementos secundarios

Elementos primarios

Comentarios

Configuración predeterminada

Ejemplo

Información de elemento

Vea también

Tareas

Referencia

Conceptos

Otros recursos

Recursos adicionales