\r\n

51Degrees Pipeline Python  4.3

51Degrees Pipeline for Python
  • pipeline-python
  • fiftyone_pipeline_core
  • fiftyone_pipeline_core
  • setheaderelement
  • SetHeaderElement

pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.setheaderelement.SetHeaderElement Class Reference

Detailed Description

Set response headers element class.

This is used to get response headers based on what the browser supports. For example, newer Chrome browsers support the Accept-CH header.

Inheritance diagram for pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.setheaderelement.SetHeaderElement:

[legend]

Collaboration diagram for pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.setheaderelement.SetHeaderElement:

[legend]

Public Member Functions

def  __init__ (self)
List of Pipelines the FlowElement has been added to. More...
def  process_internal (self, flowdata)
Add the response header dictionary to the FlowData. More...
def  get_setheader_properties_pipeline (self, pipeline)
Get All the properties starting with SetHeader string from pipeline. More...
def  get_response_header_value (self, flowData, setHeader_properties_dict)
Get response header value using set header properties from FlowData. More...
def  get_property_value (self, flowData, element_key, property_key)
Try to get the value for the given element and property. More...
def  get_response_header_name (self, property_key)
Determines which response header the property value will be appended to by stripping the 'SetHeader' string and the 'Component Name' from the property name. More...

Public Member Functions inherited from pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement

def  process (self, flowdata)
Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method. More...
def  on_registration (self, pipeline)
Function called when an element is added to the pipeline. More...
def  get_evidence_key_filter (self)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
def  filter_evidence (self, flowdata)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
def  filter_evidence_key (self, key)
Filter FlowData.evidence using the flowElement's EvidenceKeyFilter with the property key of evidence of interest. More...
def  get_properties (self)
Get the FlowElement.properties of a FlowElement. More...

Public Attributes

 datakey
 properties
 setheader_properties
 exclude_from_messages

Public Attributes inherited from pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement

 pipelines
 properties
 datakey
 exclude_from_messages

Constructor & Destructor Documentation

Member Function Documentation

◆ get_property_value()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.setheaderelement.SetHeaderElement.get_property_value (   self,
  flowData,
  element_key,
  property_key  
)

Try to get the value for the given element and property.

If the value cannot be found or is null/unknown, then "" will be returned.

Parameters
flowData - A processed FlowData instance to get the value from.
element_key - Key for the element data to get the value from
property_key - Name of the property to get the value for. @rtype String
Returns
value or empty string

◆ get_response_header_name()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.setheaderelement.SetHeaderElement.get_response_header_name (   self,
  property_key  
)

Determines which response header the property value will be appended to by stripping the 'SetHeader' string and the 'Component Name' from the property name.

Parameters
property_key - Key for SetHeaderAcceptCH property @rtype String
Returns
Response Header name

◆ get_response_header_value()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.setheaderelement.SetHeaderElement.get_response_header_value (   self,
  flowData,
  setHeader_properties_dict  
)

Get response header value using set header properties from FlowData.

@type flowdata: FlowData

Parameters
flowdata - A processed FlowData object containing setheader properties
setHeader_properties_dict - A processed FlowData object containing setheader properties @rtype dict
Returns
A dictionary object containing SetHeader properties list against flowElement

◆ get_setheader_properties_pipeline()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.setheaderelement.SetHeaderElement.get_setheader_properties_pipeline (   self,
  pipeline  
)

Get All the properties starting with SetHeader string from pipeline.

Parameters
pipeline - A Pipeline object @rtype dict
Returns
A dictionary object containing SetHeader properties list against flowElement