kaos.core.csi.registration
Interface DomainRegistration

All Known Subinterfaces:

Registration

All Known Implementing Classes:

RegistrationImpl

public interface DomainRegistration

Defines the operations to register and deregister entities in the specified domain.

Author:

KAoS Team $Revision: 1.5 $

Method Summary

KAoSEntityDescription	deregisterEntityFromDomain(DomainDescription domain, KAoSEntityDescription entityDesc) Deregister the entity described by the given KAoSEntityDescription from the specified domain.
void	deregisterEntityHostingEnv(EntityHostEnvDescription hostEnvDescription) Deregister the entity hosting environment described by the given EntityHostEnvDescription from the KAoS Directory Service.
void	registerDomain(java.lang.String domainName) Register domain with the given name in the KAoS Directory Service.
void	registerEntityHostingEnv(EntityHostEnvDescription eheDescription, boolean guarded, boolean replace) Register the entity hosting environment described by the given EntityHostEnvDescription in the KAoS Directory Service.
KAoSEntityDescription	registerEntityInDomain(DomainDescription domain, KAoSEntityDescription entityDesc) Register the entity described by the given KAoSEntityDescription in the specified domain.

Method Detail

registerDomain

void registerDomain(java.lang.String domainName)
                    throws DirectoryFailure,
                           AlreadyRegisteredException

Register domain with the given name in the KAoS Directory Service.

Parameters:

domainName - String containing the name of domain to register.

Throws:

DirectoryFailure - if the connection to the DS cannot be established.

AlreadyRegisteredException - if the registering domain has been already registered in the DS

registerEntityInDomain

KAoSEntityDescription registerEntityInDomain(DomainDescription domain,
                                             KAoSEntityDescription entityDesc)
                                             throws DirectoryFailure,
                                                    AlreadyRegisteredException

Register the entity described by the given KAoSEntityDescription in the specified domain.

Parameters:

domain - DomainDescription describing the domain, in which to register the given entity.

entityDesc - KAoSEntityDescription describes the entity to be registered in the given domain.

Throws:

DirectoryFailure - if the connection to the DS cannot be established.

AlreadyRegisteredException - if the registering entity has been already registered in the the given domain.

deregisterEntityFromDomain

KAoSEntityDescription deregisterEntityFromDomain(DomainDescription domain,
                                                 KAoSEntityDescription entityDesc)
                                                 throws DirectoryFailure,
                                                        NotRegisteredException

Deregister the entity described by the given KAoSEntityDescription from the specified domain.

Parameters:

domain - DomainDescription describing the domain, from which to deregister the given entity.

entityDesc - KAoSEntityDescription describes the entity to be deregistered from the given domain.

Throws:

DirectoryFailure - if the connection to the DS cannot be established.

NotRegisteredException - if the deregistering entity has not been registered in the the given domain.

registerEntityHostingEnv

void registerEntityHostingEnv(EntityHostEnvDescription eheDescription,
                              boolean guarded,
                              boolean replace)
                              throws DirectoryFailure,
                                     AlreadyRegisteredException,
                                     GuardInstantiationException

Register the entity hosting environment described by the given EntityHostEnvDescription in the KAoS Directory Service.

Parameters:

eheDescription - EntityHostEnvDescription describes the hosting environment for agents and guards.

guarded - boolean indicating the guarded/unguarded status for the environment. If the hosted environemnt is to be guarded, the implementation of this method will instantiate a guard, or check if a guard already exists and proceed with the registration via the guard.

replace - boolean indicating whether to replace existing EntityHostEnvDescription.

Throws:

DirectoryFailure - if the connection to the DS cannot be established.

AlreadyRegisteredException - if the registering hosting environment has been already registered in the DS (if the replace = false and there is already registration for the specified EntityHostEnvDescription).

GuardInstantiationException

deregisterEntityHostingEnv

void deregisterEntityHostingEnv(EntityHostEnvDescription hostEnvDescription)
                                throws DirectoryFailure,
                                       NotRegisteredException

Deregister the entity hosting environment described by the given EntityHostEnvDescription from the KAoS Directory Service.

Parameters:

hostEnvDescription - EntityHostEnvDescription of the entity hosting environment to be deregistered.

Throws:

DirectoryFailure - if the connection to the DS cannot be established.

NotRegisteredException - if the entity to be deregistered has not been registered in the DS.