org.apache.turbine.modules.screens

## Class LegacyVelocitySecureScreen

- java.lang.Object
- - org.apache.turbine.modules.Assembler
  - - org.apache.turbine.modules.Screen
    - - org.apache.turbine.modules.screens.TemplateScreen
      - - org.apache.turbine.modules.screens.VelocityScreen
        - - org.apache.turbine.modules.screens.LegacyVelocityScreen
          - - org.apache.turbine.modules.screens.LegacyVelocitySecureScreen

- Deprecated.
  Use VelocitySecureScreen directly

      @Deprecated
      public abstract class LegacyVelocitySecureScreen
      extends LegacyVelocityScreen

  Support Turbine 2 screens
  Author:
    Thomas Vandahl

- - ### Field Summary

    - ### Fields inherited from class org.apache.turbine.modules.screens.VelocityScreen

      `templateError, templateService, velocity`

    - ### Fields inherited from class org.apache.turbine.modules.screens.TemplateScreen

      `log`

    - ### Fields inherited from class org.apache.turbine.modules.Screen

      `CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `LegacyVelocitySecureScreen()` Deprecated.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `doBuildTemplate(PipelineData pipelineData)` Deprecated. This method overrides the method in VelocityScreen to perform a security check first.
    `protected abstract void` | `doBuildTemplate(RunData data, org.apache.velocity.context.Context context)` Deprecated. Implement this to add information to the context.
    `protected abstract boolean` | `isAuthorized(RunData data)` Deprecated. Implement this method to perform the security check needed.

    - ### Methods inherited from class org.apache.turbine.modules.screens.LegacyVelocityScreen

      `doBuildTemplate`

    - ### Methods inherited from class org.apache.turbine.modules.screens.VelocityScreen

      `buildTemplate`

    - ### Methods inherited from class org.apache.turbine.modules.screens.TemplateScreen

      `doBuild, doPostBuildTemplate, doRedirect, doRedirect, setTemplate`

    - ### Methods inherited from class org.apache.turbine.modules.Screen

      `build, getLayout, getPrefix, setLayout`

    - ### Methods inherited from class org.apache.turbine.modules.Assembler

      `getRunData`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### LegacyVelocitySecureScreen

          public LegacyVelocitySecureScreen()

      Deprecated.

  - ### Method Detail

    - #### doBuildTemplate

          protected abstract void doBuildTemplate(RunData data,
                             org.apache.velocity.context.Context context)
                                           throws Exception

      Deprecated.
      Implement this to add information to the context.
      Overrides:
        `doBuildTemplate` in class `LegacyVelocityScreen`
      Parameters:
        `data` - Turbine information.
        `context` - Context for web pages.
      Throws:
        `Exception` - a generic exception.

    - #### doBuildTemplate

          protected void doBuildTemplate(PipelineData pipelineData)
                                  throws Exception

      Deprecated.
      This method overrides the method in VelocityScreen to perform a security check first.
      Overrides:
        `doBuildTemplate` in class `VelocityScreen`
      Parameters:
        `pipelineData` - Turbine information.
      Throws:
        `Exception` - a generic exception.

    - #### isAuthorized

          protected abstract boolean isAuthorized(RunData data)
                                           throws Exception

      Deprecated.
      Implement this method to perform the security check needed. You should set the template in this method that you want the user to be sent to if they're unauthorized. See the VelocitySecurityCheck utility.
      Parameters:
        `data` - Turbine information.
      Returns:
        True if the user is authorized to access the screen.
      Throws:
        `Exception` - a generic exception.

Copyright © 2000–2018 The Apache Software Foundation. All rights reserved.