pt.digitalis.dif.dem.managers
Interface IRegistrationManager

All Known Implementing Classes:

RegistrationManagerImpl

public interface IRegistrationManager

This interface manages the DEM entities registration process.

Author:

Pedro Viegas pviegas@digitalis.pt

Created on:

Oct 3, 2007

Method Summary

void	addToRegistry(Entity type, String entityID, String name, boolean registrable) Adds a new record to the registry.
LicenseEditionType	getApplicationEdition(String applicationID) Inspects the Application Edition
LicenseEditionType	getProviderEdition(String providerID) Inspects the Provider Edition
LicenseEditionType	getServiceEdition(String serviceID) Inspects the Service Edition
String	getStageClientName(IStage stageID) Inspects the Stage Client Name
LicenseEditionType	getStageEdition(String stageID) Inspects the Stage Edition
boolean	isApplicationRegistered(String applicationID) Inspects the registration state of a given application
boolean	isApplicationRegistrable(String applicationID) Inspects the registration possibility of a given application
boolean	isProviderRegistered(String providerID) Inspects the registration state of a given provider
boolean	isProviderRegistrable(String providerID) Inspects the registration possibility of a given provider
boolean	isServiceRegistered(String serviceID) Inspects the registration state of a given service
boolean	isServiceRegistrable(String serviceID) Inspects the registration possibility of a given service
boolean	isStageRegistered(String stageId) Inspects the registration state of a given stage
boolean	isStageRegistrable(String stageId) Inspects the registration possibility of a given stage
boolean	registerApplication(String applicationID, String name, String key) Registers a given application if it's not already registered.
boolean	registerProvider(String providerID, String name, String key) Registers a given provider if it's not already registered.
boolean	registerService(String serviceID, String name, String key) Registers a given service if it's not already registered.
boolean	registerStage(String stageId, String name, String key) Registers a given stage if it's not already registered.
void	unregisterApplication(String applicationID) Unregisters a given application if it's registered.
void	unregisterProvider(String providerID) Unregisters a given provider if it's registered.
void	unregisterService(String serviceID) Unregisters a given service if it's registered.
void	unregisterStage(String stageId) Unregisters a given stage if it's registered.

Method Detail

addToRegistry

void addToRegistry(Entity type,
                   String entityID,
                   String name,
                   boolean registrable)

Adds a new record to the registry. User registrations will be automatically picked up by the Registry

Parameters:

type - the Entity type

entityID - the entity ID

name - the name to register to (null if not registered by default)

registrable - if the Entity is registrable

getApplicationEdition

LicenseEditionType getApplicationEdition(String applicationID)

Inspects the Application Edition

Parameters:

applicationID - the application ID

Returns:

LicenseEditionType

getProviderEdition

LicenseEditionType getProviderEdition(String providerID)

Inspects the Provider Edition

Parameters:

providerID - the provider ID

Returns:

LicenseEditionType

getServiceEdition

LicenseEditionType getServiceEdition(String serviceID)

Inspects the Service Edition

Parameters:

serviceID - the service ID

Returns:

LicenseEditionType

getStageClientName

String getStageClientName(IStage stageID)

Inspects the Stage Client Name

Parameters:

stageID - the stage ID

Returns:

the stage client name

getStageEdition

LicenseEditionType getStageEdition(String stageID)

Inspects the Stage Edition

Parameters:

stageID - the stage ID

Returns:

LicenseEditionType

isApplicationRegistered

boolean isApplicationRegistered(String applicationID)

Inspects the registration state of a given application

Parameters:

applicationID - the provider ID

Returns:

T if the application is registered, F otherwise

isApplicationRegistrable

boolean isApplicationRegistrable(String applicationID)

Inspects the registration possibility of a given application

Parameters:

applicationID - the provider ID

Returns:

T if the application is registrable, F otherwise

isProviderRegistered

boolean isProviderRegistered(String providerID)

Inspects the registration state of a given provider

Parameters:

providerID - the provider ID

Returns:

T if the provider is registered, F otherwise

isProviderRegistrable

boolean isProviderRegistrable(String providerID)

Inspects the registration possibility of a given provider

Parameters:

providerID - the provider ID

Returns:

T if the provider is registrable, F otherwise

isServiceRegistered

boolean isServiceRegistered(String serviceID)

Inspects the registration state of a given service

Parameters:

serviceID - the service ID

Returns:

T if the service is registered, F otherwise

isServiceRegistrable

boolean isServiceRegistrable(String serviceID)

Inspects the registration possibility of a given service

Parameters:

serviceID - the service ID

Returns:

T if the service is registrable, F otherwise

isStageRegistered

boolean isStageRegistered(String stageId)

Inspects the registration state of a given stage

Parameters:

stageId - the stage ID

Returns:

T if the stage is registered, F otherwise

isStageRegistrable

boolean isStageRegistrable(String stageId)

Inspects the registration possibility of a given stage

Parameters:

stageId - the stage ID

Returns:

T if the stage is registrable, F otherwise

registerApplication

boolean registerApplication(String applicationID,
                            String name,
                            String key)
                            throws RegistrationManagerException

Registers a given application if it's not already registered.

Parameters:

applicationID - the application ID

name - the name to register to

key - the key to register

Returns:

T if the registration was successful

Throws:

RegistrationManagerException - if a error occurrs in registration manager

registerProvider

boolean registerProvider(String providerID,
                         String name,
                         String key)
                         throws RegistrationManagerException

Registers a given provider if it's not already registered.

Parameters:

providerID - the provider ID

name - the name to register to

key - the key to register

Returns:

T if the registration was successful

Throws:

RegistrationManagerException - if a error occurrs in registration manager

registerService

boolean registerService(String serviceID,
                        String name,
                        String key)
                        throws RegistrationManagerException

Registers a given service if it's not already registered.

Parameters:

serviceID - the service ID

name - the name to register to

key - the key to register

Returns:

T if the registration was successful

Throws:

RegistrationManagerException - if a error occurrs in registration manager

registerStage

boolean registerStage(String stageId,
                      String name,
                      String key)
                      throws RegistrationManagerException

Registers a given stage if it's not already registered.

Parameters:

stageId - the stage ID

name - the name to register to

key - the key to register

Returns:

T if the registration was successful

Throws:

RegistrationManagerException - if a error occurrs in registration manager

unregisterApplication

void unregisterApplication(String applicationID)

Unregisters a given application if it's registered.

Parameters:

applicationID - the application ID

unregisterProvider

void unregisterProvider(String providerID)

Unregisters a given provider if it's registered.

Parameters:

providerID - the provider ID

unregisterService

void unregisterService(String serviceID)

Unregisters a given service if it's registered.

Parameters:

serviceID - the service ID

unregisterStage

void unregisterStage(String stageId)

Unregisters a given stage if it's registered.

Parameters:

stageId - the stage ID