tecgraf.openbus.admin

Interface BusAdmin

All Known Implementing Classes:

BusAdminImpl

public interface BusAdmin

Essa interface representa os comandos básicos utilizados para acessar os serviços do barramento, necessários para sua administração.

Author:

Tecgraf

Method Summary

Modifier and Type	Method and Description
void	addValidator(String validator) Adiciona um validador no barramento.
tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityCategory	createCategory(String categoryID, String categoryName) Cadastra uma nova categoria no barramento.
tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.RegisteredEntity	createEntity(String entityID, String entityName, String categoryID) Cadastra uma nova entidade no barramento.
boolean	createInterface(String interfaceName) Cadastra uma nova interface no barramento.
void	delValidator(String validator) Remove um validador do barramento.
List<String>	getAdmins() Retorna uma lista das entidades administradoras atuais.
Map<tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.RegisteredEntityDesc,List<String>>	getAuthorizations() Retorna um mapa que contém as descrições de todas as entidades registradas no barramento, associadas às suas respectivas autorizações.
List<tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityCategoryDesc>	getCategories() Retorna uma lista que contém descrições de todas as categorias das entidades do barramento.
List<tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.RegisteredEntityDesc>	getEntities() Retorna uma lista que contém descrições de todas as entidades registradas no barramento.
List<String>	getEntitiesWithCertificate() Retorna uma lista que contém IDs de todas as etidades com certificado registrado no barramento.
List<String>	getInterfaces() Retorna uma lista que contém as IDs de todas as interfaces registradas no barramento.
List<tecgraf.openbus.core.v2_0.services.access_control.LoginInfo>	getLogins() Retorna lista que contém as informações de todos os logins ativos no barramento.
short	getLogLevel() Retorna o valor atual da propriedade loglevel do barramento.
int	getMaxChannels() Retorna o valor atual da propriedade maxchannels do barramento.
List<tecgraf.openbus.core.v2_0.services.offer_registry.ServiceOfferDesc>	getOffers() Retorna uma lista que contém todas as descrições de ofertas de serviços do barramento.
short	getOilLogLevel() Retorna o valor atual da propriedade oilloglevel do barramento.
List<String>	getValidators() Retorna uma lista dos validadores atualmente disponíveis no barramento.
void	grantAdminTo(List<String> users) Confere direitos de administração a uma lista de entidades.
void	invalidateLogin(tecgraf.openbus.core.v2_0.services.access_control.LoginInfo loginInfo) Invalida um login ativo no barramento.
boolean	isReconfigurationCapable() Indica se o barramento disponibiliza a interface de reconfiguração dinâmica.
void	registerCertificate(String entityID, byte[] certificate) Registra um certificado no barramento.
void	reloadConfigsFile() Recarrega o arquivo de configurações no barramento.
void	removeCategory(String categoryID) Remove uma categoria do barramento.
void	removeCertificate(String entityID) Remove o certificado vinculado a uma entidade do barramento.
boolean	removeEntity(String entityID) Remove o registro de uma entidade do barramento.
void	removeInterface(String interfaceName) Remove uma interface do barramento.
void	removeOffer(tecgraf.openbus.core.v2_0.services.offer_registry.ServiceOfferDesc desc) Remove uma oferta de serviço.
void	revokeAdminFrom(List<String> users) Revoga direitos de administração de uma lista de entidades.
void	revokeAuthorization(String entityID, String interfaceName) Remove autorização para uma interface de uma entidade.
boolean	setAuthorization(String entityID, String interfaceName) Concede autorização para uma interface a uma entidade.
void	setLogLevel(short loglevel) Configura a propriedade loglevel do barramento.
void	setMaxChannels(int maxchannels) Configura a propriedade maxchannels do barramento.
void	setOilLogLevel(short oilLoglevel) Configura a propriedade oilloglevel do barramento.

Method Detail

getCategories

List<tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityCategoryDesc> getCategories()
                                                                                             throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                                                                                                    TRANSIENT,
                                                                                                    COMM_FAILURE,
                                                                                                    NO_PERMISSION

Retorna uma lista que contém descrições de todas as categorias das entidades do barramento.

Returns:

Lista com as descrições das categorias das entidades.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

TRANSIENT

COMM_FAILURE

NO_PERMISSION

createCategory

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityCategory createCategory(String categoryID,
                                                                                           String categoryName)
                                                                                    throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                                                                                           tecgraf.openbus.core.v2_0.services.UnauthorizedOperation,
                                                                                           tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityCategoryAlreadyExists

Cadastra uma nova categoria no barramento.

Parameters:

categoryID - ID da nova categoria.

categoryName - Nome da nova categoria.

Returns:

