Gaffer

Feitor

Para obter acesso rápido e fácil a um ambiente com tudo instalado e configurado corretamente você pode usar GitHub Codespaces ou, alternativamente, GitLab GitPod. Eles fornecem ambientes de codificação remota usando VS Code com os plug-ins necessários, versão Java e Maven pré-instalados.

Nosso Javadoc pode ser encontrado aqui. A documentação do Gaffer é mantida no repositório gaffer-doc e publicada nas páginas do GitHub (gchq.github.io).

Requisitos locais

Para construir o Gaffer localmente você precisa do Java 8 ou 11 e do Maven instalados localmente em um ambiente *nix. O MS Windows funcionará para a maioria das finalidades, mas não é recomendado porque os testes que utilizam o Hadoop falham devido ao suporte limitado do Hadoop no Windows. O Gaffer compilará com versões mais recentes do Java, mas alguns testes falharão devido à falta de suporte para Java mais recente em certas dependências externas.

Para construir o Gaffer, execute mvn clean install -Pquick no diretório de nível superior. Isso construirá todas as bibliotecas principais do Gaffer e alguns exemplos de como carregar e consultar dados.

Processo de Contribuição

Informações detalhadas sobre nossas formas de trabalhar podem ser encontradas em nossos documentos para desenvolvedores. Em resumo:

• Assine o Contrato de Licença de Contribuinte do GCHQ
• Envie suas alterações para um fork
• Envie uma solicitação pull

Inclusão em outros projetos

O Gaffer está hospedado no Maven Central e pode ser facilmente incorporado aos seus próprios projetos maven.

Para usar o Gaffer da API Java, as únicas dependências necessárias são o módulo gráfico Gaffer e um módulo de armazenamento para a tecnologia de banco de dados específica usada para armazenar os dados, por exemplo, para o armazenamento Accumulo:

< dependency >
    < groupId >uk.gov.gchq.gaffer</ groupId >
    < artifactId >graph</ artifactId >
    < version >${gaffer.version}</ version >
</ dependency >
< dependency >
    < groupId >uk.gov.gchq.gaffer</ groupId >
    < artifactId >accumulo-store</ artifactId >
    < version >${gaffer.version}</ version >
</ dependency >

Isso incluirá todas as outras dependências obrigatórias. Outros componentes (opcionais) podem ser adicionados ao seu projeto conforme necessário.

Repositórios relacionados

O repositório gafferpy contém um shell python que pode executar operações.

O repositório gaffer-docker contém o código necessário para executar o Gaffer usando Docker ou Kubernetes.

O repositório koryphe contém uma biblioteca de funções extensível para filtrar, agregar e transformar dados com base na API Java Function. É uma dependência do Gaffer.

Licença

Gaffer é licenciado sob a licença Apache 2 e é coberto pelos direitos autorais da Crown.

 Copyright 2016-2023 Crown Copyright

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.