Skip to main content
Version: 16.8.2

config_elements

xlsConfig​

class xlsConfig(ConfigElement)

An xlsConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: xlsConfig(default="allow", embedded_images="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes: dict = {}, **kwargs)

jpegConfig​

class jpegConfig(ConfigElement)

A jpegConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: jpegConfig(default="allow", embedded_images="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes: dict = {}, **kwargs)

tiffConfig​

class tiffConfig(ConfigElement)

A tiffConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: tiffConfig(geotiff="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes={}, **kwargs)

wordConfig​

class wordConfig(ConfigElement)

A wordConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: wordConfig(default="allow", embedded_images="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes: dict = {}, **kwargs)

svgConfig​

class svgConfig(ConfigElement)

A svgConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: svgConfig(default="allow", embedded_images="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes: dict = {}, **kwargs)

gifConfig​

class gifConfig(ConfigElement)

A gifConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: gifConfig(default="allow", embedded_images="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes: dict = {}, **kwargs)

ConfigElement​

class ConfigElement()

A Content Management Policy configuration element which has a name, and can have attributes, switches, and subelements.

__init__​

def __init__(
        name: str,
        attributes: dict = {},
        switches: list = [],
        subelements: list = [],
        default: Optional[str] = None,
        default_switches: list = [],
        config: dict = {},
        switches_module: "glasswall.content_management.switches" = Switch)

__str__​

def __str__()

__getattr__​

def __getattr__(name)

__repr__​

def __repr__()

Change string representation of object.

__lt__​

def __lt__(other)

Used for sorting. Sort by "name" then "switches".

text​

@property
def text()

String representation of XML.

get_switch_names​

def get_switch_names()

Returns a sorted list of unique Switch.name values from self.switches.

remove_switch​

def remove_switch(switch: Union[Switch, str])

Removes all Switch instances from self.switches that match arg "switch".

Arguments:

  • switch Union[Switch, str] - A Switch instance or str to match Switch.name.

Returns:

self

Raises:

  • glasswall.content_management.errors.switches.SwitchNotFound - The switch was not found.

add_switch​

def add_switch(switch: Switch, replace: bool = True)

Adds a Switch instance to self.switches.

Arguments:

  • switch Switch - A Switch instance.
  • replace bool, optional - Default True. Deletes any pre-existing Switch with the same .name attribute in self.switches.

Returns:

self

archiveConfig​

class archiveConfig(ConfigElement)

An archiveConfig ConfigElement.

Arguments:

  • default str - The default action: no_action, discard, or process.

    Key word arguments can be specified to change individual switch values: archiveConfig(default="no_action", jpeg="discard", pdf="process")

__init__​

def __init__(default: str = "process", attributes: dict = {}, **kwargs)

webpConfig​

class webpConfig(ConfigElement)

A webpConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: webpConfig(default="allow", embedded_images="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes: dict = {}, **kwargs)

textList​

class textList(ConfigElement)

A textList ConfigElement.

__init__​

def __init__(subelements: list = [])

sysConfig​

class sysConfig(ConfigElement)

A sysConfig ConfigElement.

Key word arguments can be specified to change individual switch values: sysConfig(interchange_type="sisl",interchange_pretty="true",)

__init__​

def __init__(attributes={}, **kwargs)

pptConfig​

class pptConfig(ConfigElement)

A pptConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: pptConfig(default="allow", embedded_images="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes: dict = {}, **kwargs)

pdfConfig​

class pdfConfig(ConfigElement)

A pdfConfig ConfigElement.

Arguments:

  • default str - The default action: allow, disallow, or sanitise.

    Key word arguments can be specified to change individual switch values: pdfConfig(default="allow", embedded_images="sanitise")

__init__​

def __init__(default: str = "sanitise", attributes: dict = {}, **kwargs)

textSearchConfig​

class textSearchConfig(ConfigElement)

A textSearchConfig ConfigElement.

textSearchConfig( libVersion="core2", textList_subelements=[ {"name": "textItem", "switches": [ {"name": "text", "value": "generic"}, {"name": "textSetting", "@replacementChar": "*", "value": "redact"}, ]} ] )

__init__​

def __init__(attributes: dict = {}, textList_subelements: list = [], **kwargs)
Last updated on