Categoria cadastrada.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityCategoryAlreadyExists

removeCategory

void removeCategory(String categoryID)
             throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                    tecgraf.openbus.core.v2_0.services.UnauthorizedOperation,
                    tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityCategoryInUse

Remove uma categoria do barramento.

Parameters:

categoryID - ID da categoria a ser removida.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityCategoryInUse

getEntities

List<tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.RegisteredEntityDesc> getEntities()
                                                                                             throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                                                                                                    TRANSIENT,
                                                                                                    COMM_FAILURE,
                                                                                                    NO_PERMISSION

Retorna uma lista que contém descrições de todas as entidades registradas no barramento.

Returns:

Lista com as descrições de todas as entidades.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

TRANSIENT

COMM_FAILURE

NO_PERMISSION

createEntity

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.RegisteredEntity createEntity(String entityID,
                                                                                           String entityName,
                                                                                           String categoryID)
                                                                                    throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                                                                                           tecgraf.openbus.core.v2_0.services.UnauthorizedOperation,
                                                                                           tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityAlreadyRegistered

Cadastra uma nova entidade no barramento.

Parameters:

entityID - ID da nova entidade.

entityName - Nome da nova entidade.

categoryID - ID de alguma categoria já cadastrada.

Returns:

Entidade cadastrada.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.EntityAlreadyRegistered

removeEntity

boolean removeEntity(String entityID)
              throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                     tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Remove o registro de uma entidade do barramento.

Parameters:

entityID - ID da entidade a ser removida.

Returns:

true caso a entidade foi removida, e false caso contrário.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

getEntitiesWithCertificate

List<String> getEntitiesWithCertificate()
                                 throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                                        tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Retorna uma lista que contém IDs de todas as etidades com certificado registrado no barramento.

Returns:

Lista com as IDs de todas as entidades com certificado registrado.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

registerCertificate

void registerCertificate(String entityID,
                         byte[] certificate)
                  throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                         tecgraf.openbus.core.v2_0.services.UnauthorizedOperation,
                         tecgraf.openbus.core.v2_0.services.access_control.admin.v1_0.InvalidCertificate

Registra um certificado no barramento.

Parameters:

entityID - ID da entidade.

certificate - Certificado.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

tecgraf.openbus.core.v2_0.services.access_control.admin.v1_0.InvalidCertificate

removeCertificate

void removeCertificate(String entityID)
                throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                       tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Remove o certificado vinculado a uma entidade do barramento.

Parameters:

entityID - ID da entidade a ser removida.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

getInterfaces

List<String> getInterfaces()
                    throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                           TRANSIENT,
                           COMM_FAILURE,
                           NO_PERMISSION

Retorna uma lista que contém as IDs de todas as interfaces registradas no barramento.

Returns:

Lista com as IDs de todas as interfaces registradas.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

TRANSIENT

COMM_FAILURE

NO_PERMISSION

createInterface

boolean createInterface(String interfaceName)
                 throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                        tecgraf.openbus.core.v2_0.services.UnauthorizedOperation,
                        tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.InvalidInterface

Cadastra uma nova interface no barramento.

Parameters:

interfaceName - Nome da nova interface.

Returns:

true se a interface cadastrada inexistia no barramento; false em caso contrário.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.InvalidInterface

removeInterface

void removeInterface(String interfaceName)
              throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                     tecgraf.openbus.core.v2_0.services.UnauthorizedOperation,
                     tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.InterfaceInUse

Remove uma interface do barramento.

Parameters:

interfaceName - Nome da interface a ser removida.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.InterfaceInUse

getAuthorizations

Map<tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.RegisteredEntityDesc,List<String>> getAuthorizations()
                                                                                                               throws tecgraf.openbus.core.v2_0.services.ServiceFailure

Retorna um mapa que contém as descrições de todas as entidades registradas no barramento, associadas às suas respectivas autorizações.

Returns:

mapa com par chave-valor: descrição da entidade registrada no barramento e lista de autorizações associadas a essa entidade, respectivamente.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

setAuthorization

boolean setAuthorization(String entityID,
                         String interfaceName)
                  throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                         tecgraf.openbus.core.v2_0.services.UnauthorizedOperation,
                         tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.InvalidInterface

Concede autorização para uma interface a uma entidade.

Parameters:

entityID - ID da entidade a receber autorização.

interfaceName - Interface a ser autorizada.

Returns:

true se a autorização cadastrada inexistia no barramento; false em caso contrário.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.InvalidInterface

revokeAuthorization

void revokeAuthorization(String entityID,
                         String interfaceName)
                  throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                         tecgraf.openbus.core.v2_0.services.UnauthorizedOperation,
                         tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.InvalidInterface,
                         tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.AuthorizationInUse

