gpf_agent_geoserver.core_function module

Specifics functions.

gpf_agent_geoserver.core_function.add_style(geoserver: GeoserverCustom, workspace_name: str, style_path: Path, style_name: str) → Status

Permet d’ajouter un fichier de style.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• layer_name (str) – nom de la couche

• style_path (Path) – chemin vers le fichier de style

• style_name (str) – nom du style

Renvoie:

état de l’ajout du style

Type renvoyé:

Status

gpf_agent_geoserver.core_function.add_template_ftl(geoserver, workspace_name: str, store_name: str, layer_name: str, ftl_path: Path) → Status

Permet d’ajouter un fichier ftl à une couche WMS.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• store_name (str) – nom du dataStore

• layer_name (str) – nom de la couche

• ftl_path (Path) – chemin vers le fichier ftl

• ftl_name (str) – nom du ftl

Renvoie:

état de l’ajout du ftl

Type renvoyé:

Status

gpf_agent_geoserver.core_function.create_datastore(geoserver: GeoserverCustom, workspace: str, store_name: str, schema_name: str, id_storage: str, expose_primary_key: bool) → Status

Permet de créer un nouveau dataStore dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace (str) – nom du workspace

• store_name (str) – nom du dataStore

• schema_name (str) – schéma a utiliser dans de la base de donnée Postgres

• id_storage (str) – id du storage de la base de donnée Postgres

• expose_primary_key (bool) – indique si la clef primaire doit être exposé

Renvoie:

état de la création

Type renvoyé:

Status

gpf_agent_geoserver.core_function.create_layer(geoserver: GeoserverCustom, workspace_name: str, store_name: str, pg_table: str, srs: str, name: str | None = None) → Status

Permet de créer une nouvelle couche dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• store_name (str) – nom du dataStore

• pg_table (str) – table de la base de donnée contenant les données de la couche

Renvoie:

état de la création

Type renvoyé:

Status

gpf_agent_geoserver.core_function.create_layer_group(geoserver: GeoserverCustom, layer_group_name: str, layers: list, styles: list, workspace_name: str | None = None) → Status

Permet de créer un nouveau groupe de couches dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• layer_group_name (str) – nom du groupe de couche

• layers (list) – liste des couches du groupe

• styles (str) – liste des styles

• keywords (list) – liste de mots clés

Renvoie:

état de la création

Type renvoyé:

Status

gpf_agent_geoserver.core_function.create_workspace(geoserver: GeoserverCustom, workspace_name: str) → Status

Permet de créer un nouvel espace de travail dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

Renvoie:

état de la création

Type renvoyé:

Status

gpf_agent_geoserver.core_function.datastore_exist(geoserver: GeoserverCustom, workspace_name: str, store_name: str) → bool

Check si un dataStore existe dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace (str) – nom du workspace

• store_name (str) – nom du dataStore

Renvoie:

True si le dataStore existe, False sinon

Type renvoyé:

bool

gpf_agent_geoserver.core_function.delete_datastore(geoserver: GeoserverCustom, workspace_name: str, store_name: str) → Status

Permet de supprimer un dataStore dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace (str) – nom du workspace

• store_name (str) – nom du dataStore

Renvoie:

état de la suppression

Type renvoyé:

Status

gpf_agent_geoserver.core_function.delete_layer(geoserver: GeoserverCustom, workspace_name: str, layer_name: str) → Status

Permet de supprimer une couche dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• layer_name (str) – nom de la couche

Renvoie:

état de la suppression

Type renvoyé:

Status

gpf_agent_geoserver.core_function.delete_layer_group(geoserver: GeoserverCustom, workspace_name: str, layergroup_name: str) → Status

Permet de supprimer un groupe de couches dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• layer_group_name (str) – nom du groupe de couche

Renvoie:

état de la suppression

Type renvoyé:

Status

gpf_agent_geoserver.core_function.delete_workspace(geoserver: GeoserverCustom, workspace_name: str) → Status

Permet de supprimer un espace de travail dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

Renvoie:

état de la suppression

Type renvoyé:

Status

gpf_agent_geoserver.core_function.get_nb_layers_in_store(geoserver: GeoserverCustom, workspace_name: str, store_name: str) → int

Compte le nombre de couches dans un dataStore.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• store_name (str) – nom du dataStore

Renvoie:

nombre de couches

Type renvoyé:

int

gpf_agent_geoserver.core_function.get_nb_store_in_workspace(geoserver: GeoserverCustom, workspace_name: str) → int

Compte le nombre de dataStores dans un workspace.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

Renvoie:

nombre de dataStores

Type renvoyé:

int

gpf_agent_geoserver.core_function.layer_exist(geoserver: GeoserverCustom, workspace_name: str, layer_name: str) → bool

Check si une couche existe dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• layer_name (str) – nom de la couche

Renvoie:

True si la couche existe, False sinon

Type renvoyé:

bool

gpf_agent_geoserver.core_function.layer_group_exist(geoserver: GeoserverCustom, layer_group_name: str, workspace_name=None) → bool

Check si le groupe de couches existe dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name – nom du workspace ou None

• layer_group_name (str) – nom du groupe de couche

Renvoie:

True si le groupe de couches existe, False sinon

Type renvoyé:

bool

gpf_agent_geoserver.core_function.update_layer(geoserver: GeoserverCustom, workspace_name: str, name: str, title: str = '', abstract: str = '', keywords: list = [], bbox: list = [], metadata: list = [], attribution: dict = {}, published: bool = True) → Status

Permet de mettre à jour une couche dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• store_name (str) – nom du dataStore

• name (str) – nom de la couche

• title (str) – titre de la couche

• pg_table (str) – table de la base de donnée contenant les données de la couche

• abstract (str) – description de la couche

• keywords (list) – liste de mots clés

• bbox (list) – extent de diffusion (xmin,ymin,xmax,ymax)

• metadata (list) – métadonnées de la couche

• attribution (dict) – attribution de la couche

• published (bool) – couche à publier

Renvoie:

état de la mise à jour

Type renvoyé:

Status

gpf_agent_geoserver.core_function.update_layer_group(geoserver: GeoserverCustom, layer_group_name: str, title: str = '', abstract: str = '', keywords: list = [], bbox: list = [], metadata: list = [], attribution: dict = {}, workspace_name: str | None = None) → Status

Permet de mettre à jour un groupe de couches dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

• layer_group_name (str) – nom du groupe de couche

• title (str) – titre de la couche

• abstract (str) – description de la couche

• keywords (list) – liste de mots clés

• bbox (list) – extent de diffusion (xmin,ymin,xmax,ymax)

• metadata (list) – métadonnées de la couche

• attribution (dict) – attribution de la couche

Renvoie:

état de la mise à jour

Type renvoyé:

Status

gpf_agent_geoserver.core_function.workspace_exist(geoserver: GeoserverCustom, workspace_name: str) → bool

Check si un workspace existe dans le geoserver.

Paramètres:

• geoserver (GeoserverCustom) – instance de la class GeoserverCustom

• workspace_name (str) – nom du workspace

Renvoie:

True si le workspace existe, False sinon

Type renvoyé:

bool