org.apache.guacamole.protocol

Interface GuacamoleFilter

public interface GuacamoleFilter

Interface which provides for the filtering of individual instructions. Each filtered instruction may be allowed through untouched, modified, replaced, dropped, or explicitly denied.

Author:

Michael Jumper

Method Summary

Modifier and Type	Method and Description
GuacamoleInstruction	filter(GuacamoleInstruction instruction) Applies the filter to the given instruction, returning the original instruction, a modified version of the original, or null, depending on the implementation.

Method Detail

filter

GuacamoleInstruction filter(GuacamoleInstruction instruction)
                     throws GuacamoleException

Applies the filter to the given instruction, returning the original instruction, a modified version of the original, or null, depending on the implementation.

Parameters:

instruction - The instruction to filter.

Returns:

The original instruction, if the instruction is to be allowed, a modified version of the instruction, if the instruction is to be overridden, or null, if the instruction is to be dropped.

Throws:

GuacamoleException - If an error occurs filtering the instruction, or if the instruction must be explicitly denied.