Remove autorização para uma interface de uma entidade.

Parameters:

entityID - ID da entidade a ter autorização removida.

interfaceName - Interface a ser autorizada.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.InvalidInterface

tecgraf.openbus.core.v2_0.services.offer_registry.admin.v1_0.AuthorizationInUse

getOffers

List<tecgraf.openbus.core.v2_0.services.offer_registry.ServiceOfferDesc> getOffers()
                                                                            throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                                                                                   TRANSIENT,
                                                                                   COMM_FAILURE,
                                                                                   NO_PERMISSION

Retorna uma lista que contém todas as descrições de ofertas de serviços do barramento.

Returns:

Lista de descrições de ofertas de serviços.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

TRANSIENT

COMM_FAILURE

NO_PERMISSION

removeOffer

void removeOffer(tecgraf.openbus.core.v2_0.services.offer_registry.ServiceOfferDesc desc)
          throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                 tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Remove uma oferta de serviço.

Parameters:

desc - Descrição da oferta.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

getLogins

List<tecgraf.openbus.core.v2_0.services.access_control.LoginInfo> getLogins()
                                                                     throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                                                                            tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Retorna lista que contém as informações de todos os logins ativos no barramento.

Returns:

Lista contendo informações de login das entidades.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

invalidateLogin

void invalidateLogin(tecgraf.openbus.core.v2_0.services.access_control.LoginInfo loginInfo)
              throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                     tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Invalida um login ativo no barramento.

Parameters:

loginInfo - Informação de login.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

isReconfigurationCapable

boolean isReconfigurationCapable()

Indica se o barramento disponibiliza a interface de reconfiguração dinâmica.

Returns:

true caso o barramento forneça a interface de reconfiguração dinâmica e false caso contrário.

reloadConfigsFile

void reloadConfigsFile()
                throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                       tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Recarrega o arquivo de configurações no barramento.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

grantAdminTo

void grantAdminTo(List<String> users)
           throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                  tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Confere direitos de administração a uma lista de entidades.

Parameters:

users - Lista de entidades que receberá direitos de administração.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

revokeAdminFrom

void revokeAdminFrom(List<String> users)
              throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                     tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Revoga direitos de administração de uma lista de entidades.

Parameters:

users - Lista de entidades que perderá direitos de administração.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

getAdmins

List<String> getAdmins()
                throws tecgraf.openbus.core.v2_0.services.ServiceFailure

Retorna uma lista das entidades administradoras atuais.

Returns:

Lista contendo os nomes das entidades administradoras.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

addValidator

void addValidator(String validator)
           throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                  tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Adiciona um validador no barramento.

Parameters:

validator - Identificação do validador.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

delValidator

void delValidator(String validator)
           throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                  tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Remove um validador do barramento.

Parameters:

validator - Identificação do validador.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

getValidators

List<String> getValidators()
                    throws tecgraf.openbus.core.v2_0.services.ServiceFailure

Retorna uma lista dos validadores atualmente disponíveis no barramento.

Returns:

Lista contendo as identificações dos validadores.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

setMaxChannels

void setMaxChannels(int maxchannels)
             throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                    tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Configura a propriedade maxchannels do barramento.

Parameters:

maxchannels - Número máximo de canais a serem utilizados.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

getMaxChannels

int getMaxChannels()
            throws tecgraf.openbus.core.v2_0.services.ServiceFailure

Retorna o valor atual da propriedade maxchannels do barramento.

Returns:

Número máximo de canais configurado atualmente.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

setLogLevel

void setLogLevel(short loglevel)
          throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                 tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Configura a propriedade loglevel do barramento.

Parameters:

loglevel - Nível de log do barramento.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

getLogLevel

short getLogLevel()
           throws tecgraf.openbus.core.v2_0.services.ServiceFailure

Retorna o valor atual da propriedade loglevel do barramento.

Returns:

Nível de log do barramento configurado atualmente.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

setOilLogLevel

void setOilLogLevel(short oilLoglevel)
             throws tecgraf.openbus.core.v2_0.services.ServiceFailure,
                    tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

Configura a propriedade oilloglevel do barramento.

Parameters:

oilLoglevel - Nível de log do middleware OiL no barramento.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure

tecgraf.openbus.core.v2_0.services.UnauthorizedOperation

getOilLogLevel

short getOilLogLevel()
              throws tecgraf.openbus.core.v2_0.services.ServiceFailure

Retorna o valor atual da propriedade oilloglevel do barramento.

Returns:

Nível de log do middleware OiL configurado atualmente.

Throws:

tecgraf.openbus.core.v2_0.services.ServiceFailure