org.apache.turbine.modules.screens

## Class JSONSecureScreen

- java.lang.Object
- - org.apache.turbine.modules.Assembler
  - - org.apache.turbine.modules.Screen
    - - org.apache.turbine.modules.screens.RawScreen
      - - org.apache.turbine.modules.screens.JSONScreen
        - - org.apache.turbine.modules.screens.JSONSecureScreen

-     public abstract class JSONSecureScreen
      extends JSONScreen

  An extension to JSONScreen that performs a Security Check before invoking doBuildTemplate(). You should extend this class and add the specific security check needed. If you have a number of screens that need to perform the same check, you could make a base screen by extending this class and implementing the isAuthorized(). Then each screen that needs to perform the same check could extend your base screen.

  Typically you would extend this class and override the doOutput() method to use TurbineJsonRpc to register the POJOs that will provide the functions you are making available via JSON-RPC. Use JSONScreen if you do not need the user to be logged in prior to executing the functions you provide.

  Here is an example from a superclass: `public void doOutput(PipelineData data) throws Exception { User user = data.getUser(); MySecureJsonFunctions myFunctions = new MySecureJsonFunctions(user.getName()); // Session specific TurbineJsonRpc.registerObject(data.getSession(), "myFunctions", myFunctions); // Global //TurbineJsonRpc.registerObjectGlobal("testGlobal", testObject); super.doOutput(data); }`

  The class MyFunctions would be something like: `public class MySecureJsonFunctions { private final String name; public MySecureJsonFunctions(String name) { this.name = name; } private String getName(String clientParameter) { return "Client " + clientParameter + " says Hello World to " + name; } }`

  Version:
    $Id: JSONSecureScreen.java 1773378 2016-12-09 13:19:59Z tv $
  Author:
    Scott Eade

- - ### Field Summary

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

      `BUFFER_SIZE, JSONRPC_CONTENT_TYPE, jsonRpcService`

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

      `CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `JSONSecureScreen()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `doOutput(PipelineData pipelineData)` This method overrides the method in JSONScreen to perform a security check prior to producing the output.
    `protected abstract boolean` | `isAuthorized(PipelineData pipelineData)` Override this method to perform the necessary security checks.

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

      `getContentType`

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

      `doBuild, getLayout`

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

      `build, 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

    - #### JSONSecureScreen

          public JSONSecureScreen()

  - ### Method Detail

    - #### doOutput

          protected void doOutput(PipelineData pipelineData)
                           throws Exception

      This method overrides the method in JSONScreen to perform a security check prior to producing the output.
      Overrides:
        `doOutput` in class `JSONScreen`
      Parameters:
        `pipelineData` - Turbine information.
      Throws:
        `Exception` - a generic exception.

    - #### isAuthorized

          protected abstract boolean isAuthorized(PipelineData pipelineData)
                                           throws Exception

      Override this method to perform the necessary security checks.
      Parameters:
        `pipelineData` - 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.