Skip to content
GitLab
Commit 7794f0d3 authored by Carlos Eduardo Lara Augusto's avatar Carlos Eduardo Lara Augusto
Browse files

[OPENBUS-2770] Documentação do core do OpenBus 2.1 

- Remoção de trecho sobre parâmetros de entrada do busadmin.
- Pequena alteração no texto.

git-svn-id: https://subversion.tecgraf.puc-rio.br/engdist/openbus/core/trunk@164720 ae0415b3-e90b-0410-900d-d0be9363c56b
parent 56d90a7e
Hide whitespace changes
Inline Side-by-side
doc/overview/overview.tex
View file @ 7794f0d3
......@@ -321,8 +321,7 @@ O papel do administrador de sistema
Para desempenhar o papel de gerente do barramento, disponibilizamos a ferramenta \emph{busadmin}, que permite que se realize atividades de governança (administração) sobre o barramento.
Vamos agora apresentar alguns conceitos importantes de governança dentro do \openbus{}.
Existem os conceitos de:
Vamos agora apresentar alguns conceitos importantes de governança dentro do \openbus{}. Eles são:
\begin{description}
\item[Categoria] Representa uma categoria de entidades no barramento.
......@@ -345,182 +344,6 @@ dada entidade no barramento. Ver se
Para informações sobre como utilizar a ferramenta, consulte~\cite{busadminmanual}.
%%TODO mover conteudo abaixo para o manual do busadmin.
\begin{verbatim}
busadmin [opções] --login=<usuário> <comando>
\end{verbatim}
Para adicionar e remover categorias, entidades, certificados, interfaces e autorizações, aconselhamos que se defina um arquivo de script \lua{} com o formato especificado no código~\ref{lst:openbus.adm}. Ele serve de entrada para os comandos ``script'' e ``undo-script'' da ferramenta \emph{busadmin}, que, respectivamente, executa e desfaz a execução do lote de comandos especificados pelo arquivo de script.
\begin{htmlonly}
\codeinput{openbus.adm}{Exemplo de script para a ferramenta \emph{busadmin}:}
\end{htmlonly}
O \emph{busadmin} também permite realizar esses cadastros e descadastros manualmente, além de realizar consultas e outras atividades de gerência do barramento.
A listagem completa dos comandos disponíveis é apresentada a seguir:
\begin{itemize}
\item \textbf{Opções:}
\begin{description}
\item[\texttt{--}host=\textless endereço\textgreater] Informa o endereço do Barramento.\\
Valor padrão é 127.0.0.1.
\item[\texttt{--}port=\textless porta\textgreater] Informa a porta do Barramento.\\
Valor padrão é 2089.
\item[\texttt{--}verbose=\textless nível\textgreater] Aciona o verbose da API \openbus{}.\\
Valor padrão é 0.
Os níveis vão de 0 a 5, onde 5 é o nível com mais detalhes, e o 0 desativa o log.
\item[\texttt{--}oilverbose=\textless nível\textgreater] Aciona o verbose do \oil{}.\\
Valor padrão é 0.
Os níveis vão de 0 a 5, onde 5 é o nível com mais detalhes, e o 0 desativa o log.
\item[\texttt{--}certificate=\textless arquivo\textgreater] Informa a chave privada para realizar a autenticação por certificado, ao invés de ser por senha.
O padrão é realizar a autenticação por senha, onde a ferramenta pergunta a senha antes de executar o comando.
\end{description}
\item \textbf{Controle de Categoria:}
\begin{description}
\item[\texttt{--}add-category=\textless id\textgreater \space
\texttt{--}name=\textless nome\textgreater] Adiciona uma categoria com o identificador e nome descritivo especificado.
\item[\texttt{--}del-category=\textless id\textgreater] Remove a categoria com o identificador especificado.
\item[\texttt{--}set-category=\textless id\textgreater \space
\texttt{--}name=\textless nome\textgreater] Altera o nome descritivo da categoria com o identificador especificado.
\item[\texttt{--}list-category] Mostra as informações de todas as categorias cadastradas.
\item[\texttt{--}list-category=\textless id\textgreater] Mostra informações da categoria especificada.
\end{description}
\item \textbf{Controle de Entidade:}
\begin{description}
\item[\texttt{--}add-entity=\textless id\textgreater \space
\texttt{--}category=\textless id\_categoria\textgreater \space
\texttt{--}name=\textless nome\textgreater] Adiciona uma entidade com o identificador, categoria e nome descritivo especificado.
\item[\texttt{--}del-entity=\textless id\textgreater] Remove a entidade com o identificador especificado.
\item[\texttt{--}set-entity=\textless id\textgreater \space
\texttt{--}name=\textless nome\textgreater] Altera o nome descritivo da entidade com o identificador especificado.
\item[\texttt{--}list-entity] Mostra as informações de todas as entidades cadastradas.
\item[\texttt{--}list-entity=\textless id\textgreater] Mostra informações da entidade especificada.
\item[\texttt{--}list-entity\space
\texttt{--}category=\textless id\_categoria\textgreater] Mostra informações das entidades pertencentes a categoria especificada.
\end{description}
\item \textbf{Controle de Certificado:}
\begin{description}
\item[\texttt{--}add-certificate=\textless id\_entidade\textgreater \space
\texttt{--}certificate=\textless certificado\textgreater] Cadastra o certificado para a entidade especificada.
\item[\texttt{--}del-certificate=\textless id\_entidade\textgreater] Remove o certificado da entidade especificada.
\end{description}
\item \textbf{Controle de Interface:}
\begin{description}
\item[\texttt{--}add-interface=\textless interface\textgreater] Adiciona a interface na lista de interfaces permitidas no barramento.
\item[\texttt{--}del-interface=\textless interface\textgreater] Remove a interface da lista de interfaces permitidas no barramento.
\item[\texttt{--}list-interface=\textless interface\textgreater] Mostra as interfaces permitidas no barramento.
\end{description}
\item \textbf{Controle de Autorização:}
\begin{description}
\item[\texttt{--}set-authorization=\textless id\_entidade\textgreater \space
\texttt{--}grant=\textless interface\textgreater] Autoriza a entidade a publicar a interface especificada.
\item[\texttt{--}set-authorization=\textless id\_entidade\textgreater \space
\texttt{--}revoke=\textless interface\textgreater] Remove a autorização da entidade de publicar a interface especificada.
\item[\texttt{--}list-authorization] Mostra todas as autorizações concedidas no barramento.
\item[\texttt{--}list-authorization=\textless id\_entidade\textgreater] Mostra todas as autorizações da entidade especificada.
\item[\texttt{--}list-authorization
\texttt{--}interface=``\textless interface1\textgreater \space
\textless interface1\textgreater \dots
\textless interfaceN\textgreater''] Mostra todas as autorizações contendo as interfaces especificadas.
\end{description}
\item \textbf{Controle de Ofertas:}
\begin{description}
\item[\texttt{--}del-offer] Lista todas as ofertas publicadas no barramento e aguarda a escolha de uma oferta para ser removida.
\item[\texttt{--}del-offer \texttt{--}entity=\textless id\textgreater] Lista todas as ofertas publicadas pela entidade especificada e aguarda a escolha de uma oferta para ser removida.
\item[\texttt{--}list-offer] Lista todas as ofertas publicadas no barramento.
\item[\texttt{--}list-offer=\textless id\textgreater] Lista todas as ofertas publicadas pela entidade especificada.
\item[\texttt{--}list-props] Lista todas as ofertas publicadas no barramento e aguarda a escolha de uma oferta para listar todas as suas propriedades.
\item[\texttt{--}list-props=\textless id\textgreater] Lista todas as ofertas publicadas pela entidade especificada e aguarda a escolha de uma oferta para listar todas as suas propriedades.
\item \end{description}
\item \textbf{Controle de Logins:}
\begin{description}
\item[\texttt{--}del-login=\textless id\textgreater] Remove o login especificado.
\item[\texttt{--}list-login] Mostra todos os logins ativos no barramento.
\item[\texttt{--}list-login \texttt{--}entity=\textless id\textgreater] Mostra todos os logins ativos da entidade especificada.
\end{description}
\item \textbf{Script:}
\begin{description}
\item[\texttt{--}script] Executa um script \lua{} com um lote de comandos.
\item[\texttt{--}undo-script] Desfaz a execução de um script \lua{} com um lote de comandos.
\end{description}
\item \textbf{Relatório:}
\begin{description}
\item[\texttt{--}report] Constrói um relatório sobre o estado atual do barramento.
\end{description}
\end{itemize}
\begin{latexonly}
\codeplacement{!hb}
\inputlisting[language=lua]{openbus.adm}{Exemplo de script para a ferramenta \emph{busadmin}.}
\end{latexonly}
\subsection{Desenvolvedores de Sistemas Integrados}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment