org.da.protoframework.util

Class ServiceTemplates

java.lang.Object

org.da.protoframework.util.ServiceTemplates

All Implemented Interfaces:

ServiceTemplatesTypes

public class ServiceTemplates
extends java.lang.Object
implements ServiceTemplatesTypes

This class can be used to check to compatibility of a Service with a stored definition for this service.

Field Summary

Fields inherited from interface org.da.protoframework.util.ServiceTemplatesTypes

ANY_DIRECTION, PROVIDER, SERVICE_CONSISTENT, SERVICE_NOT_SAME_TYPE, SERVICE_UNCONSISTENT, SERVICE_UNDEFINED, SUBSCRIBER

Constructor Summary

Constructors

Constructor and Description
ServiceTemplates(Module module, java.net.URL servicesURL, java.net.URL typesURL) Constructor.
ServiceTemplates(Module module, java.net.URL servicesURL, java.net.URL typesURL, boolean isSilent) Constructor.
ServiceTemplates(Module module, java.net.URL applicationURL, java.net.URL servicesURL, java.net.URL typesURL) Constructor.
ServiceTemplates(Module module, java.net.URL applicationURL, java.net.URL servicesURL, java.net.URL typesURL, boolean isSilent) Constructor.

Method Summary

Modifier and Type	Method and Description
short	checkService(ServiceDefinition serviceDef) Check the compatibility of a service with the stored definition.
short	checkService(ServiceInstance<?,?> service) Check the compatibility of a service with the stored definition.
short	checkService(ServiceInstance<?,?> service, boolean isStrict) Check the compatibility of a service with the stored definition.
short	checkService(ServiceInstance<?,?> service, short direction) Check the compatibility of a service with the stored definition.
short	checkService(ServiceInstance<?,?> service, short direction, boolean isStrict) Check the compatibility of a service with the stored definition.
java.util.Map<NamespaceKey,InterfaceDefinition>	getProviderInterfaces() Return the map of the module declared provider interfaces.
java.util.Map<NamespaceKey,ServiceDefinition>	getServices() Return the map of declared services.
java.util.Map<NamespaceKey,InterfaceDefinition>	getSubscriberInterfaces() Return the map of the module declared subscriber interfaces.
boolean	hasDeclaredInterfaces() Return true if the templates has a definition for provider and subscriber interfaces.
boolean	isSilent() Return true if the errors should not be redirected.
boolean	isStrictValidation() Return true if it is allowed to have provided datas in the template which are not found in the definition.
void	logMessages(boolean logMessages) Set if checking messages are to be logged.
void	setSilent(boolean isSilent) Set if the errors should not be redirected.
void	setStrictValidation(boolean isStrict) Set the validation type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceTemplates

public ServiceTemplates(Module module,
                        java.net.URL servicesURL,
                        java.net.URL typesURL)

Constructor.

Parameters:

module - the module

servicesURL - the reference services URL

typesURL - the reference types URL

ServiceTemplates

public ServiceTemplates(Module module,
                        java.net.URL applicationURL,
                        java.net.URL servicesURL,
                        java.net.URL typesURL)

Constructor.

Parameters:

module - the module

applicationURL - the application URL

servicesURL - the services URL

typesURL - the types URL

ServiceTemplates

public ServiceTemplates(Module module,
                        java.net.URL servicesURL,
                        java.net.URL typesURL,
                        boolean isSilent)

Constructor.

Parameters:

module - the module

servicesURL - the services URL

typesURL - the types URL

isSilent - true if the errors should not be redirected

ServiceTemplates

public ServiceTemplates(Module module,
                        java.net.URL applicationURL,
                        java.net.URL servicesURL,
                        java.net.URL typesURL,
                        boolean isSilent)

Constructor.

Parameters:

module - the module

applicationURL - the application URL

servicesURL - the services URL

typesURL - the types URL

isSilent - true if the errors should not be redirected

Method Detail

setSilent

public void setSilent(boolean isSilent)

Set if the errors should not be redirected.

Parameters:

isSilent - true if the errors should not be redirected

isSilent

public boolean isSilent()

Return true if the errors should not be redirected.

Returns:

true if the errors should not be redirected

setStrictValidation

public void setStrictValidation(boolean isStrict)

Set the validation type.

Parameters:

isStrict - true if it is allowed to have provided datas in the template which are not found in the definition

isStrictValidation

public boolean isStrictValidation()

Return true if it is allowed to have provided datas in the template which are not found in the definition.

Returns:

true if it is allowed to have provided datas in the template which are not found in the definition

logMessages

public void logMessages(boolean logMessages)

Set if checking messages are to be logged.

Parameters:

logMessages - true if checking messages are to be logged

getServices

public java.util.Map<NamespaceKey,ServiceDefinition> getServices()

Return the map of declared services.

Returns:

the map of declared services

hasDeclaredInterfaces

public boolean hasDeclaredInterfaces()

Return true if the templates has a definition for provider and subscriber interfaces. This will only be the case if an application definition has been provided to the templates constructor.

Returns:

true if the templates has a definition for provider and subscriber interfaces

getProviderInterfaces

public java.util.Map<NamespaceKey,InterfaceDefinition> getProviderInterfaces()

Return the map of the module declared provider interfaces. It will be null if the applications file is not specified.

Returns:

the map of the module declared provider interfaces

getSubscriberInterfaces

public java.util.Map<NamespaceKey,InterfaceDefinition> getSubscriberInterfaces()

Return the map of the module declared subscriber interfaces. It will be null if the applications file is not specified.

Returns:

the map of the module declared subscriber interfaces

checkService

public short checkService(ServiceDefinition serviceDef)

Check the compatibility of a service with the stored definition. The possible values are:

• ServiceTemplatesTypes.SERVICE_CONSISTENT: the service exist in the stored definition and has the same definition (datas and their types)
• ServiceTemplatesTypes.SERVICE_UNDEFINED: the service does not exist in the stored definition
• ServiceTemplatesTypes.SERVICE_UNCONSISTENT: the service exist in the stored definition but has not the same definition (datas and their types)

Parameters:

serviceDef - the Service Definition

Returns:

the compatibility of the service with the stored definition

checkService

public short checkService(ServiceInstance<?,?> service,
                          boolean isStrict)

Check the compatibility of a service with the stored definition. The possible values are:

• ServiceTemplatesTypes.SERVICE_CONSISTENT: the service exist in the stored definition and has the same definition (datas and their types)
• ServiceTemplatesTypes.SERVICE_UNDEFINED: the service does not exist in the stored definition
• ServiceTemplatesTypes.SERVICE_UNCONSISTENT: the service exist in the stored definition but has not the same definition (datas and their types)

Parameters:

service - the service

isStrict - true if it is allowed to have provided datas in the template which are not found in the definition

Returns:

the compatibility of the service with the stored definition

checkService

public short checkService(ServiceInstance<?,?> service,
                          short direction,
                          boolean isStrict)

Check the compatibility of a service with the stored definition. The possible values are:

• ServiceTemplatesTypes.SERVICE_CONSISTENT: the service exist in the stored definition and has the same definition (datas and their types)
• ServiceTemplatesTypes.SERVICE_UNDEFINED: the service does not exist in the stored definition
• ServiceTemplatesTypes.SERVICE_UNCONSISTENT: the service exist in the stored definition but has not the same definition (datas and their types)

Parameters:

service - the service

direction - the service direction

isStrict - true if it is allowed to have provided datas in the template which are not found in the definition

Returns:

the compatibility of the service with the stored definition

checkService

public short checkService(ServiceInstance<?,?> service,
                          short direction)

Check the compatibility of a service with the stored definition. The possible values are:

• ServiceTemplatesTypes.SERVICE_CONSISTENT: the service exist in the stored definition and has the same definition (datas and their types)
• ServiceTemplatesTypes.SERVICE_UNDEFINED: the service does not exist in the stored definition
• ServiceTemplatesTypes.SERVICE_UNCONSISTENT: the service exist in the stored definition but has not the same definition (datas and their types)

Parameters:

service - the service

direction - the service direction

Returns:

the compatibility of the service with the stored definition

checkService

public short checkService(ServiceInstance<?,?> service)

Check the compatibility of a service with the stored definition. The possible values are:

• ServiceTemplatesTypes.SERVICE_CONSISTENT: the service exist in the stored definition and has the same definition (datas and their types)
• ServiceTemplatesTypes.SERVICE_UNDEFINED: the service does not exist in the stored definition
• ServiceTemplatesTypes.SERVICE_UNCONSISTENT: the service exist in the stored definition but has not the same definition (datas and their types)

Parameters:

service - the service

Returns:

the compatibility of the service with the stored definition